一杨帽、本課程目標(biāo):
- 弄清楚為什么要對springboot,所有Controller的response做統(tǒng)一格式封裝仇让?
- 學(xué)會(huì)用ResponseBodyAdvice接口 和 @ControllerAdvice注解
二氨肌、為什么要對response統(tǒng)一格式封裝?
我們先來看下痹扇,springboot默認(rèn)情況下的response是什么格式的
第一種格式:response為String
@GetMapping(value="/getStr")
public String getStr( ){
return "test";
}
以上springboot的返回值為
test
第二種格式:response為Objct
@GetMapping(value="/getObject")
public UserVO getObject( ){
UserVO vo=new UserVO();
vo.setUsername("agan");
return vo;
}
以上springboot的返回值為
{
"id": null,
"username": "agan",
"password": null,
"email": null,
"phone": null,
"idCard": null,
"sex": null,
"deleted": null,
"updateTime": null,
"createTime": null
}
第三種格式:response為void
@GetMapping(value="/empty")
public void empty( ){
}
以上springboot的返回值為空
第四種格式:response為異常
@GetMapping(value="/error")
public void error( ){
int i=9/0;
}
以上springboot的返回值為空
{
"timestamp": "2019-09-07T10:35:56.658+0000",
"status": 500,
"error": "Internal Server Error",
"message": "/ by zero",
"path": "/user/error"
}
以上4種情況斑鸦,如果你和前端(app刻帚、h5)開發(fā)人員聯(lián)調(diào)接口勺择,他們會(huì)很懵逼创南,因?yàn)闆]有一個(gè)統(tǒng)一response的標(biāo)準(zhǔn),前端開發(fā)人員不知道怎么處理返回值。
故省核,我們應(yīng)該統(tǒng)一response的標(biāo)準(zhǔn)格式稿辙。
三、定義response的標(biāo)準(zhǔn)格式
一般的response的標(biāo)準(zhǔn)格式包含3部分:
1.status狀態(tài)值:代表本次請求response的狀態(tài)結(jié)果气忠。
2.response描述:對本次狀態(tài)碼的描述邻储。
3.data數(shù)據(jù):本次返回的數(shù)據(jù)。
{
"status":0,
"desc":"成功",
"data":"test"
}
四旧噪、初級(jí)程序員對response代碼封裝
對response的統(tǒng)一封裝吨娜,是由一定的技術(shù)含量的,我們先來看下淘钟,初級(jí)程序員的封裝宦赠,網(wǎng)上很多教程都是這么寫的。
步驟1:把標(biāo)準(zhǔn)格式轉(zhuǎn)換為代碼
{
"status":0,
"desc":"成功",
"data":"test"
}
把以上的標(biāo)準(zhǔn)json格式轉(zhuǎn)換為ResResult代碼米母。
@AllArgsConstructor
@NoArgsConstructor
@Data
public class ResResult<T> {
/**
* 1.status狀態(tài)值:代表本次請求response的狀態(tài)結(jié)果勾扭。
*/
private Integer status;
/**
* 2.response描述:對本次狀態(tài)碼的描述。
*/
private String desc;
/**
* 3.data數(shù)據(jù):本次返回的數(shù)據(jù)铁瞒。
*/
private T data;
/**
* 成功妙色,創(chuàng)建ResResult:沒data數(shù)據(jù)
*/
public static ResResult suc() {
ResResult result = new ResResult();
result.setResultCode(ResultCode.SUCCESS);
return result;
}
/**
* 成功,創(chuàng)建ResResult:有data數(shù)據(jù)
*/
public static ResResult suc(Object data) {
ResResult result = new ResResult();
result.setResultCode(ResultCode.SUCCESS);
result.setData(data);
return result;
}
/**
* 失敗精拟,指定status燎斩、desc
*/
public static ResResult fail(Integer status, String desc) {
ResResult result = new ResResult();
result.setStatus(status);
result.setDesc(desc);
return result;
}
/**
* 失敗,指定ResultCode枚舉
*/
public static ResResult fail(ResultCode resultCode) {
ResResult result = new ResResult();
result.setResultCode(resultCode);
return result;
}
/**
* 把ResultCode枚舉轉(zhuǎn)換為ResResult
*/
private void setResultCode(ResultCode code) {
this.status = code.code();
this.desc = code.message();
}
}
步驟2:把狀態(tài)碼存在枚舉類中
public enum ResultCode {
/* 成功狀態(tài)碼 */
SUCCESS(0, "成功"),
/* 系統(tǒng)500錯(cuò)誤*/
SYSTEM_ERROR(10000, "系統(tǒng)異常蜂绎,請稍后重試"),
/* 參數(shù)錯(cuò)誤:10001-19999 */
PARAM_IS_INVALID(10001, "參數(shù)無效"),
/* 用戶錯(cuò)誤:20001-29999*/
USER_HAS_EXISTED(20001, "用戶已存在");
private Integer code;
private String message;
ResultCode(Integer code, String message) {
this.code = code;
this.message = message;
}
public Integer code() {
return this.code;
}
public String message() {
return this.message;
}
public static String getMessage(String name) {
for (ResultCode item : ResultCode.values()) {
if (item.name().equals(name)) {
return item.message;
}
}
return name;
}
public static Integer getCode(String name) {
for (ResultCode item : ResultCode.values()) {
if (item.name().equals(name)) {
return item.code;
}
}
return null;
}
@Override
public String toString() {
return this.name();
}
}
步驟3:給getResult()方法指定ResResult返回值
@RestController
@RequestMapping("/user")
public class UserController {
@GetMapping(value="/getResult")
public ResResult getResult( ){
return ResResult.suc("test");
}
}
在瀏覽器輸入 http://127.0.0.1:9090/user/getResult 等到以下結(jié)果
{
"status":0,
"desc":"成功",
"data":"test"
}
看到這里栅表,應(yīng)該有很多同學(xué)知道這樣封裝代碼有很大的弊端。
因?yàn)榻窈竽銓懙拿總€(gè)接口师枣,都要手工指定ResResult返回值怪瓶,如果你在公司推廣你的這種編碼規(guī)范,會(huì)被人家吐槽和鄙視践美。
五洗贰、高級(jí)程序員對response代碼封裝
如果你在公司推廣你的編碼規(guī)范找岖,為了避免被公司其他程序員吐槽和鄙視,我們必須優(yōu)化代碼敛滋。
優(yōu)化的目標(biāo):不要每個(gè)接口都手工指定ResResult返回值许布。
步驟1:采用ResponseBodyAdvice技術(shù)來實(shí)現(xiàn)response的統(tǒng)一格式
springboot提供了ResponseBodyAdvice來幫我們處理
ResponseBodyAdvice的作用:攔截Controller方法的返回值,統(tǒng)一處理返回值/響應(yīng)體绎晃,一般用來做response的統(tǒng)一格式蜜唾、加解密、簽名等等庶艾。
先看下ResponseBodyAdvice這個(gè)接口的源碼袁余。
public interface ResponseBodyAdvice<T> {
/**
是否支持advice功能
treu=支持,false=不支持
**/
boolean supports(MethodParameter var1, Class<? extends HttpMessageConverter<?>> var2);
/** 處理response的具體業(yè)務(wù)方法 */
@Nullable
T beforeBodyWrite(@Nullable T var1, MethodParameter var2, MediaType var3, Class<? extends HttpMessageConverter<?>> var4, ServerHttpRequest var5, ServerHttpResponse var6);
}
步驟2:寫一個(gè)ResponseBodyAdvice的實(shí)現(xiàn)類
@ControllerAdvice(basePackages = "com.agan.boot")
public class ResponseHandler implements ResponseBodyAdvice<Object> {
/**
* 是否支持advice功能
* treu=支持咱揍,false=不支持
*/
@Override
public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
return true;
}
/**
*
* 處理response的具體業(yè)務(wù)方法
*/
@Override
public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
if (o instanceof String) {
return JsonUtil.object2Json(ResResult.suc(o));
}
return ResResult.suc(o);
}
}
以上代碼颖榜,有2個(gè)地方需要重點(diǎn)講解:
第1個(gè)地方:@ControllerAdvice 注解:
@ControllerAdvice這是一個(gè)非常有用的注解,它的作用是增強(qiáng)Controller的擴(kuò)展功能類煤裙。
那@ControllerAdvice對Controller增強(qiáng)了哪些擴(kuò)展功能呢掩完?主要體現(xiàn)在2方面:
- 對Controller全局?jǐn)?shù)據(jù)統(tǒng)一處理,例如积暖,我們這節(jié)課就是對response統(tǒng)一封裝藤为。
- 對Controller全局異常統(tǒng)一處理,這個(gè)后面的課程會(huì)詳細(xì)講解夺刑。
在使用@ControllerAdvice時(shí)缅疟,還要特別注意,加上basePackages,
@ControllerAdvice(basePackages = "com.agan.boot"),因?yàn)槿绻患拥脑挶樵福墒菍φ麄€(gè)系統(tǒng)的Controller做了擴(kuò)展功能存淫,
它會(huì)對某些特殊功能產(chǎn)生沖突,例如 不加的話沼填,在使用swagger時(shí)會(huì)出現(xiàn)空白頁異常桅咆。
第2個(gè)地方:beforeBodyWrite方法體的response類型判斷
if (o instanceof String) {
return JsonUtil.object2Json(ResResult.suc(o));
}
以上代碼一定要加,因?yàn)镃ontroller的返回值為String的時(shí)候坞笙,它是直接返回String,不是json岩饼,
故我們要手工做下json轉(zhuǎn)換處理
六:課后練習(xí)題
本節(jié)課,我們沒有對Controller的異常做處理薛夜,是會(huì)出問題的籍茧。
在本節(jié)課的基礎(chǔ)上執(zhí)行以下代碼:
@GetMapping(value="/error")
public void error(){
int i=9/0;
}
自己體驗(yàn)下,會(huì)出什么問題梯澜? 然后思考怎么解決寞冯?
配套學(xué)習(xí)資料
- 課后練習(xí)作業(yè)請?zhí)峤坏絈Q群(1號(hào)QQ群3000人已滿,請加2號(hào)群:985378659[群名:SpringBoot架構(gòu)師])
- 本課程配套免費(fèi)視頻教程
https://study.163.com/course/introduction/1004576013.htm?share=1&shareId=1016481220 - 本課程配套源碼地址:https://github.com/agan-java/agan-boot