• 聚合统一，SpringBoot实现全局响应和全局异常处理

    目录

    前言

    全局响应

    数据规范

    状态码(错误码)

    全局响应类

    使用

    优化

    全局异常处理

    为什么需要全局异常处理

    业务异常类

    全局捕获

    使用

    优化

    总结

    前言

            在悦享校园1.0版本中的数据返回采用了以Map对象返回的方式，虽然较为便捷但也带来一些问题。一是在Controller中所有方法均需要实例化一个Map对象。二是当返回数据较多时使用put方式添加信息会容易出现遗漏的问题。在异常处理方面，虽然该版本中对所有异常通过继承RuntimeException的方式来进行封装，但业务异常较多时这一操作就显得冗余，且需要使用上述提到的Map对象包装异常信息。对于以上问题在2.0版本中通过结合SpringBoot来进行优雅的解决。

    全局响应

    数据规范

    一般来讲我们提供给前端接口调用的返回值为如下的JSON格式，其包含结果状态，状态码，响应信息和响应数据。通常会使用@ResponseBody注解配合一个响应类来实现这一功能。但需要注意的是，当方法返回值为String类型时，@ResponseBody注解并不会将其转为JSON格式，需要手动进行转换。

    1. {
    2.     "success": true,
    3.     "code": 0,
    4.     "message": "操作成功",
    5.     "data": "Hello"
    6. }

    状态码(错误码)

    通过第一步数据规范可知，当接口被调用后会返回对应信息，若调用成功时返回固定的状态码即可，但调用失败时则需要不同的状态码来标识。为解决这个问题这里使用枚举的方式来定义出现异常时的错误信息。(此处的枚举对象名称可以自定义)

     块的错误。(此处的枚举对象名称可以自定义)

    1. @AllArgsConstructor
    2. @Getter
    3. public enum ExceptionCodeEnum {
    4.     // 操作成功
    5.     EC0(0,"操作成功"),
    6.     // 通用模块错误
    7.     EC10000(10000,"系统内部错误"),
    8.     EC10001(10001,"参数错误"),
    9.     EC10002(10002,"资源不存在"),
    10.     
    11.     // 用户模块错误
    12.     EC20000(20000,"用户名已被占用"),
    13.     EC20001(20001,"用户不存在"),
    14.     EC20002(20002,"用户名或密码错误"),
    15.     
    16.     // 其它模块....
    17.  
    18.     /**
    19.      * 异常代码
    20.      */
    21.     private Integer code;
    22.     /**
    23.      * 描述信息
    24.      */
    25.     private String message;
    26. }

    全局响应类

    此处创建一个泛型类来实现全局返回信息的格式统一，并且提供返回结果不同状态下的构造方法。

    1. @Data
    2. @Builder
    3. @AllArgsConstructor
    4. public class ResultDataVO {
    5.     /**
    6.      * 调用结果状态
    7.      */
    8.     private Boolean success;
    9.     /**
    10.      * 响应代码
    11.      */
    12.     private Integer code;
    13.     /**
    14.      * 详细信息
    15.      */
    16.     private String message;
    17.     /**
    18.      * 返回数据,数据为空则不返回
    19.      */
    20.     @JsonInclude(JsonInclude.Include.NON_NULL)
    21.     private T data;
    22.  
    23.  
    24.     /**
    25.      * 操作成功时返回的数据
    26.      * @param result
    27.      * @param 
    28.      * @return
    29.      */
    30.     public static  ResultDataVO success(T result) {
    31.  
    32.         return ResultDataVO.builder()
    33.                 .success(true)
    34.                 .code(ExceptionCodeEnum.EC0.getCode())
    35.                 .message(ExceptionCodeEnum.EC0.getMessage())
    36.                 .data(result)
    37.                 .build();
    38.     }
    39.  
    40.     /**
    41.      * 操作失败
    42.      * @param 
    43.      * @param exceptionCodeEnum 错误类型枚举
    44.      * @return
    45.      */
    46.     public static  ResultDataVO failure(ExceptionCodeEnum exceptionCodeEnum){
    47.  
    48.         return ResultDataVO.builder()
    49.                 .success(false)
    50.                 .code(exceptionCodeEnum.getCode())
    51.                 .message(exceptionCodeEnum.getMessage())
    52.                 .data(null)
    53.                 .build();
    54.     }
    55.  
    56.     /**
    57.      * 操作失败,返回信息
    58.      * @param exceptionCodeEnum 错误信息列表
    59.      * @param result 对应失败信息对象
    60.      * @param 
    61.      * @return
    62.      */
    63.     public static  ResultDataVO failure(ExceptionCodeEnum exceptionCodeEnum, T result){
    64.  
    65.         return ResultDataVO.builder()
    66.                 .success(false)
    67.                 .code(exceptionCodeEnum.getCode())
    68.                 .message(exceptionCodeEnum.getMessage())
    69.                 .data(result)
    70.                 .build();
    71.     }
    72. }

    使用

    通过以上操作已经实现了一个基础的全局数据响应处理，可以通过如下方式来使用。

    1. @GetMapping("/{id}")
    2.     public ResultDataVO getMsg(@RequestParam(required = false) String name,
    3.                                @Max(value = 10,message = "最大值不能超过10")
    4.                                @PathVariable(name = "id") int uid) {
    5.         String result = "Hello,"+name+" id "+uid;
    6.  
    7.         return ResultDataVO.success(result);
    8.     }

    优化

    虽然到这里我们已经基本实现了全局响应，但如果不想要在每个方法中调用ResultDataVO的success方法，可以通过如下方式解决。这里新建处理类实现了ResponseBodyAdvice接口，该接口包含三个方法，supports、beforeBodyWrite、handleEmptyBody。

    supports用于指明方法是否需要对进入的方法进行后续包装处理，默认返回true，即对所有方法处理。

    beforeBodyWrite用于在控制器方法返回结果后，但在响应体写入之前调用。可以在此方法中修改body对象，如包装、添加元数据等。在该方法中将使用ResultDataVO的success方法进行包装，由此将可以省去在Controller方法中重复调用success方法。

    handleEmptyBody用于处理null值，由于ResultDataVO类中已经对null值进行了处理，因此无需重写该方法。

    注意：即使在全异处理添加了@RestControllerAdvice注解后，仍需要在Controller类上添加@ResponseBody注解，或者直接使用@RestController注解。因为方法返回值经过invokeAndHandle处理后已经确定，若没有以上注解则默认会按照String类型进行路径映射查找视图，进而返回404错误，而@RestControllerAdvice的相关方法会在invokeAndHandle处理后再进行调用。

    1. @RestControllerAdvice
    2. @Slf4j
    3. public class GlobalExceptionAdvice implements ResponseBodyAdvice {
    4.  
    5.  
    6.     /**
    7.      * json格式化操作
    8.      */
    9.     @Resource
    10.     private ObjectMapper objectMapper;
    11.  
    12.     /**
    13.     * 是否开启对所有方法的处理，可以在此方法中添加条件使其支持对特定方法的处理。
    14.     */
    15.     @Override
    16.     public boolean supports(MethodParameter returnType, Class> converterType) {
    17.         return true;
    18.     }
    19.     
    20.     /**
    21.     * 用于在控制器方法返回结果后，但在响应体写入之前调用。可以此处对数据进行包装等操作
    22.     */
    23.     @SneakyThrows
    24.     @Override
    25.     public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
    26.         /**
    27.          * 未被捕获的错误进行拦截
    28.          */
    29.         if(body == null){
    30.             log.error("未处理的异常信息,请检查错误日志");
    31.             return ResultDataVO.failure(ExceptionCodeEnum.EC10000);
    32.         }
    33.  
    34.         /**
    35.          * 返回类型为String则需要手动序列化
    36.          */
    37.         if (body instanceof String) {
    38.             return objectMapper.writeValueAsString(ResultDataVO.success(body));
    39.         }
    40.         /**
    41.          * 已被包装为全局VO对象直接返回
    42.          */
    43.         if (body instanceof ResultDataVO) {
    44.             return body;
    45.         }
    46.         /**
    47.          * 判断是否为404,500等错误类型
    48.          */
    49.         if (body instanceof LinkedHashMap) {
    50.             LinkedHashMap httpErrorCode = (LinkedHashMap) body;
    51.             Integer code = (Integer) httpErrorCode.get("status");
    52.             String message = (String) httpErrorCode.get("error");
    53.             return new ResultDataVO(false, code, message, null);
    54.  
    55.         }
    56.  
    57.         return ResultDataVO.success(body);
    58.     }
    59. }
      60.  

      全局异常处理
       

      为什么需要全局异常处理
       

       
 
      使用全局异常处理更加灵活和规范化， 所有错误信息会被封装后返回给前端，避免暴露业务细节。
       

       

      业务异常类
       

      由于代码在运行过程中会出现异常，通常我们会使用 try...catch 方式来捕获并处理，在此之后我们需要返回错误信息知调用者当前状况。由于我们处理的异常多为RuntimeException的子类，因此可以通过编写一个业务异常类来实现总的异常信息处理，与以往不同在这里并不会为所有的业务异常创建具体的异常类，将使用前文中的错误码来配合使用。
       

      1. @Getter
      2. public class BusinessException extends RuntimeException {
      3.  
      4.     /**
      5.      * 错误对象枚举
      6.      */
      7.     private ExceptionCodeEnum codeEnum;
      8.     /**
      9.      * 根据传入的异常枚举解析异常相关信息。
      10.      * @param codeEnum
      11.      */
      12.     public BusinessException(ExceptionCodeEnum codeEnum){
      13.         this.codeEnum = codeEnum;
      14.     }
      15. }
       

      全局捕获
       

      由于已经定义了总的异常处理类，因此在使用时只需要通过抛出 BusinessException 对象即可。但我们需要在代码中写入大量的try-catch语句来捕获处理异常。并且对于错误信息的返回需要符合在全局响应中的数据规范，也就是说需要像全局响应一样统一调用ResultDataVO的failure方法。
       

      在前文创建的GlobalExceptionAdvice类上有一个@RestControllerAdvice注解，该注解将使所有的异常都进入到此处被处理，同时也可以用于全局的数据绑定、格式化等。
       

      既然所有的异常都进入该类处理，那么如何处理呢？这里使用@ExceptionHandler注解，使用它可以指定当前方法处理哪种类型的异常，示例代码如下。通过在方法体内调ResultDataVO的failure方法来完成返回数据格式的规范，这里仅列举了三个异常处理，可自行添加更多的异常类。
       

      1.     /**
      2.      * 数据格式转换错误
      3.      */
      4.     @ExceptionHandler(DataFormatException.class)
      5.     @ResponseBody
      6.     public ResultDataVO dataFormatExceptionHandler(DataFormatException e) {
      7.         log.error("捕获数据格式转换错误异常", e);
      8.         return ResultDataVO.failure(ExceptionCodeEnum.EC10001);
      9.     }
      10.  
      11.     /**
      12.      * 业务异常捕获
      13.      *
      14.      * @param businessException
      15.      * @return
      16.      */
      17.     @ExceptionHandler(value = BusinessException.class)
      18.     public ResultDataVO handleBusinessException(BusinessException businessException) {
      19.         log.error("捕获业务异常", businessException);
      20.         return ResultDataVO.failure(businessException.getCodeEnum());
      21.     }
      22.     
      23.     /**
      24.      * 系统级异常
      25.      *
      26.      * @param throwable
      27.      */
      28.     @ExceptionHandler(value = Throwable.class)
      29.     public ResultDataVO handleThrowable(Throwable throwable) {
      30.         log.error("捕获系统级异常", throwable);
      31.         return ResultDataVO.failure(ExceptionCodeEnum.EC10000);
      32.     }
       

      使用
       

      通过上述操作可以实现一定程度上对try-catch的消除，示例代码如下
       

      1.     /**
      2.      * 统一异常处理
      3.      * @return
      4.      */
      5.     @GetMapping("/error")
      6.     public ResultDataVO getError(){
      7.         // try...catch
      8.         int res = 1 / 0;
      9.         return ResultDataVO.success(res);
      10.     }
       

       

      优化
       

      虽然采用上述方式已经实现了对异常的统一拦截处理并返回，但若异常产生的源头并非Crontroller中出现而是在系统内部时则有可能导致返回结果出现问题，该问题已经在GlobalExceptionAdvice类的beforeBodyWrite方法中做了处理，当body对象为空时则仍然会调用ResultDataVO的failure方法。
       

      1.         // 用于处理未被正常捕获的异常
      2.         if(body == null){
      3.             log.error("未处理的异常信息,请检查错误日志");
      4.             return ResultDataVO.failure(ExceptionCodeEnum.EC10000);
      5.         }
      6.         
      7.         // ......
       

      总结
       

      通过使用@RestControllerAdvice和@ExceptionHandler注解和错误码以及对应处理/响应类即可实现全局异常的统一处理，其中GlobalExceptionAdvice类对全局响应和异常处理做了合并，可按照业务需求自行拆分。
      
                
                    
                

                
    60. 

                    相关阅读:
      
                    
【无标题】                            
      
简单了解一下国产GPU                            
      
Linux下中间件tomcat安装配置（阿帕奇猫）                            
      
linux下文件存储系统（inode/目录项/硬链接）                            
      
Jmeter书中不会教你的（99）——java request实例                            
      
Linux（b站视频兄弟连）自学笔记第十三章——Linux系统管理                            
      
Apache SeaTunnel在VIP 中的使用                            
      
Linux操作系统的发展                            
      
IDEA添加Vue文件模板                            
      
JAVA【设计模式】桥接模式                            
      
                          
                
      61. 
                
    61. 
                    原文地址：https://blog.csdn.net/mdzz14/article/details/133248407
                
      62.