前言
本篇主要要介紹的就是controller
層的處理,一個完整的後端請求由4部分組成:
接口地址
(也就是URL地址)請求方式
(一般就是get、set,當然還有put、delete)請求數據
(request,有head跟body)響應數據
(response)
本篇將解決以下3個問題:
- 當接收到請求時,如何優雅的校驗參數
- 返回響應數據該如何統一的進行處理
- 接收到請求,處理業務邏輯時拋出了異常又該如何處理
一、Controller層參數接收(太基礎了,可以跳過)
常見的請求就分爲get
跟post
2種
@RestController
@RequestMapping("/product/product-info")
public class ProductInfoController {
@Autowired
ProductInfoService productInfoService;
@GetMapping("/findById")
public ProductInfoQueryVo findById(Integer id) {
...
}
@PostMapping("/page")
public IPage findPage(Page page, ProductInfoQueryVo vo) {
...
}
}
1、@RestController
:之前解釋過,@RestController
= @Controller
+ ResponseBody
。加上這個註解,springboot就會吧這個類當成controller
進行處理,然後把所有返回的參數放到ResponseBody
中
推薦一個 Spring Boot 基礎實戰教程:
https://github.com/javastacks/spring-boot-best-practice
2、@RequestMapping
:請求的前綴,也就是所有該Controller
下的請求都需要加上/product/product-info
的前綴
3、@GetMapping("/findById")
:標誌這是一個get
請求,並且需要通過/findById
地址纔可以訪問到
4、@PostMapping("/page")
:同理,表示是個post
請求
5、參數
:至於參數部分,只需要寫上ProductInfoQueryVo
,前端過來的json
請求便會通過映射賦值到對應的對象中,例如請求這麼寫,productId
就會自動被映射到vo
對應的屬性當中
size : 1
current : 1
productId : 1
productName : 泡腳
二、統一狀態碼
1. 返回格式
爲了跟前端妹妹
打好關係,我們通常需要對後端返回的數據進行包裝一下,增加一下狀態碼
,狀態信息
,這樣前端妹妹接收到數據就可以根據不同的狀態碼
,判斷響應數據狀態
,是否成功是否異常進行不同的顯示。
當然這讓你擁有了更多跟前端妹妹的交流機會,假設我們約定了1000
就是成功的意思
如果你不封裝,那麼返回的數據是這樣子的
{
"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
?要這麼寫就真的書白讀的了,寫狀態碼
當然是用枚舉拉
1、首先先定義一個狀態碼
的接口,所有狀態碼
都需要實現它,有了標準纔好做事
public interface StatusCode {
public int getCode();
public String getMsg();
}
2、然後去找前端妹妹,跟他約定好狀態碼(這可能是你們唯一的約定了)枚舉類嘛,當然不能有setter
方法了,因此我們不能在用@Data
註解了,我們要用@Getter
@Getter
public enum ResultCode implements StatusCode{
SUCCESS(1000, "請求成功"),
FAILED(1001, "請求失敗"),
VALIDATE_ERROR(1002, "參數校驗失敗"),
RESPONSE_PACK_ERROR(1003, "response返回包裝失敗");
private int code;
private String msg;
ResultCode(int code, String msg) {
this.code = code;
this.msg = msg;
}
}
3、寫好枚舉類,就開始寫ResultVo
包裝類了,我們預設了幾種默認的方法,比如成功的話就默認傳入object
就可以了,我們自動包裝成success
@Data
public class ResultVo {
// 狀態碼
private int code;
// 狀態信息
private String msg;
// 返回對象
private Object data;
// 手動設置返回vo
public ResultVo(int code, String msg, Object data) {
this.code = code;
this.msg = msg;
this.data = data;
}
// 默認返回成功狀態碼,數據對象
public ResultVo(Object data) {
this.code = ResultCode.SUCCESS.getCode();
this.msg = ResultCode.SUCCESS.getMsg();
this.data = data;
}
// 返回指定狀態碼,數據對象
public ResultVo(StatusCode statusCode, Object data) {
this.code = statusCode.getCode();
this.msg = statusCode.getMsg();
this.data = data;
}
// 只返回狀態碼
public ResultVo(StatusCode statusCode) {
this.code = statusCode.getCode();
this.msg = statusCode.getMsg();
this.data = null;
}
}
4、使用,現在的返回肯定就不是return data;
這麼簡單了,而是需要new ResultVo(data);
@PostMapping("/findByVo")
public ResultVo findByVo(@Validated ProductInfoVo vo) {
ProductInfo productInfo = new ProductInfo();
BeanUtils.copyProperties(vo, productInfo);
return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
}
最後返回就會是上面帶了狀態碼的數據了
三、統一校驗
1. 原始做法
假設有一個添加ProductInfo
的接口,在沒有統一校驗時,我們需要這麼做
@Data
public class ProductInfoVo {
// 商品名稱
private String productName;
// 商品價格
private BigDecimal productPrice;
// 上架狀態
private Integer productStatus;
}
@PostMapping("/findByVo")
public ProductInfo findByVo(ProductInfoVo vo) {
if (StringUtils.isNotBlank(vo.getProductName())) {
throw new APIException("商品名稱不能爲空");
}
if (null != vo.getProductPrice() && vo.getProductPrice().compareTo(new BigDecimal(0)) < 0) {
throw new APIException("商品價格不能爲負數");
}
...
ProductInfo productInfo = new ProductInfo();
BeanUtils.copyProperties(vo, productInfo);
return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
}
這if寫的人都傻了,能忍嗎?肯定不能忍啊
2. @Validated參數校驗
好在有@Validated
,又是一個校驗參數必備良藥了。有了@Validated
我們只需要再vo
上面加一點小小的註解,便可以完成校驗功能
@Data
public class ProductInfoVo {
@NotNull(message = "商品名稱不允許爲空")
private String productName;
@Min(value = 0, message = "商品價格不允許爲負數")
private BigDecimal productPrice;
private Integer productStatus;
}
@PostMapping("/findByVo")
public ProductInfo findByVo(@Validated ProductInfoVo vo) {
ProductInfo productInfo = new ProductInfo();
BeanUtils.copyProperties(vo, productInfo);
return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
}
運行看看,如果參數不對會發生什麼?
我們故意傳一個價格爲-1
的參數過去
productName : 泡腳
productPrice : -1
productStatus : 1
{
"timestamp": "2020-04-19T03:06:37.268+0000",
"status": 400,
"error": "Bad Request",
"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": "Validation failed for object\u003d\u0027productInfoVo\u0027. Error count: 1",
"trace": "org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors\nField error in object \u0027productInfoVo\u0027 on field \u0027productPrice\u0027: rejected value [-1]; codes [Min.productInfoVo.productPrice,Min.productPrice,Min.java.math.BigDecimal,Min]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [productInfoVo.productPrice,productPrice]; arguments []; default message [productPrice],0]; default message [商品價格不允許爲負數]\n\tat org.springframework.web.method.annotation.ModelAttributeMethodProcessor.resolveArgument(ModelAttributeMethodProcessor.java:164)\n\tat org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:121)\n\tat org.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:167)\n\tat org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:134)\n\tat org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:105)\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:879)\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:793)\n\tat org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)\n\tat org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1040)\n\tat org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:943)\n\tat org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)\n\tat org.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:909)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:660)\n\tat org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:741)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:231)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat com.alibaba.druid.support.http.WebStatFilter.doFilter(WebStatFilter.java:124)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:202)\n\tat org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:96)\n\tat org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:541)\n\tat org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:139)\n\tat org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)\n\tat org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:74)\n\tat org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:343)\n\tat org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:373)\n\tat org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)\n\tat org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:868)\n\tat org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1594)\n\tat org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)\n\tat java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)\n\tat java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)\n\tat org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)\n\tat java.base/java.lang.Thread.run(Thread.java:830)\n",
"path": "/leilema/product/product-info/findByVo"
}
大功告成了嗎?雖然成功校驗了參數,也返回了異常,並且帶上"商品價格不允許爲負數"
的信息。但是你要是這樣返回給前端,前端妹妹就提刀過來了,當年約定好的狀態碼
,你個負心人
說忘就忘?用戶體驗小於等於0
啊!所以我們要進行優化一下,每次出現異常的時候,自動把狀態碼
寫好,不負妹妹之約!
3. 優化異常處理
首先我們先看看校驗參數拋出了什麼異常
Resolved [org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors
我們看到代碼拋出了org.springframework.validation.BindException
的綁定異常,因此我們的思路就是AOP
攔截所有controller
,然後異常的時候統一攔截起來,進行封裝!完美!
玩你個頭啊完美,這麼呆瓜的操作springboot
不知道嗎?spring mvc
當然知道拉,所以給我們提供了一個@RestControllerAdvice
來增強所有@RestController
,然後使用@ExceptionHandler
註解,就可以攔截到對應的異常。
這裏我們就攔截BindException.class
就好了。最後在返回之前,我們對異常信息進行包裝一下,包裝成ResultVo
,當然要跟上ResultCode.VALIDATE_ERROR
的異常狀態碼。這樣前端妹妹看到VALIDATE_ERROR
的狀態碼,就會調用數據校驗異常的彈窗提示用戶哪裏沒填好
@RestControllerAdvice
public class ControllerExceptionAdvice {
@ExceptionHandler({BindException.class})
public ResultVo MethodArgumentNotValidExceptionHandler(BindException e) {
// 從異常對象中拿到ObjectError對象
ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
return new ResultVo(ResultCode.VALIDATE_ERROR, objectError.getDefaultMessage());
}
}
來康康效果,完美。1002
與前端妹妹約定好的狀態碼
{
"code": 1002,
"msg": "參數校驗失敗",
"data": "商品價格不允許爲負數"
}
四、統一響應
1. 統一包裝響應
再回頭看一下controller
層的返回
return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
開發小哥肯定不樂意了,誰有空天天寫new ResultVo(data)
啊,我就想返回一個實體!怎麼實現我不管!好把,那就是AOP
攔截所有Controller
,再@After
的時候統一幫你封裝一下咯
怕是上一次臉打的不夠疼,springboot能不知道這麼個操作嗎?
@RestControllerAdvice(basePackages = {"com.bugpool.leilema"})
public class ControllerResponseAdvice implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
// response是ResultVo類型,或者註釋了NotControllerResponseAdvice都不進行包裝
return !methodParameter.getParameterType().isAssignableFrom(ResultVo.class);
}
@Override
public Object beforeBodyWrite(Object data, MethodParameter returnType, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest request, ServerHttpResponse response) {
// String類型不能直接包裝
if (returnType.getGenericParameterType().equals(String.class)) {
ObjectMapper objectMapper = new ObjectMapper();
try {
// 將數據包裝在ResultVo裏後轉換爲json串進行返回
return objectMapper.writeValueAsString(new ResultVo(data));
} catch (JsonProcessingException e) {
throw new APIException(ResultCode.RESPONSE_PACK_ERROR, e.getMessage());
}
}
// 否則直接包裝成ResultVo返回
return new ResultVo(data);
}
}
@RestControllerAdvice(basePackages = {"com.bugpool.leilema"})
自動掃描了所有指定包下的controller
,在Response
時進行統一處理- 重寫
supports
方法,也就是說,當返回類型已經是ResultVo
了,那就不需要封裝了,當不等與ResultVo
時才進行調用beforeBodyWrite
方法,跟過濾器的效果是一樣的 - 最後重寫我們的封裝方法
beforeBodyWrite
,注意除了String
的返回值有點特殊,無法直接封裝成json,我們需要進行特殊處理,其他的直接new ResultVo(data);
就ok了
打完收工,康康效果
@PostMapping("/findByVo")
public ProductInfo findByVo(@Validated ProductInfoVo vo) {
ProductInfo productInfo = new ProductInfo();
BeanUtils.copyProperties(vo, productInfo);
return productInfoService.getOne(new QueryWrapper(productInfo));
}
此時就算我們返回的是po
,接收到的返回就是標準格式了,開發小哥露出了欣慰的笑容
{
"code": 1000,
"msg": "請求成功",
"data": {
"productId": 1,
"productName": "泡腳",
"productPrice": 100.00,
"productDescription": "中藥泡腳加按摩",
"productStatus": 0,
...
}
}
2. NOT統一響應
不開啓統一響應原因
開發小哥是開心了,可是其他系統就不開心了。舉個例子:我們項目中集成了一個健康檢測
的功能,也就是這貨
@RestController
public class HealthController {
@GetMapping("/health")
public String health() {
return "success";
}
}
公司部署了一套校驗所有系統存活狀態的工具,這工具就定時發送get
請求給我們系統
“兄弟,你死了嗎?”
“我沒死,滾”
“兄弟,你死了嗎?”
“我沒死,滾”
是的,web項目的本質就是復讀機。一旦發送的請求沒響應
,就會給負責人發信息(企業微信或者短信之類的),你的系統死啦
!趕緊回來排查bug
吧!讓大家感受一下。每次看到我都射射發抖
,早上6點!我tm!!!!!
好吧,沒辦法,人家是老大,人家要的返回不是
{
"code": 1000,
"msg": "請求成功",
"data": "success"
}
人家要的返回只要一個success
,人家定的標準不可能因爲你一個系統改。俗話說的好,如果你改變不了環境,那你就只能我****
新增不進行封裝註解
因爲百分之99的請求還是需要包裝的,只有個別不需要,寫在包裝的過濾器吧?又不是很好維護,那就加個註解好了。所有不需要包裝的就加上這個註解。
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface NotControllerResponseAdvice {
}
然後在我們的增強過濾方法上過濾包含這個註解的方法
@RestControllerAdvice(basePackages = {"com.bugpool.leilema"})
public class ControllerResponseAdvice implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
// response是ResultVo類型,或者註釋了NotControllerResponseAdvice都不進行包裝
return !(methodParameter.getParameterType().isAssignableFrom(ResultVo.class)
|| methodParameter.hasMethodAnnotation(NotControllerResponseAdvice.class));
}
...
最後就在不需要包裝的方法上加上註解
@RestController
public class HealthController {
@GetMapping("/health")
@NotControllerResponseAdvice
public String health() {
return "success";
}
}
這時候就不會自動封裝了,而其他沒加註解的則依舊自動包裝
五、統一異常
每個系統都會有自己的業務異常
,比如庫存不能小於0
子類的,這種異常並非程序異常,而是業務操作引發的異常,我們也需要進行規範的編排業務異常狀態碼
,並且寫一個專門處理的異常類
,最後通過剛剛學習過的異常攔截
統一進行處理,以及打日誌
1、異常狀態碼枚舉,既然是狀態碼,那就肯定要實現我們的標準接口StatusCode
@Getter
public enum AppCode implements StatusCode {
APP_ERROR(2000, "業務異常"),
PRICE_ERROR(2001, "價格異常");
private int code;
private String msg;
AppCode(int code, String msg) {
this.code = code;
this.msg = msg;
}
}
2、異常類,這裏需要強調一下,code
代表AppCode
的異常狀態碼,也就是2000;msg
代表業務異常
,這只是一個大類,一般前端會放到彈窗title
上;最後super(message);
這纔是拋出的詳細信息,在前端顯示在彈窗體
中,在ResultVo
則保存在data
中。
@Getter
public class APIException extends RuntimeException {
private int code;
private String msg;
// 手動設置異常
public APIException(StatusCode statusCode, String message) {
// message用於用戶設置拋出錯誤詳情,例如:當前價格-5,小於0
super(message);
// 狀態碼
this.code = statusCode.getCode();
// 狀態碼配套的msg
this.msg = statusCode.getMsg();
}
// 默認異常使用APP_ERROR狀態碼
public APIException(String message) {
super(message);
this.code = AppCode.APP_ERROR.getCode();
this.msg = AppCode.APP_ERROR.getMsg();
}
}
3、最後進行統一異常的攔截,這樣無論在service
層還是controller
層,開發人員只管拋出API異常
,不需要關係怎麼返回給前端,更不需要關心日誌
的打印
@RestControllerAdvice
public class ControllerExceptionAdvice {
@ExceptionHandler({BindException.class})
public ResultVo MethodArgumentNotValidExceptionHandler(BindException e) {
// 從異常對象中拿到ObjectError對象
ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
return new ResultVo(ResultCode.VALIDATE_ERROR, objectError.getDefaultMessage());
}
@ExceptionHandler(APIException.class)
public ResultVo APIExceptionHandler(APIException e) {
// log.error(e.getMessage(), e); 由於還沒集成日誌框架,暫且放着,寫上TODO
return new ResultVo(e.getCode(), e.getMsg(), e.getMessage());
}
}
4、最後使用,我們的代碼只需要這麼寫
if (null == orderMaster) {
throw new APIException(AppCode.ORDER_NOT_EXIST, "訂單號不存在:" + orderId);
}
{
"code": 2003,
"msg": "訂單不存在",
"data": "訂單號不存在:1998"
}
就會自動拋出AppCode.ORDER_NOT_EXIST
狀態碼的響應,並且帶上異常詳細信息訂單號不存在:xxxx
。後端小哥開發有效率,前端妹妹獲取到2003
狀態碼,調用對應警告彈窗,title
寫上訂單不存在
,body
詳細信息記載"訂單號不存在:1998"
。同時日誌
還自動打上去了!666!老哥們三連點個贊!
版權聲明:本文爲CSDN博主「bugpool」的原創文章,遵循CC 4.0 BY-SA版權協議,轉載請附上原文出處鏈接及本聲明。原文鏈接:https://blog.csdn.net/chaitoudaren/article/details/105610962
近期熱文推薦:
1.1,000+ 道 Java面試題及答案整理(2022最新版)
4.別再寫滿屏的爆爆爆炸類了,試試裝飾器模式,這纔是優雅的方式!!
覺得不錯,別忘了隨手點贊+轉發哦!