如何優(yōu)雅的寫 Controller 層代碼？
點擊上方“碼農(nóng)突圍”，馬上關(guān)注 這里是碼農(nóng)充電第一站，回復(fù)“666”，獲取一份專屬大禮包 真愛，請設(shè)置“星標(biāo)”或點個“在看”
來源：http://suo.nz/1KaLX0
前言
Controller 層參數(shù)接收
統(tǒng)一狀態(tài)碼
統(tǒng)一校驗
統(tǒng)一響應(yīng)
統(tǒng)一異常
前言
本篇主要要介紹的就是 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ù)邏輯時拋出了異常又該如何處理
Controller 層參數(shù)接收（太基礎(chǔ)了，可以跳過）
@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 就會吧這個類當(dāng)成 controller 進(jìn)行處理，然后把所有返回的參數(shù)放到 ResponseBody 中。
@RequestMapping：請求的前綴，也就是所有該 Controller 下的請求都需要加上 /product/product-info 的前綴。
@GetMapping("/findById")：標(biāo)志這是一個 get 請求，并且需要通過 /findById 地址才可以訪問到。
@PostMapping("/page")：同理，表示是個 post 請求。
size : 1
current : 1
productId : 1
productName : 泡腳
統(tǒng)一狀態(tài)碼
| 返回格式
為了跟前端妹妹打好關(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 就是成功的意思。
{
"productId": 1,
"productName": "泡腳",
"productPrice": 100.00,
"productDescription": "中藥泡腳加按摩",
"productStatus": 0,
}
{
"code": 1000,
"msg": "請求成功",
"data": {
"productId": 1,
"productName": "泡腳",
"productPrice": 100.00,
"productDescription": "中藥泡腳加按摩",
"productStatus": 0,
}
}
| 封裝 ResultVo
這些狀態(tài)碼肯定都是要預(yù)先編好的，怎么編呢？寫個常量 1000？還是直接寫死 1000？
要這么寫就真的書白讀的了，寫狀態(tài)碼當(dāng)然是用枚舉拉：
public interface StatusCode {
public int getCode();
public String getMsg();
}
@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;
}
}
@Data
public class ResultVo {
// 狀態(tài)碼
private int code;
// 狀態(tài)信息
private String msg;
// 返回對象
private Object data;
// 手動設(shè)置返回vo
public ResultVo(int code, String msg, Object data) {
this.code = code;
this.msg = msg;
this.data = data;
}
// 默認(rèn)返回成功狀態(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;
}
}
@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)一校驗
| 原始做法
@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("商品價格不能為負(fù)數(shù)");
}
...
ProductInfo productInfo = new ProductInfo();
BeanUtils.copyProperties(vo, productInfo);
return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
}
這 if 寫的人都傻了，能忍嗎？肯定不能忍啊。
| @Validated 參數(shù)校驗
@Data
public class ProductInfoVo {
@NotNull(message = "商品名稱不允許為空")
private String productName;
@Min(value = 0, message = "商品價格不允許為負(fù)數(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": "商品價格不允許為負(fù)數(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 [商品價格不允許為負(fù)數(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ī)?商品價格不允許為負(fù)數(shù)"的信息。
但是你要是這樣返回給前端，前端妹妹就提刀過來了，當(dāng)年約定好的狀態(tài)碼，你個負(fù)心人說忘就忘？
用戶體驗小于等于 0 啊！所以我們要進(jìn)行優(yōu)化一下，每次出現(xiàn)異常的時候，自動把狀態(tài)碼寫好，不負(fù)妹妹之約！
| 優(yōu)化異常處理
Resolved [org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors
玩你個頭啊完美，這么呆瓜的操作 springboot 不知道嗎？spring mvc 當(dāng)然知道拉，所以給我們提供了一個 @RestControllerAdvice 來增強(qiáng)所有 @RestController，然后使用 @ExceptionHandler 注解，就可以攔截到對應(yīng)的異常。
這里我們就攔截 BindException.class 就好了。最后在返回之前，我們對異常信息進(jìn)行包裝一下，包裝成 ResultVo，當(dāng)然要跟上 ResultCode.VALIDATE_ERROR 的異常狀態(tài)碼。
@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());
}
}
{
"code": 1002,
"msg": "參數(shù)校驗失敗",
"data": "商品價格不允許為負(fù)數(shù)"
}
統(tǒng)一響應(yīng)
| 統(tǒng)一包裝響應(yīng)
return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
開發(fā)小哥肯定不樂意了，誰有空天天寫 new ResultVo(data) 啊，我就想返回一個實體！怎么實現(xiàn)我不管！
@RestControllerAdvice(basePackages = {"com.bugpool.leilema"})
public class ControllerResponseAdvice implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
// response是ResultVo類型，或者注釋了NotControllerResponseAdvice都不進(jìn)行包裝
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串進(jìn)行返回
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 時進(jìn)行統(tǒng)一處理。
②重寫 supports 方法，也就是說，當(dāng)返回類型已經(jīng)是 ResultVo 了，那就不需要封裝了，當(dāng)不等與 ResultVo 時才進(jìn)行調(diào)用 beforeBodyWrite 方法，跟過濾器的效果是一樣的。
③最后重寫我們的封裝方法 beforeBodyWrite，注意除了 String 的返回值有點特殊，無法直接封裝成 json，我們需要進(jìn)行特殊處理，其他的直接 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));
}
{
"code": 1000,
"msg": "請求成功",
"data": {
"productId": 1,
"productName": "泡腳",
"productPrice": 100.00,
"productDescription": "中藥泡腳加按摩",
"productStatus": 0,
...
}
}
| NOT 統(tǒng)一響應(yīng)
不開啟統(tǒng)一響應(yī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ù)讀機(jī)。一旦發(fā)送的請求沒響應(yīng)，就會給負(fù)責(zé)人發(fā)信息（企業(yè)微信或者短信之類的），你的系統(tǒng)死啦！趕緊回來排查 bug 吧！
{
"code": 1000,
"msg": "請求成功",
"data": "success"
}
人家要的返回只要一個 success，人家定的標(biāo)準(zhǔn)不可能因為你一個系統(tǒng)改。俗話說的好，如果你改變不了環(huán)境，那你就只能我****
新增不進(jìn)行封裝注解：因為百分之 99 的請求還是需要包裝的，只有個別不需要，寫在包裝的過濾器吧？又不是很好維護(hù)，那就加個注解好了。所有不需要包裝的就加上這個注解。
@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都不進(jìn)行包裝
return !(methodParameter.getParameterType().isAssignableFrom(ResultVo.class)
|| methodParameter.hasMethodAnnotation(NotControllerResponseAdvice.class));
}
...
@RestController
public class HealthController {
@GetMapping("/health")
@NotControllerResponseAdvice
public String health() {
return "success";
}
}
統(tǒng)一異常
每個系統(tǒng)都會有自己的業(yè)務(wù)異常，比如庫存不能小于 0 子類的，這種異常并非程序異常，而是業(yè)務(wù)操作引發(fā)的異常，我們也需要進(jìn)行規(guī)范的編排業(yè)務(wù)異常狀態(tài)碼，并且寫一個專門處理的異常類，最后通過剛剛學(xué)習(xí)過的異常攔截統(tǒng)一進(jìn)行處理，以及打日志。
@Getter
public enum AppCode implements StatusCode {
APP_ERROR(2000, "業(yè)務(wù)異常"),
PRICE_ERROR(2001, "價格異常");
private int code;
private String msg;
AppCode(int code, String msg) {
this.code = code;
this.msg = msg;
}
}
@Getter
public class APIException extends RuntimeException {
private int code;
private String msg;
// 手動設(shè)置異常
public APIException(StatusCode statusCode, String message) {
// message用于用戶設(shè)置拋出錯誤詳情，例如：當(dāng)前價格-5，小于0
super(message);
// 狀態(tài)碼
this.code = statusCode.getCode();
// 狀態(tài)碼配套的msg
this.msg = statusCode.getMsg();
}
// 默認(rèn)異常使用APP_ERROR狀態(tài)碼
public APIException(String message) {
super(message);
this.code = AppCode.APP_ERROR.getCode();
this.msg = AppCode.APP_ERROR.getMsg();
}
}
@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"
}
后端小哥開發(fā)有效率，前端妹妹獲取到 2003 狀態(tài)碼，調(diào)用對應(yīng)警告彈窗，title 寫上訂單不存在，body 詳細(xì)信息記載"訂單號不存在：1998"。同時日志還自動打上去了！666！老哥們?nèi)B點個贊！
（完）
碼農(nóng)突圍資料鏈接
1、臥槽！字節(jié)跳動《算法中文手冊》火了，完整版 PDF 開放下載！
2、計算機(jī)基礎(chǔ)知識總結(jié)與操作系統(tǒng) PDF 下載
3、艾瑪，終于來了！《LeetCode Java版題解》.PDF
4、Github 10K+，《LeetCode刷題C/C++版答案》出爐.PDF歡迎添加魚哥個人微信：smartfish2020，進(jìn)粉絲群或圍觀朋友圈。
評論
圖片
表情