如何優(yōu)雅的寫 Controller 層代碼？
閱讀本文大概需要 13 分鐘。
來自：bugpool.blog.csdn.net/article/details/105610962
前言
本篇主要要介紹的就是controller層的處理，一個完整的后端請求由4部分組成：1. 接口地址(也就是URL地址)、2. 請求方式(一般就是get、set，當然還有put、delete)、3. 請求數(shù)據(jù)(request，有head跟body)、4. 響應數(shù)據(jù)(response)
本篇將解決以下3個問題：
當接收到請求時，如何優(yōu)雅的校驗參數(shù) 返回響應數(shù)據(jù)該如何統(tǒng)一的進行處理 接收到請求，處理業(yè)務邏輯時拋出了異常又該如何處理
一、Controller層參數(shù)接收（太基礎了，可以跳過）
常見的請求就分為get跟post2種
@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) {
...
}
}
@RestController： 之前解釋過， @RestController = @Controller + ResponseBody。加上這個注解，springboot就會吧這個類當成controller進行處理，然后把所有返回的參數(shù)放到ResponseBody中@RequestMapping： 請求的前綴，也就是所有該Controller下的請求都需要加上 /product/product-info的前綴@GetMapping("/findById")： 標志這是一個get請求，并且需要通過 /findById地址才可以訪問到@PostMapping("/page")： 同理，表示是個post請求 參數(shù)： 至于參數(shù)部分，只需要寫上 ProductInfoQueryVo，前端過來的json請求便會通過映射賦值到對應的對象中，例如請求這么寫，productId就會自動被映射到vo對應的屬性當中
size : 1
current : 1
productId : 1
productName : 泡腳
二、統(tǒng)一狀態(tài)碼
1. 返回格式
為了跟前端妹妹打好關(guān)系，我們通常需要對后端返回的數(shù)據(jù)進行包裝一下，增加一下狀態(tài)碼，狀態(tài)信息，這樣前端妹妹接收到數(shù)據(jù)就可以根據(jù)不同的狀態(tài)碼，判斷響應數(shù)據(jù)狀態(tài)，是否成功是否異常進行不同的顯示。當然這讓你擁有了更多跟前端妹妹的交流機會，假設我們約定了1000就是成功的意思
如果你不封裝，那么返回的數(shù)據(jù)是這樣子的
{
"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)碼肯定都是要預先編好的，怎么編呢？寫個常量1000？還是直接寫死1000？要這么寫就真的書白讀的了，寫狀態(tài)碼當然是用枚舉拉
首先先定義一個狀態(tài)碼的接口，所有狀態(tài)碼都需要實現(xiàn)它，有了標準才好做事
public interface StatusCode {
public int getCode();
public String getMsg();
}
然后去找前端妹妹，跟他約定好狀態(tài)碼（這可能是你們唯一的約定了）枚舉類嘛，當然不能有setter方法了，因此我們不能在用@Data注解了，我們要用@Getter
@Getter
public enum ResultCode implements StatusCode{
SUCCESS(1000, "請求成功"),
FAILED(1001, "請求失敗"),
VALIDATE_ERROR(1002, "參數(shù)校驗失敗"),
RESPONSE_PACK_ERROR(1003, "response返回包裝失敗");
private int code;
private String msg;
ResultCode(int code, String msg) {
this.code = code;
this.msg = msg;
}
}
寫好枚舉類，就開始寫ResultVo包裝類了，我們預設了幾種默認的方法，比如成功的話就默認傳入object就可以了，我們自動包裝成success
@Data
public class ResultVo {
// 狀態(tài)碼
private int code;
// 狀態(tài)信息
private String msg;
// 返回對象
private Object data;
// 手動設置返回vo
public ResultVo(int code, String msg, Object data) {
this.code = code;
this.msg = msg;
this.data = data;
}
// 默認返回成功狀態(tài)碼，數(shù)據(jù)對象
public ResultVo(Object data) {
this.code = ResultCode.SUCCESS.getCode();
this.msg = ResultCode.SUCCESS.getMsg();
this.data = data;
}
// 返回指定狀態(tài)碼，數(shù)據(jù)對象
public ResultVo(StatusCode statusCode, Object data) {
this.code = statusCode.getCode();
this.msg = statusCode.getMsg();
this.data = data;
}
// 只返回狀態(tài)碼
public ResultVo(StatusCode statusCode) {
this.code = statusCode.getCode();
this.msg = statusCode.getMsg();
this.data = null;
}
}
使用，現(xiàn)在的返回肯定就不是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)));
}
最后返回就會是上面帶了狀態(tài)碼的數(shù)據(jù)了
三、統(tǒng)一校驗
1. 原始做法
假設有一個添加ProductInfo的接口，在沒有統(tǒng)一校驗時，我們需要這么做
@Data
public class ProductInfoVo {
// 商品名稱
private String productName;
// 商品價格
private BigDecimal productPrice;
// 上架狀態(tài)
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("商品價格不能為負數(shù)");
}
...
ProductInfo productInfo = new ProductInfo();
BeanUtils.copyProperties(vo, productInfo);
return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
}
這if寫的人都傻了，能忍嗎？肯定不能忍啊
2. @Validated參數(shù)校驗
好在有@Validated，又是一個校驗參數(shù)必備良藥了。有了@Validated我們只需要再vo上面加一點小小的注解，便可以完成校驗功能
@Data
public class ProductInfoVo {
@NotNull(message = "商品名稱不允許為空")
private String productName;
@Min(value = 0, message = "商品價格不允許為負數(shù)")
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)));
}
運行看看，如果參數(shù)不對會發(fā)生什么？
我們故意傳一個價格為-1的參數(shù)過去
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": "商品價格不允許為負數(shù)",
"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 [商品價格不允許為負數(shù)]\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"
}
大功告成了嗎？雖然成功校驗了參數(shù)，也返回了異常，并且?guī)?商品價格不允許為負數(shù)"的信息。但是你要是這樣返回給前端，前端妹妹就提刀過來了，當年約定好的狀態(tài)碼，你個負心人說忘就忘？用戶體驗小于等于0啊！所以我們要進行優(yōu)化一下，每次出現(xiàn)異常的時候，自動把狀態(tài)碼寫好，不負妹妹之約！
3. 優(yōu)化異常處理
首先我們先看看校驗參數(shù)拋出了什么異常
Resolved [org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors
我們看到代碼拋出了org.springframework.validation.BindException的綁定異常，因此我們的思路就是AOP攔截所有controller，然后異常的時候統(tǒng)一攔截起來，進行封裝！完美！
玩你個頭啊完美，這么呆瓜的操作springboot不知道嗎？spring mvc當然知道拉，所以給我們提供了一個@RestControllerAdvice來增強所有@RestController，然后使用@ExceptionHandler注解，就可以攔截到對應的異常。
這里我們就攔截BindException.class就好了。最后在返回之前，我們對異常信息進行包裝一下，包裝成ResultVo，當然要跟上ResultCode.VALIDATE_ERROR的異常狀態(tài)碼。這樣前端妹妹看到VALIDATE_ERROR的狀態(tài)碼，就會調(diào)用數(shù)據(jù)校驗異常的彈窗提示用戶哪里沒填好
@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與前端妹妹約定好的狀態(tài)碼
{
"code": 1002,
"msg": "參數(shù)校驗失敗",
"data": "商品價格不允許為負數(shù)"
}
四、統(tǒng)一響應
1. 統(tǒng)一包裝響應
再回頭看一下controller層的返回
return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
開發(fā)小哥肯定不樂意了，誰有空天天寫new ResultVo(data)啊，我就想返回一個實體！怎么實現(xiàn)我不管！好把，那就是AOP攔截所有Controller，再@After的時候統(tǒng)一幫你封裝一下咯
怕是上一次臉打的不夠疼，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 {
// 將數(shù)據(jù)包裝在ResultVo里后轉(zhuǎn)換為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時進行統(tǒng)一處理重寫 supports方法，也就是說，當返回類型已經(jīng)是ResultVo了，那就不需要封裝了，當不等與ResultVo時才進行調(diào)用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，接收到的返回就是標準格式了，開發(fā)小哥露出了欣慰的笑容
{
"code": 1000,
"msg": "請求成功",
"data": {
"productId": 1,
"productName": "泡腳",
"productPrice": 100.00,
"productDescription": "中藥泡腳加按摩",
"productStatus": 0,
...
}
}
2. NOT統(tǒng)一響應
不開啟統(tǒng)一響應原因
開發(fā)小哥是開心了，可是其他系統(tǒng)就不開心了。舉個例子：我們項目中集成了一個健康檢測的功能，也就是這貨
@RestController
public class HealthController {
@GetMapping("/health")
public String health() {
return "success";
}
}
公司部署了一套校驗所有系統(tǒng)存活狀態(tài)的工具，這工具就定時發(fā)送get請求給我們系統(tǒng)
“兄弟，你死了嗎？” “我沒死，滾” “兄弟，你死了嗎？” “我沒死，滾”
是的，web項目的本質(zhì)就是復讀機。一旦發(fā)送的請求沒響應，就會給負責人發(fā)信息（企業(yè)微信或者短信之類的），你的系統(tǒng)死啦！趕緊回來排查bug吧！讓大家感受一下。每次看到我都射射發(fā)抖，早上6點！我tm?。。。。?/p>
{
"code": 1000,
"msg": "請求成功",
"data": "success"
}
新增不進行封裝注解
@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";
}
}
五、統(tǒng)一異常
@Getter
public enum AppCode implements StatusCode {
APP_ERROR(2000, "業(yè)務異常"),
PRICE_ERROR(2001, "價格異常");
private int code;
private String msg;
AppCode(int code, String msg) {
this.code = code;
this.msg = msg;
}
}
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);
// 狀態(tài)碼
this.code = statusCode.getCode();
// 狀態(tài)碼配套的msg
this.msg = statusCode.getMsg();
}
// 默認異常使用APP_ERROR狀態(tài)碼
public APIException(String message) {
super(message);
this.code = AppCode.APP_ERROR.getCode();
this.msg = AppCode.APP_ERROR.getMsg();
}
}
service層還是controller層，開發(fā)人員只管拋出API異常，不需要關(guān)系怎么返回給前端，更不需要關(guān)心日志的打印@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());
}
}
if (null == orderMaster) {
throw new APIException(AppCode.ORDER_NOT_EXIST, "訂單號不存在：" + orderId);
}
{
"code": 2003,
"msg": "訂單不存在",
"data": "訂單號不存在：1998"
}
AppCode.ORDER_NOT_EXIST狀態(tài)碼的響應，并且?guī)袭惓Ｔ敿毿畔⒂唵翁柌淮嬖冢簒xxx。后端小哥開發(fā)有效率，前端妹妹獲取到2003狀態(tài)碼，調(diào)用對應警告彈窗，title寫上訂單不存在，body詳細信息記載"訂單號不存在：1998"。同時日志還自動打上去了！666！老哥們?nèi)B點個贊！推薦閱讀：
互聯(lián)網(wǎng)初中高級大廠面試題(9個G) 內(nèi)容包含Java基礎、JavaWeb、MySQL性能優(yōu)化、JVM、鎖、百萬并發(fā)、消息隊列、高性能緩存、反射、Spring全家桶原理、微服務、Zookeeper......等技術(shù)棧！
?戳閱讀原文領(lǐng)??！ 朕已閱
