如何把Controller層代碼寫(xiě)的更優(yōu)雅？
Part1前言
本篇主要要介紹的就是 controller 層的處理，一個(gè)完整的后端請(qǐng)求由4部分組成：
接口地址(也就是URL地址)
請(qǐng)求方式(一般就是get、set，當(dāng)然還有put、delete)
請(qǐng)求數(shù)據(jù)(request，有head跟body)
響應(yīng)數(shù)據(jù)(response)
本篇將解決以下3個(gè)問(wèn)題：
當(dāng)接收到請(qǐng)求時(shí)，如何優(yōu)雅的校驗(yàn)參數(shù)
返回響應(yīng)數(shù)據(jù)該如何統(tǒng)一的進(jìn)行處理
接收到請(qǐng)求，處理業(yè)務(wù)邏輯時(shí)拋出了異常又該如何處理
Part2Controller層參數(shù)接收（太基礎(chǔ)了，可以跳過(guò)）
常見(jiàn)的請(qǐng)求就分為 get 跟 post 2種
@RestController @RequestMapping("/product/product-info") publicclassProductInfoController{ @Autowired ProductInfoServiceproductInfoService; @GetMapping("/findById") publicProductInfoQueryVofindById(Integerid){ ... } @PostMapping("/page") publicIPagefindPage(Pagepage,ProductInfoQueryVovo){ ... } }
@RestController：@RestController = @Controller + @ResponseBody。加上這個(gè)注解，springboot就會(huì)吧這個(gè)類(lèi)當(dāng)成 controller 進(jìn)行處理，然后把所有返回的參數(shù)放到 ResponseBody 中
@RequestMapping：請(qǐng)求的前綴，也就是所有該 Controller 下的請(qǐng)求都需要加上 /product/product-info 的前綴
@GetMapping("/findById")：標(biāo)志這是一個(gè) get 請(qǐng)求，并且需要通過(guò) /findById 地址才可以訪問(wèn)到
@PostMapping("/page")：同理，表示是個(gè) post 請(qǐng)求
參數(shù)：至于參數(shù)部分，只需要寫(xiě)上 ProductInfoQueryVo，前端過(guò)來(lái)的 json 請(qǐng)求便會(huì)通過(guò)映射賦值到對(duì)應(yīng)的對(duì)象中，例如請(qǐng)求這么寫(xiě)，productId 就會(huì)自動(dòng)被映射到 vo 對(duì)應(yīng)的屬性當(dāng)中
size:1 current:1 productId:1 productName:泡腳
Part3統(tǒng)一狀態(tài)碼
1. 返回格式
為了跟 前端妹妹 打好關(guān)系，我們通常需要對(duì)后端返回的數(shù)據(jù)進(jìn)行包裝一下，增加一下 狀態(tài)碼，狀態(tài)信息，這樣前端妹妹接收到數(shù)據(jù)就可以根據(jù)不同的 狀態(tài)碼，判斷 響應(yīng)數(shù)據(jù)狀態(tài)，是否成功是否異常進(jìn)行不同的顯示。當(dāng)然這讓你擁有了更多跟前端妹妹的交流機(jī)會(huì)，假設(shè)我們約定了 1000 就是成功的意思如果你不封裝，那么返回的數(shù)據(jù)是這樣子的
歡迎關(guān)注公眾號(hào)"Java學(xué)習(xí)之道"，查看更多干貨！
{
"productId":1,
"productName":"泡腳",
"productPrice":100.00,
"productDescription":"中藥泡腳加按摩",
"productStatus":0,
}
經(jīng)過(guò)封裝以后時(shí)這樣子的
{
"code":1000,
"msg":"請(qǐng)求成功",
"data":{
"productId":1,
"productName":"泡腳",
"productPrice":100.00,
"productDescription":"中藥泡腳加按摩",
"productStatus":0,
}
}
2. 封裝ResultVo
這些狀態(tài)碼肯定都是要預(yù)先編好的，怎么編呢？寫(xiě)個(gè)常量 1000？還是直接寫(xiě)死 1000？要這么寫(xiě)就真的書(shū)白讀的了，寫(xiě) 狀態(tài)碼 當(dāng)然是用枚舉拉
首先先定義一個(gè) 狀態(tài)碼 的接口，所有 狀態(tài)碼 都需要實(shí)現(xiàn)它，有了標(biāo)準(zhǔn)才好做事
publicinterfaceStatusCode{
publicintgetCode();
publicStringgetMsg();
}
然后去找前端妹妹，跟他約定好狀態(tài)碼（這可能是你們唯一的約定了）枚舉類(lèi)嘛，當(dāng)然不能有 setter 方法了，因此我們不能在用 @Data 注解了，我們要用 @Getter
@Getter publicenumResultCodeimplementsStatusCode{ SUCCESS(1000,"請(qǐng)求成功"), FAILED(1001,"請(qǐng)求失敗"), VALIDATE_ERROR(1002,"參數(shù)校驗(yàn)失敗"), RESPONSE_PACK_ERROR(1003,"response返回包裝失敗"); privateintcode; privateStringmsg; ResultCode(intcode,Stringmsg){ this.code=code; this.msg=msg; } }
寫(xiě)好枚舉類(lèi)，就開(kāi)始寫(xiě) ResultVo 包裝類(lèi)了，我們預(yù)設(shè)了幾種默認(rèn)的方法，比如成功的話就默認(rèn)傳入 object 就可以了，我們自動(dòng)包裝成 success
@Data
publicclassResultVo{
//狀態(tài)碼
privateintcode;
//狀態(tài)信息
privateStringmsg;
//返回對(duì)象
privateObjectdata;
//手動(dòng)設(shè)置返回vo
publicResultVo(intcode,Stringmsg,Objectdata){
this.code=code;
this.msg=msg;
this.data=data;
}
//默認(rèn)返回成功狀態(tài)碼，數(shù)據(jù)對(duì)象
publicResultVo(Objectdata){
this.code=ResultCode.SUCCESS.getCode();
this.msg=ResultCode.SUCCESS.getMsg();
this.data=data;
}
//返回指定狀態(tài)碼，數(shù)據(jù)對(duì)象
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; 這么簡(jiǎn)單了，而是需要 new ResultVo(data);
@PostMapping("/findByVo")
publicResultVofindByVo(@ValidatedProductInfoVovo){
ProductInfoproductInfo=newProductInfo();
BeanUtils.copyProperties(vo,productInfo);
returnnewResultVo(productInfoService.getOne(newQueryWrapper(productInfo)));
}
最后返回就會(huì)是上面帶了狀態(tài)碼的數(shù)據(jù)了
Part4統(tǒng)一校驗(yàn)
1. 原始做法
假設(shè)有一個(gè)添加 ProductInfo 的接口，在沒(méi)有統(tǒng)一校驗(yàn)時(shí)，我們需要這么做
@Data
publicclassProductInfoVo{
//商品名稱(chēng)
privateStringproductName;
//商品價(jià)格
privateBigDecimalproductPrice;
//上架狀態(tài)
privateIntegerproductStatus;
}
@PostMapping("/findByVo")
publicProductInfofindByVo(ProductInfoVovo){
if(StringUtils.isNotBlank(vo.getProductName())){
thrownewAPIException("商品名稱(chēng)不能為空");
}
if(null!=vo.getProductPrice()&&vo.getProductPrice().compareTo(newBigDecimal(0))
這if寫(xiě)的人都傻了，能忍嗎？肯定不能忍啊
歡迎關(guān)注公眾號(hào)"Java學(xué)習(xí)之道"，查看更多干貨！
2. @Validated參數(shù)校驗(yàn)
好在有 @Validated，又是一個(gè)校驗(yàn)參數(shù)必備良藥了。有了 @Validated 我們只需要再 vo 上面加一點(diǎn)小小的注解，便可以完成校驗(yàn)功能
@Data
publicclassProductInfoVo{
@NotNull(message="商品名稱(chēng)不允許為空")
privateStringproductName;
@Min(value=0,message="商品價(jià)格不允許為負(fù)數(shù)")
privateBigDecimalproductPrice;
privateIntegerproductStatus;
}
@PostMapping("/findByVo")
publicProductInfofindByVo(@ValidatedProductInfoVovo){
ProductInfoproductInfo=newProductInfo();
BeanUtils.copyProperties(vo,productInfo);
returnnewResultVo(productInfoService.getOne(newQueryWrapper(productInfo)));
}
運(yùn)行看看，如果參數(shù)不對(duì)會(huì)發(fā)生什么？我們故意傳一個(gè)價(jià)格為 -1 的參數(shù)過(guò)去
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":"商品價(jià)格不允許為負(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[商品價(jià)格不允許為負(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"
}
大功告成了嗎？雖然成功校驗(yàn)了參數(shù)，也返回了異常，并且?guī)?"商品價(jià)格不允許為負(fù)數(shù)" 的信息。但是你要是這樣返回給前端，前端妹妹就提刀過(guò)來(lái)了，當(dāng)年約定好的 狀態(tài)碼，你個(gè) 負(fù)心人 說(shuō)忘就忘？用戶 體驗(yàn)小于等于0 ??！所以我們要進(jìn)行優(yōu)化一下，每次出現(xiàn)異常的時(shí)候，自動(dòng)把 狀態(tài)碼 寫(xiě)好，不負(fù)妹妹之約！
歡迎關(guān)注公眾號(hào)"Java學(xué)習(xí)之道"，查看更多干貨！
3. 優(yōu)化異常處理
首先我們先看看校驗(yàn)參數(shù)拋出了什么異常
Resolved[org.springframework.validation.BindException:org.springframework.validation.BeanPropertyBindingResult:1errors
我們看到代碼拋出了 org.springframework.validation.BindException 的綁定異常，因此我們的思路就是 AOP 攔截所有 controller，然后異常的時(shí)候統(tǒng)一攔截起來(lái)，進(jìn)行封裝！完美！玩你個(gè)頭啊完美，這么呆瓜的操作 springboot 不知道嗎？ spring mvc 當(dāng)然知道拉，所以給我們提供了一個(gè) @RestControllerAdvice 來(lái)增強(qiáng)所有 @RestController，然后使用 @ExceptionHandler 注解，就可以攔截到對(duì)應(yīng)的異常。
這里我們就攔截 BindException.class 就好了。最后在返回之前，我們對(duì)異常信息進(jìn)行包裝一下，包裝成 ResultVo，當(dāng)然要跟上 ResultCode.VALIDATE_ERROR 的異常狀態(tài)碼。這樣前端妹妹看到 VALIDATE_ERROR 的狀態(tài)碼，就會(huì)調(diào)用數(shù)據(jù)校驗(yàn)異常的彈窗提示用戶哪里沒(méi)填好
@RestControllerAdvice
publicclassControllerExceptionAdvice{
@ExceptionHandler({BindException.class})
publicResultVoMethodArgumentNotValidExceptionHandler(BindExceptione){
//從異常對(duì)象中拿到ObjectError對(duì)象
ObjectErrorobjectError=e.getBindingResult().getAllErrors().get(0);
returnnewResultVo(ResultCode.VALIDATE_ERROR,objectError.getDefaultMessage());
}
}
來(lái)康康效果，完美。1002 與前端妹妹約定好的狀態(tài)碼
{
"code":1002,
"msg":"參數(shù)校驗(yàn)失敗",
"data":"商品價(jià)格不允許為負(fù)數(shù)"
}
Part5統(tǒng)一響應(yīng)
1. 統(tǒng)一包裝響應(yīng)
再回頭看一下 controller 層的返回
returnnewResultVo(productInfoService.getOne(newQueryWrapper(productInfo)));
開(kāi)發(fā)小哥肯定不樂(lè)意了，誰(shuí)有空天天寫(xiě) new ResultVo(data) 啊，我就想返回一個(gè)實(shí)體！怎么實(shí)現(xiàn)我不管！好把，那就是 AOP 攔截所有 Controller，再 @After 的時(shí)候統(tǒng)一幫你封裝一下咯怕是上一次臉打的不夠疼，springboot能不知道這么個(gè)操作嗎？
@RestControllerAdvice(basePackages={"com.bugpool.leilema"})
publicclassControllerResponseAdviceimplementsResponseBodyAdvice
@RestControllerAdvice(basePackages = {"com.bugpool.leilema"}) 自動(dòng)掃描了所有指定包下的 controller，在 Response 時(shí)進(jìn)行統(tǒng)一處理
重寫(xiě) supports 方法，也就是說(shuō)，當(dāng)返回類(lèi)型已經(jīng)是 ResultVo 了，那就不需要封裝了，當(dāng)不等與 ResultVo 時(shí)才進(jìn)行調(diào)用 beforeBodyWrite 方法，跟過(guò)濾器的效果是一樣的
最后重寫(xiě)我們的封裝方法 beforeBodyWrite，注意除了 String 的返回值有點(diǎn)特殊，無(wú)法直接封裝成 json，我們需要進(jìn)行特殊處理，其他的直接 new ResultVo(data); 就ok了
打完收工，康康效果
@PostMapping("/findByVo")
publicProductInfofindByVo(@ValidatedProductInfoVovo){
ProductInfoproductInfo=newProductInfo();
BeanUtils.copyProperties(vo,productInfo);
returnproductInfoService.getOne(newQueryWrapper(productInfo));
}
此時(shí)就算我們返回的是 po，接收到的返回就是標(biāo)準(zhǔn)格式了，開(kāi)發(fā)小哥露出了欣慰的笑容
{
"code":1000,
"msg":"請(qǐng)求成功",
"data":{
"productId":1,
"productName":"泡腳",
"productPrice":100.00,
"productDescription":"中藥泡腳加按摩",
"productStatus":0,
...
}
}
2. NOT統(tǒng)一響應(yīng)
不開(kāi)啟統(tǒng)一響應(yīng)原因
開(kāi)發(fā)小哥是開(kāi)心了，可是其他系統(tǒng)就不開(kāi)心了。舉個(gè)例子：我們項(xiàng)目中集成了一個(gè) 健康檢測(cè) 的功能，也就是這貨
@RestController
publicclassHealthController{
@GetMapping("/health")
publicStringhealth(){
return"success";
}
}
公司部署了一套校驗(yàn)所有系統(tǒng)存活狀態(tài)的工具，這工具就定時(shí)發(fā)送 get 請(qǐng)求給我們系統(tǒng)
“兄弟，你死了嗎？”
“我沒(méi)死，滾”
“兄弟，你死了嗎？”
“我沒(méi)死，滾”
是的，web項(xiàng)目的本質(zhì)就是復(fù)讀機(jī)。一旦發(fā)送的請(qǐng)求 沒(méi)響應(yīng)，就會(huì)給負(fù)責(zé)人發(fā)信息（企業(yè)微信或者短信之類(lèi)的），你的 系統(tǒng)死啦！ 趕緊回來(lái) 排查bug 吧！讓大家感受一下。每次看到我都 射射發(fā)抖，早上6點(diǎn)！我tm！?。。?！好吧，沒(méi)辦法，人家是老大，人家要的返回不是
{
"code":1000,
"msg":"請(qǐng)求成功",
"data":"success"
}
人家要的返回只要一個(gè) success，人家定的標(biāo)準(zhǔn)不可能因?yàn)槟阋粋€(gè)系統(tǒng)改。俗話說(shuō)的好，如果你改變不了環(huán)境，那你就只能我****
新增不進(jìn)行封裝注解
因?yàn)榘俜种?9的請(qǐng)求還是需要包裝的，只有個(gè)別不需要，寫(xiě)在包裝的過(guò)濾器吧？又不是很好維護(hù)，那就加個(gè)注解好了。所有不需要包裝的就加上這個(gè)注解。
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public@interfaceNotControllerResponseAdvice{
}
然后在我們的增強(qiáng)過(guò)濾方法上過(guò)濾包含這個(gè)注解的方法
@RestControllerAdvice(basePackages={"com.bugpool.leilema"})
publicclassControllerResponseAdviceimplementsResponseBodyAdvice
最后就在不需要包裝的方法上加上注解
@RestController
publicclassHealthController{
@GetMapping("/health")
@NotControllerResponseAdvice
publicStringhealth(){
return"success";
}
}
這時(shí)候就不會(huì)自動(dòng)封裝了，而其他沒(méi)加注解的則依舊自動(dòng)包裝
Part6統(tǒng)一異常
每個(gè)系統(tǒng)都會(huì)有自己的 業(yè)務(wù)異常，比如 庫(kù)存不能小于0 之類(lèi)的，這種異常并非程序異常，而是業(yè)務(wù)操作引發(fā)的異常，我們也需要進(jìn)行規(guī)范的編排業(yè)務(wù) 異常狀態(tài)碼，并且寫(xiě)一個(gè)專(zhuān)門(mén)處理的 異常類(lèi)，最后通過(guò)剛剛學(xué)習(xí)過(guò)的 異常攔截 統(tǒng)一進(jìn)行處理，以及打 日志
異常狀態(tài)碼枚舉，既然是狀態(tài)碼，那就肯定要實(shí)現(xiàn)我們的標(biāo)準(zhǔn)接口 StatusCode
@Getter
publicenumAppCodeimplementsStatusCode{
APP_ERROR(2000,"業(yè)務(wù)異常"),
PRICE_ERROR(2001,"價(jià)格異常");
privateintcode;
privateStringmsg;
AppCode(intcode,Stringmsg){
this.code=code;
this.msg=msg;
}
}
異常類(lèi)，這里需要強(qiáng)調(diào)一下，code 代表 AppCode 的異常狀態(tài)碼，也就是2000；msg 代表 業(yè)務(wù)異常，這只是一個(gè)大類(lèi)，一般前端會(huì)放到彈窗 title 上；最后 super(message); 這才是拋出的詳細(xì)信息，在前端顯示在 彈窗體 中，在 ResultVo 則保存在 data 中
@Getter
publicclassAPIExceptionextendsRuntimeException{
privateintcode;
privateStringmsg;
//手動(dòng)設(shè)置異常
publicAPIException(StatusCodestatusCode,Stringmessage){
//message用于用戶設(shè)置拋出錯(cuò)誤詳情，例如：當(dāng)前價(jià)格-5，小于0
super(message);
//狀態(tài)碼
this.code=statusCode.getCode();
//狀態(tài)碼配套的msg
this.msg=statusCode.getMsg();
}
//默認(rèn)異常使用APP_ERROR狀態(tài)碼
publicAPIException(Stringmessage){
super(message);
this.code=AppCode.APP_ERROR.getCode();
this.msg=AppCode.APP_ERROR.getMsg();
}
}
最后進(jìn)行統(tǒng)一異常的攔截，這樣無(wú)論在 service 層還是 controller 層，開(kāi)發(fā)人員只管拋出 API異常，不需要關(guān)系怎么返回給前端，更不需要關(guān)心 日志 的打印
@RestControllerAdvice
publicclassControllerExceptionAdvice{
@ExceptionHandler({BindException.class})
publicResultVoMethodArgumentNotValidExceptionHandler(BindExceptione){
//從異常對(duì)象中拿到ObjectError對(duì)象
ObjectErrorobjectError=e.getBindingResult().getAllErrors().get(0);
returnnewResultVo(ResultCode.VALIDATE_ERROR,objectError.getDefaultMessage());
}
@ExceptionHandler(APIException.class)
publicResultVoAPIExceptionHandler(APIExceptione){
//log.error(e.getMessage(),e);由于還沒(méi)集成日志框架，暫且放著，寫(xiě)上TODO
returnnewResultVo(e.getCode(),e.getMsg(),e.getMessage());
}
}
最后使用，我們的代碼只需要這么寫(xiě)
if(null==orderMaster){
thrownewAPIException(AppCode.ORDER_NOT_EXIST,"訂單號(hào)不存在："+orderId);
}
{
"code":2003,
"msg":"訂單不存在",
"data":"訂單號(hào)不存在：1998"
}
就會(huì)自動(dòng)拋出 AppCode.ORDER_NOT_EXIST 狀態(tài)碼的響應(yīng)，并且?guī)袭惓Ｔ敿?xì)信息 訂單號(hào)不存在：xxxx。后端小哥開(kāi)發(fā)有效率，前端妹妹獲取到 2003 狀態(tài)碼，調(diào)用對(duì)應(yīng)警告彈窗，title 寫(xiě)上 訂單不存在，body 詳細(xì)信息記載"訂單號(hào)不存在：1998"。同時(shí)日志還自動(dòng)打上去了！
審核編輯：湯梓紅
-
Controller
+關(guān)注
關(guān)注
0文章
398瀏覽量
57618 -
代碼
+關(guān)注
關(guān)注
30文章
4900瀏覽量
70746
原文標(biāo)題：如何把 Controller 層代碼寫(xiě)的更優(yōu)雅？
文章出處：【微信號(hào)：AndroidPush，微信公眾號(hào)：Android編程精選】歡迎添加關(guān)注！文章轉(zhuǎn)載請(qǐng)注明出處。
如何讓你的Python代碼竟優(yōu)雅又地道
3個(gè)關(guān)鍵字讓你的Python代碼更優(yōu)雅
STM32U5如何把數(shù)據(jù)保存到SRAM2中？
以一種更優(yōu)雅的方式去實(shí)現(xiàn)一個(gè)Verilog版的狀態(tài)機(jī)
iOS中開(kāi)發(fā)簡(jiǎn)化view controller的方法
讓你的 Python 代碼優(yōu)雅又地道
程序員是怎么寫(xiě)代碼的？常見(jiàn)問(wèn)詳解
如何提高代碼性能、使代碼遠(yuǎn)離Bug、令代碼更優(yōu)雅
Python更優(yōu)雅的日志記錄解決方案Loguru
VS Code + SDCC + stcflash + Makefile 搭建比Keil更優(yōu)雅的51開(kāi)發(fā)環(huán)境
一個(gè)優(yōu)秀的Controller層邏輯
Controller層代碼就該這么寫(xiě)
如何優(yōu)雅的寫(xiě)css代碼
QT原生的QJson是否有更優(yōu)雅的方法來(lái)封裝一些Json對(duì)象
工商網(wǎng)監(jiān)
評(píng)論