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

一個優秀的Controller層邏輯
Controller層代碼就該這么寫
QT原生的QJson是否有更優雅的方法來封裝一些Json對象

評論