• 如何优雅的写 Controller 层代码？

    目录

    • 前言

    • Controller 层参数接收

    • 统一状态码

    • 统一校验

    • 统一响应

    • 统一异常

    前言

    本篇主要要介绍的就是 controller 层的处理，一个完整的后端请求由 4 部分组成：

    • 接口地址（也就是 URL 地址）

    • 请求方式（一般就是 get、set，当然还有 put、delete）

    • 请求数据（request，有 head 跟 body）

    • 响应数据（response）

    本篇将解决以下 3 个问题：

    • 当接收到请求时，如何优雅的校验参数

    • 返回响应数据该如何统一的进行处理

    • 接收到请求，处理业务逻辑时抛出了异常又该如何处理

    Controller 层参数接收（太基础了，可以跳过）

    常见的请求就分为 get 跟 post 两种：

    1. @RestController
    2. @RequestMapping("/product/product-info")
    3. public class ProductInfoController {
    4.  
    5.     @Autowired
    6.     ProductInfoService productInfoService;
    7.  
    8.     @GetMapping("/findById")
    9.     public ProductInfoQueryVo findById(Integer id) {
    10.         ...
    11.     }
    12.  
    13.     @PostMapping("/page")
    14.     public IPage findPage(Page page, ProductInfoQueryVo vo) {
    15.         ...
    16.     }
    17. }

    RestController：之前解释过，@RestController=@Controller+ResponseBody。

    加上这个注解，springboot 就会吧这个类当成 controller 进行处理，然后把所有返回的参数放到 ResponseBody 中。

    @RequestMapping：请求的前缀，也就是所有该 Controller 下的请求都需要加上 /product/product-info 的前缀。

    @GetMapping("/findById")：标志这是一个 get 请求，并且需要通过 /findById 地址才可以访问到。

    @PostMapping("/page")：同理，表示是个 post 请求。

    参数：至于参数部分，只需要写上 ProductInfoQueryVo，前端过来的 json 请求便会通过映射赋值到对应的对象中，例如请求这么写，productId 就会自动被映射到 vo 对应的属性当中。

    1. size : 1
    2. current : 1
    3.  
    4. productId : 1
    5. productName : 泡脚

    统一状态码

    | 返回格式

    为了跟前端妹妹打好关系，我们通常需要对后端返回的数据进行包装一下，增加一下状态码，状态信息，这样前端妹妹接收到数据就可以根据不同的状态码，判断响应数据状态，是否成功是否异常进行不同的显示。

    当然这让你拥有了更多跟前端妹妹的交流机会，假设我们约定了 1000 就是成功的意思。

    如果你不封装，那么返回的数据是这样子的：

    1. {
    2.   "productId": 1,
    3.   "productName": "泡脚",
    4.   "productPrice": 100.00,
    5.   "productDescription": "中药泡脚加按摩",
    6.   "productStatus": 0,
    7. }

    经过封装以后时这样子的：

    1. {
    2.   "code": 1000,
    3.   "msg": "请求成功",
    4.   "data": {
    5.     "productId": 1,
    6.     "productName": "泡脚",
    7.     "productPrice": 100.00,
    8.     "productDescription": "中药泡脚加按摩",
    9.     "productStatus": 0,
    10.   }
    11. }

    | 封装 ResultVo

    这些状态码肯定都是要预先编好的，怎么编呢？写个常量 1000？还是直接写死 1000？

    要这么写就真的书白读的了，写状态码当然是用枚举拉：

    ①首先先定义一个状态码的接口，所有状态码都需要实现它，有了标准才好做事：

    1. public interface StatusCode {
    2.     public int getCode();
    3.     public String getMsg();
    4. }

    ②然后去找前端妹妹，跟他约定好状态码（这可能是你们唯一的约定了）枚举类嘛，当然不能有 setter 方法了，因此我们不能在用 @Data 注解了，我们要用 @Getter。

    1. @Getter
    2. public enum ResultCode implements StatusCode{
    3.     SUCCESS(1000, "请求成功"),
    4.     FAILED(1001, "请求失败"),
    5.     VALIDATE_ERROR(1002, "参数校验失败"),
    6.     RESPONSE_PACK_ERROR(1003, "response返回包装失败");
    7.  
    8.     private int code;
    9.     private String msg;
    10.  
    11.     ResultCode(int code, String msg) {
    12.         this.code = code;
    13.         this.msg = msg;
    14.     }
    15. }

    ③写好枚举类，就开始写 ResultVo 包装类了，我们预设了几种默认的方法，比如成功的话就默认传入 object 就可以了，我们自动包装成 success。

    1. @Data
    2. public class ResultVo {
    3.     // 状态码
    4.     private int code;
    5.  
    6.     // 状态信息
    7.     private String msg;
    8.  
    9.     // 返回对象
    10.     private Object data;
    11.  
    12.     // 手动设置返回vo
    13.     public ResultVo(int code, String msg, Object data) {
    14.         this.code = code;
    15.         this.msg = msg;
    16.         this.data = data;
    17.     }
    18.  
    19.     // 默认返回成功状态码，数据对象
    20.     public ResultVo(Object data) {
    21.         this.code = ResultCode.SUCCESS.getCode();
    22.         this.msg = ResultCode.SUCCESS.getMsg();
    23.         this.data = data;
    24.     }
    25.  
    26.     // 返回指定状态码，数据对象
    27.     public ResultVo(StatusCode statusCode, Object data) {
    28.         this.code = statusCode.getCode();
    29.         this.msg = statusCode.getMsg();
    30.         this.data = data;
    31.     }
    32.  
    33.     // 只返回状态码
    34.     public ResultVo(StatusCode statusCode) {
    35.         this.code = statusCode.getCode();
    36.         this.msg = statusCode.getMsg();
    37.         this.data = null;
    38.     }
    39. }

    使用，现在的返回肯定就不是 return data；这么简单了，而是需要 new ResultVo(data)；

    1.     @PostMapping("/findByVo")
    2.     public ResultVo findByVo(@Validated ProductInfoVo vo) {
    3.         ProductInfo productInfo = new ProductInfo();
    4.         BeanUtils.copyProperties(vo, productInfo);
    5.         return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
    6.     }

    最后返回就会是上面带了状态码的数据了。

    统一校验

    | 原始做法

    假设有一个添加 ProductInfo 的接口，在没有统一校验时，我们需要这么做。

    1. @Data
    2. public class ProductInfoVo {
    3.     // 商品名称
    4.     private String productName;
    5.     // 商品价格
    6.     private BigDecimal productPrice;
    7.     // 上架状态
    8.     private Integer productStatus;
    9. }

    1.     @PostMapping("/findByVo")
    2.     public ProductInfo findByVo(ProductInfoVo vo) {
    3.         if (StringUtils.isNotBlank(vo.getProductName())) {
    4.             throw new APIException("商品名称不能为空");
    5.         }
    6.         if (null != vo.getProductPrice() && vo.getProductPrice().compareTo(new BigDecimal(0)) < 0) {
    7.             throw new APIException("商品价格不能为负数");
    8.         }
    9.         ...
    10.  
    11.         ProductInfo productInfo = new ProductInfo();
    12.         BeanUtils.copyProperties(vo, productInfo);
    13.         return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
    14.     }

    这 if 写的人都傻了，能忍吗？肯定不能忍啊。

    | @Validated 参数校验

    好在有 @Validated，又是一个校验参数必备良药了。有了 @Validated 我们只需要再 vo 上面加一点小小的注解，便可以完成校验功能。

    1. @Data
    2. public class ProductInfoVo {
    3.     @NotNull(message = "商品名称不允许为空")
    4.     private String productName;
    5.  
    6.     @Min(value = 0, message = "商品价格不允许为负数")
    7.     private BigDecimal productPrice;
    8.  
    9.     private Integer productStatus;
    10. }

    1.     @PostMapping("/findByVo")
    2.     public ProductInfo findByVo(@Validated ProductInfoVo vo) {
    3.         ProductInfo productInfo = new ProductInfo();
    4.         BeanUtils.copyProperties(vo, productInfo);
    5.         return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
    6.     }

    运行看看，如果参数不对会发生什么？

    我们故意传一个价格为 -1 的参数过去：

    1. productName : 泡脚
    2. productPrice : -1
    3. productStatus : 1

    1. {
    2.   "timestamp": "2020-04-19T03:06:37.268+0000",
    3.   "status": 400,
    4.   "error": "Bad Request",
    5.   "errors": [
    6.     {
    7.       "codes": [
    8.         "Min.productInfoVo.productPrice",
    9.         "Min.productPrice",
    10.         "Min.java.math.BigDecimal",
    11.         "Min"
    12.       ],
    13.       "arguments": [
    14.         {
    15.           "codes": [
    16.             "productInfoVo.productPrice",
    17.             "productPrice"
    18.           ],
    19.           "defaultMessage": "productPrice",
    20.           "code": "productPrice"
    21.         },
    22.         0
    23.       ],
    24.       "defaultMessage": "商品价格不允许为负数",
    25.       "objectName": "productInfoVo",
    26.       "field": "productPrice",
    27.       "rejectedValue": -1,
    28.       "bindingFailure": false,
    29.       "code": "Min"
    30.     }
    31.   ],
    32.   "message": "Validation failed for object\u003d\u0027productInfoVo\u0027. Error count: 1",
    33.   "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",
    34.   "path": "/leilema/product/product-info/findByVo"
    35. }

    大功告成了吗？虽然成功校验了参数，也返回了异常，并且带上"商品价格不允许为负数"的信息。

    但是你要是这样返回给前端，前端妹妹就提刀过来了，当年约定好的状态码，你个负心人说忘就忘？

    用户体验小于等于 0 啊！所以我们要进行优化一下，每次出现异常的时候，自动把状态码写好，不负妹妹之约！

    | 优化异常处理

    首先我们先看看校验参数抛出了什么异常：

    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 的状态码，就会调用数据校验异常的弹窗提示用户哪里没填好。

    1. @RestControllerAdvice
    2. public class ControllerExceptionAdvice {
    3.  
    4.     @ExceptionHandler({BindException.class})
    5.     public ResultVo MethodArgumentNotValidExceptionHandler(BindException e) {
    6.         // 从异常对象中拿到ObjectError对象
    7.         ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
    8.         return new ResultVo(ResultCode.VALIDATE_ERROR, objectError.getDefaultMessage());
    9.     }
    10. }

    来看看效果，完美。1002 与前端妹妹约定好的状态码：

    1. {
    2.   "code": 1002,
    3.   "msg": "参数校验失败",
    4.   "data": "商品价格不允许为负数"
    5. }

    统一响应

    | 统一包装响应

    再回头看一下 controller 层的返回：

    return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));

    开发小哥肯定不乐意了，谁有空天天写 new ResultVo(data) 啊，我就想返回一个实体！怎么实现我不管！

    好把，那就是 AOP 拦截所有 Controller，再 @After 的时候统一帮你封装一下咯。

    怕是上一次脸打的不够疼，springboot 能不知道这么个操作吗？

    1. @RestControllerAdvice(basePackages = {"com.bugpool.leilema"})
    2. public class ControllerResponseAdvice implements ResponseBodyAdvice<Object> {
    3.     @Override
    4.     public boolean supports(MethodParameter methodParameter, Classextends HttpMessageConverter> aClass) {
    5.         // response是ResultVo类型，或者注释了NotControllerResponseAdvice都不进行包装
    6.         return !methodParameter.getParameterType().isAssignableFrom(ResultVo.class);
    7.     }
    8.  
    9.     @Override
    10.     public Object beforeBodyWrite(Object data, MethodParameter returnType, MediaType mediaType, Classextends HttpMessageConverter> aClass, ServerHttpRequest request, ServerHttpResponse response) {
    11.         // String类型不能直接包装
    12.         if (returnType.getGenericParameterType().equals(String.class)) {
    13.             ObjectMapper objectMapper = new ObjectMapper();
    14.             try {
    15.                 // 将数据包装在ResultVo里后转换为json串进行返回
    16.                 return objectMapper.writeValueAsString(new ResultVo(data));
    17.             } catch (JsonProcessingException e) {
    18.                 throw new APIException(ResultCode.RESPONSE_PACK_ERROR, e.getMessage());
    19.             }
    20.         }
    21.         // 否则直接包装成ResultVo返回
    22.         return new ResultVo(data);
    23.     }
    24. }

    ①@RestControllerAdvice(basePackages = {"com.bugpool.leilema"}) 自动扫描了所有指定包下的 controller，在 Response 时进行统一处理。

    ②重写 supports 方法，也就是说，当返回类型已经是 ResultVo 了，那就不需要封装了，当不等与 ResultVo 时才进行调用 beforeBodyWrite 方法，跟过滤器的效果是一样的。

    ③最后重写我们的封装方法 beforeBodyWrite，注意除了 String 的返回值有点特殊，无法直接封装成 json，我们需要进行特殊处理，其他的直接 new ResultVo(data); 就 ok 了。

    打完收工，看看效果：

    1.     @PostMapping("/findByVo")
    2.     public ProductInfo findByVo(@Validated ProductInfoVo vo) {
    3.         ProductInfo productInfo = new ProductInfo();
    4.         BeanUtils.copyProperties(vo, productInfo);
    5.         return productInfoService.getOne(new QueryWrapper(productInfo));
    6.     }

    此时就算我们返回的是 po，接收到的返回就是标准格式了，开发小哥露出了欣慰的笑容。

    1. {
    2.   "code": 1000,
    3.   "msg": "请求成功",
    4.   "data": {
    5.     "productId": 1,
    6.     "productName": "泡脚",
    7.     "productPrice": 100.00,
    8.     "productDescription": "中药泡脚加按摩",
    9.     "productStatus": 0,
    10.     ...
    11.   }
    12. }

    | NOT 统一响应

    不开启统一响应原因：开发小哥是开心了，可是其他系统就不开心了。举个例子：我们项目中集成了一个健康检测的功能，也就是这货。

    1. @RestController
    2. public class HealthController {
    3.     @GetMapping("/health")
    4.     public String health() {
    5.         return "success";
    6.     }
    7. }

    公司部署了一套校验所有系统存活状态的工具，这工具就定时发送 get 请求给我们系统：

    “兄弟，你死了吗？”
    “我没死，滚”
    “兄弟，你死了吗？”
    “我没死，滚”

    是的，web 项目的本质就是复读机。一旦发送的请求没响应，就会给负责人发信息（企业微信或者短信之类的），你的系统死啦！赶紧回来排查 bug 吧！

    让大家感受一下。每次看到我都射射发抖，早上 6 点！我 tm！！！！！

    好吧，没办法，人家是老大，人家要的返回不是：

    1. {
    2.   "code": 1000,
    3.   "msg": "请求成功",
    4.   "data": "success"
    5. }

    人家要的返回只要一个 success，人家定的标准不可能因为你一个系统改。俗话说的好，如果你改变不了环境，那你就只能我****

    新增不进行封装注解：因为百分之 99 的请求还是需要包装的，只有个别不需要，写在包装的过滤器吧？又不是很好维护，那就加个注解好了。所有不需要包装的就加上这个注解。

    1. @Target({ElementType.METHOD})
    2. @Retention(RetentionPolicy.RUNTIME)
    3. public @interface NotControllerResponseAdvice {
    4. }

    然后在我们的增强过滤方法上过滤包含这个注解的方法：

    1. @RestControllerAdvice(basePackages = {"com.bugpool.leilema"})
    2. public class ControllerResponseAdvice implements ResponseBodyAdvice<Object> {
    3.     @Override
    4.     public boolean supports(MethodParameter methodParameter, Classextends HttpMessageConverter> aClass) {
    5.         // response是ResultVo类型，或者注释了NotControllerResponseAdvice都不进行包装
    6.         return !(methodParameter.getParameterType().isAssignableFrom(ResultVo.class)
    7.                 || methodParameter.hasMethodAnnotation(NotControllerResponseAdvice.class));
    8.     }
    9.     ...

    最后就在不需要包装的方法上加上注解：

    1. @RestController
    2. public class HealthController {
    3.  
    4.     @GetMapping("/health")
    5.     @NotControllerResponseAdvice
    6.     public String health() {
    7.         return "success";
    8.     }
    9. }

    这时候就不会自动封装了，而其他没加注解的则依旧自动包装：

    统一异常

    每个系统都会有自己的业务异常，比如库存不能小于 0 子类的，这种异常并非程序异常，而是业务操作引发的异常，我们也需要进行规范的编排业务异常状态码，并且写一个专门处理的异常类，最后通过刚刚学习过的异常拦截统一进行处理，以及打日志。

    ①异常状态码枚举，既然是状态码，那就肯定要实现我们的标准接口 StatusCode。

    1. @Getter
    2. public enum  AppCode implements StatusCode {
    3.  
    4.     APP_ERROR(2000, "业务异常"),
    5.     PRICE_ERROR(2001, "价格异常");
    6.  
    7.     private int code;
    8.     private String msg;
    9.  
    10.     AppCode(int code, String msg) {
    11.         this.code = code;
    12.         this.msg = msg;
    13.     }
    14. }

    ②异常类，这里需要强调一下，code 代表 AppCode 的异常状态码，也就是 2000；msg 代表业务异常，这只是一个大类，一般前端会放到弹窗 title 上；最后 super(message); 这才是抛出的详细信息，在前端显示在弹窗体中，在 ResultVo 则保存在 data 中。

    1. @Getter
    2. public class APIException extends RuntimeException {
    3.     private int code;
    4.     private String msg;
    5.  
    6.     // 手动设置异常
    7.     public APIException(StatusCode statusCode, String message) {
    8.         // message用于用户设置抛出错误详情，例如：当前价格-5，小于0
    9.         super(message);
    10.         // 状态码
    11.         this.code = statusCode.getCode();
    12.         // 状态码配套的msg
    13.         this.msg = statusCode.getMsg();
    14.     }
    15.  
    16.     // 默认异常使用APP_ERROR状态码
    17.     public APIException(String message) {
    18.         super(message);
    19.         this.code = AppCode.APP_ERROR.getCode();
    20.         this.msg = AppCode.APP_ERROR.getMsg();
    21.     }
    22.  
    23. }

    ③最后进行统一异常的拦截，这样无论在 service 层还是 controller 层，开发人员只管抛出 API 异常，不需要关系怎么返回给前端，更不需要关心日志的打印。

    1. @RestControllerAdvice
    2. public class ControllerExceptionAdvice {
    3.  
    4.     @ExceptionHandler({BindException.class})
    5.     public ResultVo MethodArgumentNotValidExceptionHandler(BindException e) {
    6.         // 从异常对象中拿到ObjectError对象
    7.         ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
    8.         return new ResultVo(ResultCode.VALIDATE_ERROR, objectError.getDefaultMessage());
    9.     }
    10.  
    11.     @ExceptionHandler(APIException.class)
    12.     public ResultVo APIExceptionHandler(APIException e) {
    13.         // log.error(e.getMessage(), e); 由于还没集成日志框架，暂且放着，写上TODO
    14.         return new ResultVo(e.getCode(), e.getMsg(), e.getMessage());
    15.     }
    16. }

    ④最后使用，我们的代码只需要这么写。

    1.         if (null == orderMaster) {
    2.             throw new APIException(AppCode.ORDER_NOT_EXIST, "订单号不存在：" + orderId);
    3.         }

    1. {
    2.   "code": 2003,
    3.   "msg": "订单不存在",
    4.   "data": "订单号不存在：1998"
    5. }

    就会自动抛出 AppCode.ORDER_NOT_EXIST 状态码的响应，并且带上异常详细信息订单号不存在：xxxx。

    后端小哥开发有效率，前端妹妹获取到 2003 状态码，调用对应警告弹窗，title 写上订单不存在，body 详细信息记载"订单号不存在：1998"。同时日志还自动打上去了。

  • 相关阅读:
    2023-10-25 精神分析-领悟新技术的错误做法-持续数年的错误做法-记录与分析
    用AI把你的故事变成歌曲，创作一首只属于你的歌
    盘点30个Python树莓派源码Python爱好者不容错过
    Excel 数据透视表教程大全之 06 数据透视表八大优势，辅助列用途
    跟羽夏去实现协程
    代码随想录图论 第二天 | 695. 岛屿的最大面积 1020. 飞地的数量
    北斗导航 | RTCM 3.3学习（10403.3）
    数据结构第二课 -----线性表之顺序表
    pandas notes 25
    详解eval
  • 原文地址：https://blog.csdn.net/weixin_72753070/article/details/126034874