Part1前言
本篇主要要介紹的就是 controller 層的處理，一個完整的后端請求由4部分組成：
接口地址(也就是URL地址)
請求方式(一般就是get、set，當(dāng)然還有put、delete)
請求數(shù)據(jù)(request，有head跟body)
響應(yīng)數(shù)據(jù)(response)
本篇將解決以下3個問題：
當(dāng)接收到請求時，如何優(yōu)雅的校驗參數(shù)
返回響應(yīng)數(shù)據(jù)該如何統(tǒng)一的進(jìn)行處理
接收到請求，處理業(yè)務(wù)邏輯時拋出了異常又該如何處理
Part2Controller層參數(shù)接收（太基礎(chǔ)了，可以跳過）
常見的請求就分為 get 跟 post 2種
@RestController @RequestMapping("/product/product-info") publicclassProductInfoController{ @Autowired ProductInfoServiceproductInfoService; @GetMapping("/findById") publicProductInfoQueryVofindById(Integerid){ ... } @PostMapping("/page") publicIPagefindPage(Pagepage,ProductInfoQueryVovo){ ... } }
@RestController：@RestController = @Controller + @ResponseBody。加上這個注解，springboot就會吧這個類當(dāng)成 controller 進(jìn)行處理，然后把所有返回的參數(shù)放到 ResponseBody 中
@RequestMapping：請求的前綴，也就是所有該 Controller 下的請求都需要加上 /product/product-info 的前綴
@GetMapping("/findById")：標(biāo)志這是一個 get 請求，并且需要通過 /findById 地址才可以訪問到
@PostMapping("/page")：同理，表示是個 post 請求
參數(shù)：至于參數(shù)部分，只需要寫上 ProductInfoQueryVo，前端過來的 json 請求便會通過映射賦值到對應(yīng)的對象中，例如請求這么寫，productId 就會自動被映射到 vo 對應(yīng)的屬性當(dāng)中
size:1 current:1 productId:1 productName:泡腳
Part3統(tǒng)一狀態(tài)碼
1. 返回格式
為了跟 前端妹妹 打好關(guān)系，我們通常需要對后端返回的數(shù)據(jù)進(jìn)行包裝一下，增加一下 狀態(tài)碼，狀態(tài)信息，這樣前端妹妹接收到數(shù)據(jù)就可以根據(jù)不同的 狀態(tài)碼，判斷 響應(yīng)數(shù)據(jù)狀態(tài)，是否成功是否異常進(jìn)行不同的顯示。當(dāng)然這讓你擁有了更多跟前端妹妹的交流機(jī)會，假設(shè)我們約定了 1000 就是成功的意思如果你不封裝，那么返回的數(shù)據(jù)是這樣子的
歡迎關(guān)注公眾號"Java學(xué)習(xí)之道"，查看更多干貨！
{
"productId":1,
"productName":"泡腳",
"productPrice":100.00,
"productDescription":"中藥泡腳加按摩",
"productStatus":0,
}
經(jīng)過封裝以后時這樣子的
{
"code":1000,
"msg":"請求成功",
"data":{
"productId":1,
"productName":"泡腳",
"productPrice":100.00,
"productDescription":"中藥泡腳加按摩",
"productStatus":0,
}
}
2. 封裝ResultVo
這些狀態(tài)碼肯定都是要預(yù)先編好的，怎么編呢？寫個常量 1000？還是直接寫死 1000？要這么寫就真的書白讀的了，寫 狀態(tài)碼 當(dāng)然是用枚舉拉
首先先定義一個 狀態(tài)碼 的接口，所有 狀態(tài)碼 都需要實現(xiàn)它，有了標(biāo)準(zhǔn)才好做事
publicinterfaceStatusCode{
publicintgetCode();
publicStringgetMsg();
}
然后去找前端妹妹，跟他約定好狀態(tài)碼（這可能是你們唯一的約定了）枚舉類嘛，當(dāng)然不能有 setter 方法了，因此我們不能在用 @Data 注解了，我們要用 @Getter
@Getter publicenumResultCodeimplementsStatusCode{ SUCCESS(1000,"請求成功"), FAILED(1001,"請求失敗"), VALIDATE_ERROR(1002,"參數(shù)校驗失敗"), RESPONSE_PACK_ERROR(1003,"response返回包裝失敗"); privateintcode; privateStringmsg; ResultCode(intcode,Stringmsg){ this.code=code; this.msg=msg; } }
寫好枚舉類，就開始寫 ResultVo 包裝類了，我們預(yù)設(shè)了幾種默認(rèn)的方法，比如成功的話就默認(rèn)傳入 object 就可以了，我們自動包裝成 success
@Data
publicclassResultVo{
//狀態(tài)碼
privateintcode;
//狀態(tài)信息
privateStringmsg;
//返回對象
privateObjectdata;
//手動設(shè)置返回vo
publicResultVo(intcode,Stringmsg,Objectdata){
this.code=code;
this.msg=msg;
this.data=data;
}
//默認(rèn)返回成功狀態(tài)碼，數(shù)據(jù)對象
publicResultVo(Objectdata){
this.code=ResultCode.SUCCESS.getCode();
this.msg=ResultCode.SUCCESS.getMsg();
this.data=data;
}
//返回指定狀態(tài)碼，數(shù)據(jù)對象
publicResultVo(StatusCodestatusCode,Objectdata){
this.code=statusCode.getCode();
this.msg=statusCode.getMsg();
this.data=data;
}
//只返回狀態(tài)碼
publicResultVo(StatusCodestatusCode){
this.code=statusCode.getCode();
this.msg=statusCode.getMsg();
this.data=null;
}
}
使用，現(xiàn)在的返回肯定就不是 return data; 這么簡單了，而是需要 new ResultVo(data);
@PostMapping("/findByVo")
publicResultVofindByVo(@ValidatedProductInfoVovo){
ProductInfoproductInfo=newProductInfo();
BeanUtils.copyProperties(vo,productInfo);
returnnewResultVo(productInfoService.getOne(newQueryWrapper(productInfo)));
}
最后返回就會是上面帶了狀態(tài)碼的數(shù)據(jù)了
Part4統(tǒng)一校驗
1. 原始做法
假設(shè)有一個添加 ProductInfo 的接口，在沒有統(tǒng)一校驗時，我們需要這么做
@Data
publicclassProductInfoVo{
//商品名稱
privateStringproductName;
//商品價格
privateBigDecimalproductPrice;
//上架狀態(tài)
privateIntegerproductStatus;
}
@PostMapping("/findByVo")
publicProductInfofindByVo(ProductInfoVovo){
if(StringUtils.isNotBlank(vo.getProductName())){
thrownewAPIException("商品名稱不能為空");
}
if(null!=vo.getProductPrice()&&vo.getProductPrice().compareTo(newBigDecimal(0))
這if寫的人都傻了，能忍嗎？肯定不能忍啊
歡迎關(guān)注公眾號"Java學(xué)習(xí)之道"，查看更多干貨！
2. @Validated參數(shù)校驗
好在有 @Validated，又是一個校驗參數(shù)必備良藥了。有了 @Validated 我們只需要再 vo 上面加一點小小的注解，便可以完成校驗功能
@Data
publicclassProductInfoVo{
@NotNull(message="商品名稱不允許為空")
privateStringproductName;
@Min(value=0,message="商品價格不允許為負(fù)數(shù)")
privateBigDecimalproductPrice;
privateIntegerproductStatus;
}
@PostMapping("/findByVo")
publicProductInfofindByVo(@ValidatedProductInfoVovo){
ProductInfoproductInfo=newProductInfo();
BeanUtils.copyProperties(vo,productInfo);
returnnewResultVo(productInfoService.getOne(newQueryWrapper(productInfo)));
}
運行看看，如果參數(shù)不對會發(fā)生什么？我們故意傳一個價格為 -1 的參數(shù)過去
productName:泡腳
productPrice:-1
productStatus:1
{
"timestamp":"2020-04-19T0337.268+0000",
"status":400,
"error":"BadRequest",
"errors":[
{
"codes":[
"Min.productInfoVo.productPrice",
"Min.productPrice",
"Min.java.math.BigDecimal",
"Min"
],
"arguments":[
{
"codes":[
"productInfoVo.productPrice",
"productPrice"
],
"defaultMessage":"productPrice",
"code":"productPrice"
},
0
],
"defaultMessage":"商品價格不允許為負(fù)數(shù)",
"objectName":"productInfoVo",
"field":"productPrice",
"rejectedValue":-1,
"bindingFailure":false,
"code":"Min"
}
],
"message":"Validationfailedforobjectu003du0027productInfoVou0027.Errorcount:1",
"trace":"org.springframework.validation.BindException:org.springframework.validation.BeanPropertyBindingResult:1errors
Fielderrorinobjectu0027productInfoVou0027onfieldu0027productPriceu0027:rejectedvalue[-1];codes[Min.productInfoVo.productPrice,Min.productPrice,Min.java.math.BigDecimal,Min];arguments[org.springframework.context.support.DefaultMessageSourceResolvable:codes[productInfoVo.productPrice,productPrice];arguments[];defaultmessage[productPrice],0];defaultmessage[商品價格不允許為負(fù)數(shù)]
atorg.springframework.web.method.annotation.ModelAttributeMethodProcessor.resolveArgument(ModelAttributeMethodProcessor.java:164)
atorg.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:121)
atorg.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:167)
atorg.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:134)
atorg.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:105)
atorg.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:879)
atorg.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:793)
atorg.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)
atorg.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1040)
atorg.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:943)
atorg.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)
atorg.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:909)
atjavax.servlet.http.HttpServlet.service(HttpServlet.java:660)
atorg.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)
atjavax.servlet.http.HttpServlet.service(HttpServlet.java:741)
atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:231)
atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
atorg.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)
atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
atcom.alibaba.druid.support.http.WebStatFilter.doFilter(WebStatFilter.java:124)
atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
atorg.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)
atorg.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
atorg.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)
atorg.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
atorg.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)
atorg.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
atorg.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:202)
atorg.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:96)
atorg.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:541)
atorg.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:139)
atorg.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)
atorg.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:74)
atorg.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:343)
atorg.apache.coyote.http11.Http11Processor.service(Http11Processor.java:373)
atorg.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)
atorg.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:868)
atorg.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1594)
atorg.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
atjava.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
atjava.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
atorg.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
atjava.base/java.lang.Thread.run(Thread.java:830)
",
"path":"/leilema/product/product-info/findByVo"
}
大功告成了嗎？雖然成功校驗了參數(shù)，也返回了異常，并且?guī)?"商品價格不允許為負(fù)數(shù)" 的信息。但是你要是這樣返回給前端，前端妹妹就提刀過來了，當(dāng)年約定好的 狀態(tài)碼，你個 負(fù)心人 說忘就忘？用戶 體驗小于等于0 ??！所以我們要進(jìn)行優(yōu)化一下，每次出現(xiàn)異常的時候，自動把 狀態(tài)碼 寫好，不負(fù)妹妹之約！
歡迎關(guān)注公眾號"Java學(xué)習(xí)之道"，查看更多干貨！
3. 優(yōu)化異常處理
首先我們先看看校驗參數(shù)拋出了什么異常
Resolved[org.springframework.validation.BindException:org.springframework.validation.BeanPropertyBindingResult:1errors
我們看到代碼拋出了 org.springframework.validation.BindException 的綁定異常，因此我們的思路就是 AOP 攔截所有 controller，然后異常的時候統(tǒng)一攔截起來，進(jìn)行封裝！完美！玩你個頭啊完美，這么呆瓜的操作 springboot 不知道嗎？ spring mvc 當(dāng)然知道拉，所以給我們提供了一個 @RestControllerAdvice 來增強所有 @RestController，然后使用 @ExceptionHandler 注解，就可以攔截到對應(yīng)的異常。
這里我們就攔截 BindException.class 就好了。最后在返回之前，我們對異常信息進(jìn)行包裝一下，包裝成 ResultVo，當(dāng)然要跟上 ResultCode.VALIDATE_ERROR 的異常狀態(tài)碼。這樣前端妹妹看到 VALIDATE_ERROR 的狀態(tài)碼，就會調(diào)用數(shù)據(jù)校驗異常的彈窗提示用戶哪里沒填好
@RestControllerAdvice
publicclassControllerExceptionAdvice{
@ExceptionHandler({BindException.class})
publicResultVoMethodArgumentNotValidExceptionHandler(BindExceptione){
//從異常對象中拿到ObjectError對象
ObjectErrorobjectError=e.getBindingResult().getAllErrors().get(0);
returnnewResultVo(ResultCode.VALIDATE_ERROR,objectError.getDefaultMessage());
}
}
來康康效果，完美。1002 與前端妹妹約定好的狀態(tài)碼
{
"code":1002,
"msg":"參數(shù)校驗失敗",
"data":"商品價格不允許為負(fù)數(shù)"
}
Part5統(tǒng)一響應(yīng)
1. 統(tǒng)一包裝響應(yīng)
再回頭看一下 controller 層的返回
returnnewResultVo(productInfoService.getOne(newQueryWrapper(productInfo)));
開發(fā)小哥肯定不樂意了，誰有空天天寫 new ResultVo(data) 啊，我就想返回一個實體！怎么實現(xiàn)我不管！好把，那就是 AOP 攔截所有 Controller，再 @After 的時候統(tǒng)一幫你封裝一下咯怕是上一次臉打的不夠疼，springboot能不知道這么個操作嗎？
@RestControllerAdvice(basePackages={"com.bugpool.leilema"})
publicclassControllerResponseAdviceimplementsResponseBodyAdvice