• 替代try catch处理异常的优雅方式

    背景

    软件开发过程中，不可避免的是需要处理各种异常，就我自己来说，至少有一半以上的时间都是在处理各种异常情况，所以代码中就会出现大量的try {...} catch {...} finally {...}代码块，不仅有大量的冗余代码，而且还影响代码的可读性。比较下面两张图，看看您现在编写的代码属于哪一种风格？然后哪种编码风格您更喜欢？

    丑陋的 try catch 代码块

    优雅的Controller

    上面的示例，还只是在Controller层，如果是在Service层，可能会有更多的try catch代码块。这将会严重影响代码的可读性、“美观性”。

    所以如果是我的话，我肯定偏向于第二种，我可以把更多的精力放在业务代码的开发，同时代码也会变得更加简洁。

    既然业务代码不显式地对异常进行捕获、处理，而异常肯定还是处理的，不然系统岂不是动不动就崩溃了，所以必须得有其他地方捕获并处理这些异常。

    那么问题来了，如何优雅的处理各种异常？

    什么是统一异常处理

    Spring在3.2版本增加了一个注解@ControllerAdvice，可以与@ExceptionHandler、@InitBinder、@ModelAttribute等注解注解配套使用，对于这几个注解的作用，这里不做过多赘述，若有不了解的，可以参考Spring3.2新注解@ControllerAdvice，先大概有个了解。

    不过跟异常处理相关的只有注解@ExceptionHandler，从字面上看，就是异常处理器的意思，其实际作用也是：若在某个Controller类定义一个异常处理方法，并在方法上添加该注解，那么当出现指定的异常时，会执行该处理异常的方法，其可以使用springmvc提供的数据绑定，比如注入HttpServletRequest等，还可以接受一个当前抛出的Throwable对象。

    但是，这样一来，就必须在每一个Controller类都定义一套这样的异常处理方法，因为异常可以是各种各样。这样一来，就会造成大量的冗余代码，而且若需要新增一种异常的处理逻辑，就必须修改所有Controller类了，很不优雅。

    当然你可能会说，那就定义个类似BaseController的基类，这样总行了吧。

    这种做法虽然没错，但仍不尽善尽美，因为这样的代码有一定的侵入性和耦合性。简简单单的Controller，我为啥非得继承这样一个类呢，万一已经继承其他基类了呢。大家都知道Java只能继承一个类。

    那有没有一种方案，既不需要跟Controller耦合，也可以将定义的异常处理器应用到所有控制器呢？所以注解@ControllerAdvice出现了，简单的说，该注解可以把异常处理器应用到所有控制器，而不是单个控制器。借助该注解，我们可以实现：在独立的某个地方，比如单独一个类，定义一套对各种异常的处理机制，然后在类的签名加上注解@ControllerAdvice，统一对不同阶段的、不同异常进行处理。这就是统一异常处理的原理。

    注意到上面对异常按阶段进行分类，大体可以分成：进入Controller前的异常 和Service层异常，具体可以参考下图：

    不同阶段的异常

    目标

    消灭95%以上的try catch代码块，以优雅的Assert(断言) 方式来校验业务的异常情况，只关注业务逻辑，而不用花费大量精力写冗余的try catch代码块。

    统一异常处理实战

    在定义统一异常处理类之前，先来介绍一下如何优雅的判定异常情况并抛异常。

    用 Assert(断言) 替换 throw exception

    想必Assert(断言)大家都很熟悉，比如Spring家族的org.springframework.util.Assert，在我们写测试用例的时候经常会用到，使用断言能让我们编码的时候有一种非一般丝滑的感觉，比如：

    1. @Test
    2.     public void test1() {
    3.         ...
    4.         User user = userDao.selectById(userId);
    5.         Assert.notNull(user, "用户不存在.");
    6.         ...
    7.     }
    8.  
    9.     @Test
    10.     public void test2() {
    11.         // 另一种写法
    12.         User user = userDao.selectById(userId);
    13.         if (user == null) {
    14.             throw new IllegalArgumentException("用户不存在.");
    15.         }
    16.     }

    有没有感觉第一种判定非空的写法很优雅，第二种写法则是相对丑陋的if {...}代码块。那么    神奇的Assert.notNull()背后到底做了什么呢？下面是Assert的部分源码：

    1. public abstract class Assert {
    2.     public Assert() {
    3.     }
    4.  
    5.     public static void notNull(@Nullable Object object, String message) {
    6.         if (object == null) {
    7.             throw new IllegalArgumentException(message);
    8.         }
    9.     }
    10. }

    可以看到，Assert其实就是帮我们把if {...}封装了一下，是不是很神奇。虽然很简单，但不可否认的是编码体验至少提升了一个档次。那么我们能不能模仿org.springframework.util.Assert，也写一个断言类，不过断言失败后抛出的异常不是IllegalArgumentException这些内置异常，而是我们自己定义的异常。下面让我们来尝试一下。

    1. Assert
    2. public interface Assert {
    3.     /**
    4.      * 创建异常
    5.      * @param args
    6.      * @return
    7.      */
    8.     BaseException newException(Object... args);
    9.  
    10.     /**
    11.      * 创建异常
    12.      * @param t
    13.      * @param args
    14.      * @return
    15.      */
    16.     BaseException newException(Throwable t, Object... args);
    17.  
    18.     /**
    19.      * <p>断言对象<code>obj</code>非空。如果对象<code>obj</code>为空，则抛出异常
    20.      *
    21.      * @param obj 待判断对象
    22.      */
    23.     default void assertNotNull(Object obj) {
    24.         if (obj == null) {
    25.             throw newException(obj);
    26.         }
    27.     }
    28.  
    29.     /**
    30.      * <p>断言对象<code>obj</code>非空。如果对象<code>obj</code>为空，则抛出异常
    31.      * <p>异常信息<code>message</code>支持传递参数方式，避免在判断之前进行字符串拼接操作
    32.      *
    33.      * @param obj 待判断对象
    34.      * @param args message占位符对应的参数列表
    35.      */
    36.     default void assertNotNull(Object obj, Object... args) {
    37.         if (obj == null) {
    38.             throw newException(args);
    39.         }
    40.     }
    41. }

    上面的Assert断言方法是使用接口的默认方法定义的，然后有没有发现当断言失败后，抛出的异常不是具体的某个异常，而是交由2个newException接口方法提供。因为业务逻辑中出现的异常基本都是对应特定的场景，比如根据用户id获取用户信息，查询结果为null，此时抛出的异常可能为UserNotFoundException，并且有特定的异常码（比如7001）和异常信息“用户不存在”。所以具体抛出什么异常，有Assert的实现类决定。

    看到这里，您可能会有这样的疑问，按照上面的说法，那岂不是有多少异常情况，就得有定义等量的断言类和异常类，这显然是反人类的，这也没想象中高明嘛。别急，且听我细细道来。

    善解人意的Enum

    自定义异常BaseException有2个属性，即code、message，这样一对属性，有没有想到什么类一般也会定义这2个属性？没错，就是枚举类。且看我如何将Enum和Assert结合起来，相信我一定会让你眼前一亮。如下：

    1. public interface IResponseEnum {
    2.     int getCode();
    3.     String getMessage();
    4. }
    5. /**
    6.  * <p>业务异常</p>
    7.  * <p>业务处理时，出现异常，可以抛出该异常</p>
    8.  */
    9. public class BusinessException extends  BaseException {
    10.  
    11.     private static final long serialVersionUID = 1L;
    12.  
    13.     public BusinessException(IResponseEnum responseEnum, Object[] args, String message) {
    14.         super(responseEnum, args, message);
    15.     }
    16.  
    17.     public BusinessException(IResponseEnum responseEnum, Object[] args, String message, Throwable cause) {
    18.         super(responseEnum, args, message, cause);
    19.     }
    20. }
    21. public interface BusinessExceptionAssert extends IResponseEnum, Assert {
    22.  
    23.     @Override
    24.     default BaseException newException(Object... args) {
    25.         String msg = MessageFormat.format(this.getMessage(), args);
    26.  
    27.         return new BusinessException(this, args, msg);
    28.     }
    29.  
    30.     @Override
    31.     default BaseException newException(Throwable t, Object... args) {
    32.         String msg = MessageFormat.format(this.getMessage(), args);
    33.  
    34.         return new BusinessException(this, args, msg, t);
    35.     }
    36.  
    37. }
    38. @Getter
    39. @AllArgsConstructor
    40. public enum ResponseEnum implements BusinessExceptionAssert {
    41.  
    42.     /**
    43.      * Bad licence type
    44.      */
    45.     BAD_LICENCE_TYPE(7001, "Bad licence type."),
    46.     /**
    47.      * Licence not found
    48.      */
    49.     LICENCE_NOT_FOUND(7002, "Licence not found.")
    50.     ;
    51.  
    52.     /**
    53.      * 返回码
    54.      */
    55.     private int code;
    56.     /**
    57.      * 返回消息
    58.      */
    59.     private String message;
    60. }

    看到这里，有没有眼前一亮的感觉，代码示例中定义了两个枚举实例：BAD_LICENCE_TYPE、LICENCE_NOT_FOUND，分别对应了BadLicenceTypeException、LicenceNotFoundException两种异常。以后每增加一种异常情况，只需增加一个枚举实例即可，再也不用每一种异常都定义一个异常类了。然后再来看下如何使用，假设LicenceService有校验Licence是否存在的方法，如下：

    1. /**
    2.      * 校验{@link Licence}存在
    3.      * @param licence
    4.      */
    5.     private void checkNotNull(Licence licence) {
    6.         ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);
    7.     }

    若不使用断言，代码可能如下：

    1. private void checkNotNull(Licence licence) {
    2.         if (licence == null) {
    3.             throw new LicenceNotFoundException();
    4.             // 或者这样
    5.             throw new BusinessException(7001, "Bad licence type.");
    6.         }
    7.     }

    使用枚举类结合(继承)Assert，只需根据特定的异常情况定义不同的枚举实例，如上面的BAD_LICENCE_TYPE、LICENCE_NOT_FOUND，就能够针对不同情况抛出特定的异常（这里指携带特定的异常码和异常消息），这样既不用定义大量的异常类，同时还具备了断言的良好可读性，当然这种方案的好处远不止这些，请继续阅读后文，慢慢体会。

    注：上面举的例子是针对特定的业务，而有部分异常情况是通用的，比如：服务器繁忙、网络异常、服务器异常、参数校验异常、404等，所以有CommonResponseEnum、ArgumentResponseEnum、ServletResponseEnum，其中ServletResponseEnum会在后文详细说明。

    定义统一异常处理器类

    1. @Slf4j
    2. @Component
    3. @ControllerAdvice
    4. @ConditionalOnWebApplication
    5. @ConditionalOnMissingBean(UnifiedExceptionHandler.class)
    6. public class UnifiedExceptionHandler {
    7.     /**
    8.      * 生产环境
    9.      */
    10.     private final static String ENV_PROD = "prod";
    11.  
    12.     @Autowired
    13.     private UnifiedMessageSource unifiedMessageSource;
    14.  
    15.     /**
    16.      * 当前环境
    17.      */
    18.     @Value("${spring.profiles.active}")
    19.     private String profile;
    20.  
    21.     /**
    22.      * 获取国际化消息
    23.      *
    24.      * @param e 异常
    25.      * @return
    26.      */
    27.     public String getMessage(BaseException e) {
    28.         String code = "response." + e.getResponseEnum().toString();
    29.         String message = unifiedMessageSource.getMessage(code, e.getArgs());
    30.  
    31.         if (message == null || message.isEmpty()) {
    32.             return e.getMessage();
    33.         }
    34.  
    35.         return message;
    36.     }
    37.  
    38.     /**
    39.      * 业务异常
    40.      *
    41.      * @param e 异常
    42.      * @return 异常结果
    43.      */
    44.     @ExceptionHandler(value = BusinessException.class)
    45.     @ResponseBody
    46.     public ErrorResponse handleBusinessException(BaseException e) {
    47.         log.error(e.getMessage(), e);
    48.  
    49.         return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));
    50.     }
    51.  
    52.     /**
    53.      * 自定义异常
    54.      *
    55.      * @param e 异常
    56.      * @return 异常结果
    57.      */
    58.     @ExceptionHandler(value = BaseException.class)
    59.     @ResponseBody
    60.     public ErrorResponse handleBaseException(BaseException e) {
    61.         log.error(e.getMessage(), e);
    62.  
    63.         return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));
    64.     }
    65.  
    66.     /**
    67.      * Controller上一层相关异常
    68.      *
    69.      * @param e 异常
    70.      * @return 异常结果
    71.      */
    72.     @ExceptionHandler({
    73.             NoHandlerFoundException.class,
    74.             HttpRequestMethodNotSupportedException.class,
    75.             HttpMediaTypeNotSupportedException.class,
    76.             MissingPathVariableException.class,
    77.             MissingServletRequestParameterException.class,
    78.             TypeMismatchException.class,
    79.             HttpMessageNotReadableException.class,
    80.             HttpMessageNotWritableException.class,
    81.             // BindException.class,
    82.             // MethodArgumentNotValidException.class
    83.             HttpMediaTypeNotAcceptableException.class,
    84.             ServletRequestBindingException.class,
    85.             ConversionNotSupportedException.class,
    86.             MissingServletRequestPartException.class,
    87.             AsyncRequestTimeoutException.class
    88.     })
    89.     @ResponseBody
    90.     public ErrorResponse handleServletException(Exception e) {
    91.         log.error(e.getMessage(), e);
    92.         int code = CommonResponseEnum.SERVER_ERROR.getCode();
    93.         try {
    94.             ServletResponseEnum servletExceptionEnum = ServletResponseEnum.valueOf(e.getClass().getSimpleName());
    95.             code = servletExceptionEnum.getCode();
    96.         } catch (IllegalArgumentException e1) {
    97.             log.error("class [{}] not defined in enum {}", e.getClass().getName(), ServletResponseEnum.class.getName());
    98.         }
    99.  
    100.         if (ENV_PROD.equals(profile)) {
    101.             // 当为生产环境, 不适合把具体的异常信息展示给用户, 比如404.
    102.             code = CommonResponseEnum.SERVER_ERROR.getCode();
    103.             BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);
    104.             String message = getMessage(baseException);
    105.             return new ErrorResponse(code, message);
    106.         }
    107.  
    108.         return new ErrorResponse(code, e.getMessage());
    109.     }
    110.  
    111.  
    112.     /**
    113.      * 参数绑定异常
    114.      *
    115.      * @param e 异常
    116.      * @return 异常结果
    117.      */
    118.     @ExceptionHandler(value = BindException.class)
    119.     @ResponseBody
    120.     public ErrorResponse handleBindException(BindException e) {
    121.         log.error("参数绑定校验异常", e);
    122.  
    123.         return wrapperBindingResult(e.getBindingResult());
    124.     }
    125.  
    126.     /**
    127.      * 参数校验异常，将校验失败的所有异常组合成一条错误信息
    128.      *
    129.      * @param e 异常
    130.      * @return 异常结果
    131.      */
    132.     @ExceptionHandler(value = MethodArgumentNotValidException.class)
    133.     @ResponseBody
    134.     public ErrorResponse handleValidException(MethodArgumentNotValidException e) {
    135.         log.error("参数绑定校验异常", e);
    136.  
    137.         return wrapperBindingResult(e.getBindingResult());
    138.     }
    139.  
    140.     /**
    141.      * 包装绑定异常结果
    142.      *
    143.      * @param bindingResult 绑定结果
    144.      * @return 异常结果
    145.      */
    146.     private ErrorResponse wrapperBindingResult(BindingResult bindingResult) {
    147.         StringBuilder msg = new StringBuilder();
    148.  
    149.         for (ObjectError error : bindingResult.getAllErrors()) {
    150.             msg.append(", ");
    151.             if (error instanceof FieldError) {
    152.                 msg.append(((FieldError) error).getField()).append(": ");
    153.             }
    154.             msg.append(error.getDefaultMessage() == null ? "" : error.getDefaultMessage());
    155.  
    156.         }
    157.  
    158.         return new ErrorResponse(ArgumentResponseEnum.VALID_ERROR.getCode(), msg.substring(2));
    159.     }
    160.  
    161.     /**
    162.      * 未定义异常
    163.      *
    164.      * @param e 异常
    165.      * @return 异常结果
    166.      */
    167.     @ExceptionHandler(value = Exception.class)
    168.     @ResponseBody
    169.     public ErrorResponse handleException(Exception e) {
    170.         log.error(e.getMessage(), e);
    171.  
    172.         if (ENV_PROD.equals(profile)) {
    173.             // 当为生产环境, 不适合把具体的异常信息展示给用户, 比如数据库异常信息.
    174.             int code = CommonResponseEnum.SERVER_ERROR.getCode();
    175.             BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);
    176.             String message = getMessage(baseException);
    177.             return new ErrorResponse(code, message);
    178.         }
    179.  
    180.         return new ErrorResponse(CommonResponseEnum.SERVER_ERROR.getCode(), e.getMessage());
    181.     }
    182.  
    183. }

    可以看到，上面将异常分成几类，实际上只有两大类，一类是ServletException、ServiceException，还记得上文提到的按阶段分类吗，即对应 进入Controller前的异常 和Service层异常；然后ServiceException再分成自定义异常、未知异常。对应关系如下：

    • 进入Controller前的异常: handleServletException、handleBindException、handleValidException

    • 自定义异常: handleBusinessException、handleBaseException

    • 未知异常: handleException

    接下来分别对这几种异常处理器做详细说明。

    异常处理器说明

    handleServletException

    一个http请求，在到达Controller前，会对该请求的请求信息与目标控制器信息做一系列校验。这里简单说一下：

    NoHandlerFoundException：首先根据请求Url查找有没有对应的控制器，若没有则会抛该异常，也就是大家非常熟悉的404异常；

    HttpRequestMethodNotSupportedException：若匹配到了（匹配结果是一个列表，不同的是http方法不同，如：Get、Post等），则尝试将请求的http方法与列表的控制器做匹配，若没有对应http方法的控制器，则抛该异常；

    HttpMediaTypeNotSupportedException：然后再对请求头与控制器支持的做比较，比如content-type请求头，若控制器的参数签名包含注解@RequestBody，但是请求的content-type请求头的值没有包含application/json，那么会抛该异常（当然，不止这种情况会抛这个异常）；

    MissingPathVariableException：未检测到路径参数。比如url为：/licence/{licenceId}，参数签名包含@PathVariable("licenceId")，当请求的url为/licence，在没有明确定义url为/licence的情况下，会被判定为：缺少路径参数；

    MissingServletRequestParameterException：缺少请求参数。比如定义了参数@RequestParam("licenceId") String licenceId，但发起请求时，未携带该参数，则会抛该异常；

    TypeMismatchException: 参数类型匹配失败。比如：接收参数为Long型，但传入的值确是一个字符串，那么将会出现类型转换失败的情况，这时会抛该异常；

    HttpMessageNotReadableException：与上面的HttpMediaTypeNotSupportedException举的例子完全相反，即请求头携带了"content-type: application/json;charset=UTF-8"，但接收参数却没有添加注解@RequestBody，或者请求体携带的 json 串反序列化成 pojo 的过程中失败了，也会抛该异常；

    HttpMessageNotWritableException：返回的 pojo 在序列化成 json 过程失败了，那么抛该异常；

    handleBindException

    参数校验异常，后文详细说明。

    handleValidException

    参数校验异常，后文详细说明。

    handleBusinessException、handleBaseException

    处理自定义的业务异常，只是handleBaseException处理的是除了BusinessException意外的所有业务异常。就目前来看，这2个是可以合并成一个的。

    handleException

    处理所有未知的异常，比如操作数据库失败的异常。

    注：上面的handleServletException、handleException这两个处理器，返回的异常信息，不同环境返回的可能不一样，以为这些异常信息都是框架自带的异常信息，一般都是英文的，不太好直接展示给用户看，所以统一返回SERVER_ERROR代表的异常信息。

    异于常人的404

    上文提到，当请求没有匹配到控制器的情况下，会抛出NoHandlerFoundException异常，但其实默认情况下不是这样，默认情况下会出现类似如下页面：

    Whitelabel Error Page

    这个页面是如何出现的呢？实际上，当出现404的时候，默认是不抛异常的，而是forward跳转到/error控制器，spring也提供了默认的error控制器，如下：

    那么，如何让404也抛出异常呢，只需在properties文件中加入如下配置即可：

    1. spring.mvc.throw-exception-if-no-handler-found=true
    2. spring.resources.add-mappings=false

    如此，就可以异常处理器中捕获它了，然后前端只要捕获到特定的状态码，立即跳转到404页面即可

    捕获404对应的异常

    统一返回结果

    在验证统一异常处理器之前，顺便说一下统一返回结果。说白了，其实是统一一下返回结果的数据结构。code、message是所有返回结果中必有的字段，而当需要返回数据时，则需要另一个字段data来表示。

    所以首先定义一个BaseResponse来作为所有返回结果的基类；

    然后定义一个通用返回结果类CommonResponse，继承BaseResponse，而且多了字段data；

    为了区分成功和失败返回结果，于是再定义一个ErrorResponse

    最后还有一种常见的返回结果，即返回的数据带有分页信息，因为这种接口比较常见，所以有必要单独定义一个返回结果类QueryDataResponse，该类继承自CommonResponse，只是把data字段的类型限制为QueryDdata，QueryDdata中定义了分页信息相应的字段，即totalCount、pageNo、pageSize、records。

    其中比较常用的只有CommonResponse和QueryDataResponse，但是名字又贼鬼死长，何不定义2个名字超简单的类来替代呢？于是R和QR诞生了，以后返回结果的时候只需这样写：new R<>(data)、new QR<>(queryData)。

    所有的返回结果类的定义这里就不贴出来了

    验证统一异常处理

    因为这一套统一异常处理可以说是通用的，所有可以设计成一个common包，以后每一个新项目/模块只需引入该包即可。所以为了验证，需要新建一个项目，并引入该common包。

    主要代码

    下面是用于验证的主要源码：

    1. @Service
    2. public class LicenceService extends ServiceImpl<LicenceMapper, Licence> {
    3.  
    4.     @Autowired
    5.     private OrganizationClient organizationClient;
    6.  
    7.     /**
    8.      * 查询{@link Licence} 详情
    9.      * @param licenceId
    10.      * @return
    11.      */
    12.     public LicenceDTO queryDetail(Long licenceId) {
    13.         Licence licence = this.getById(licenceId);
    14.         checkNotNull(licence);
    15.  
    16.         OrganizationDTO org = ClientUtil.execute(() -> organizationClient.getOrganization(licence.getOrganizationId()));
    17.         return toLicenceDTO(licence, org);
    18.     }
    19.  
    20.     /**
    21.      * 分页获取
    22.      * @param licenceParam 分页查询参数
    23.      * @return
    24.      */
    25.     public QueryData<SimpleLicenceDTO> getLicences(LicenceParam licenceParam) {
    26.         String licenceType = licenceParam.getLicenceType();
    27.         LicenceTypeEnum licenceTypeEnum = LicenceTypeEnum.parseOfNullable(licenceType);
    28.         // 断言, 非空
    29.         ResponseEnum.BAD_LICENCE_TYPE.assertNotNull(licenceTypeEnum);
    30.  
    31.         LambdaQueryWrapper<Licence> wrapper = new LambdaQueryWrapper<>();
    32.         wrapper.eq(Licence::getLicenceType, licenceType);
    33.         IPage<Licence> page = this.page(new QueryPage<>(licenceParam), wrapper);
    34.         return new QueryData<>(page, this::toSimpleLicenceDTO);
    35.     }
    36.  
    37.     /**
    38.      * 新增{@link Licence}
    39.      * @param request 请求体
    40.      * @return
    41.      */
    42.     @Transactional(rollbackFor = Throwable.class)
    43.     public LicenceAddRespData addLicence(LicenceAddRequest request) {
    44.         Licence licence = new Licence();
    45.         licence.setOrganizationId(request.getOrganizationId());
    46.         licence.setLicenceType(request.getLicenceType());
    47.         licence.setProductName(request.getProductName());
    48.         licence.setLicenceMax(request.getLicenceMax());
    49.         licence.setLicenceAllocated(request.getLicenceAllocated());
    50.         licence.setComment(request.getComment());
    51.         this.save(licence);
    52.  
    53.         return new LicenceAddRespData(licence.getLicenceId());
    54.     }
    55.  
    56.     /**
    57.      * entity -> simple dto
    58.      * @param licence {@link Licence} entity
    59.      * @return {@link SimpleLicenceDTO}
    60.      */
    61.     private SimpleLicenceDTO toSimpleLicenceDTO(Licence licence) {
    62.         // 省略
    63.     }
    64.  
    65.     /**
    66.      * entity -> dto
    67.      * @param licence {@link Licence} entity
    68.      * @param org {@link OrganizationDTO}
    69.      * @return {@link LicenceDTO}
    70.      */
    71.     private LicenceDTO toLicenceDTO(Licence licence, OrganizationDTO org) {
    72.         // 省略
    73.     }
    74.  
    75.     /**
    76.      * 校验{@link Licence}存在
    77.      * @param licence
    78.      */
    79.     private void checkNotNull(Licence licence) {
    80.         ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);
    81.     }
    82.  
    83. }

    PS: 这里使用的DAO框架是mybatis-plus。    启动时，自动插入的数据为：

    1. -- licence
    2. INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)
    3. VALUES (1, 1, 'user','CustomerPro', 100,5);
    4. INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)
    5. VALUES (2, 1, 'user','suitability-plus', 200,189);
    6. INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)
    7. VALUES (3, 2, 'user','HR-PowerSuite', 100,4);
    8. INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)
    9. VALUES (4, 2, 'core-prod','WildCat Application Gateway', 16,16);
    10.  
    11. -- organizations
    12. INSERT INTO organization (id, name, contact_name, contact_email, contact_phone)
    13. VALUES (1, 'customer-crm-co', 'Mark Balster', 'mark.balster@custcrmco.com', '823-555-1212');
    14. INSERT INTO organization (id, name, contact_name, contact_email, contact_phone)
    15. VALUES (2, 'HR-PowerSuite', 'Doug Drewry','doug.drewry@hr.com', '920-555-1212');

    开始验证

    捕获自定义异常

    \1. 获取不存在的licence详情：http://localhost:10000/licence/5。成功响应的请求：licenceId=1

    检验非空

    捕获 Licence not found 异常

    Licence not found

    2. 根据不存在的licence type获取licence列表：http://localhost:10000/licence/list?licenceType=ddd。可选的licence type为：user、core-prod 。

    校验非空

    捕获 Bad licence type 异常

    Bad licence type

    捕获进入 Controller 前的异常

    1. 访问不存在的接口：http://localhost:10000/licence/list/ddd

    捕获404异常

    2. http 方法不支持：http://localhost:10000/licence

    PostMapping

    捕获 Request method not supported 异常

    Request method not supported

    3. 校验异常1：http://localhost:10000/licence/list?licenceType=

    getLicences

    LicenceParam

    捕获参数绑定校验异常

    licence type cannot be empty

    4. 校验异常2：post 请求，这里使用postman模拟。

    addLicence

    LicenceAddRequest

    请求url即结果

    捕获参数绑定校验异常

    注：因为参数绑定校验异常的异常信息的获取方式与其它异常不一样，所以才把这2种情况的异常从进入 Controller 前的异常单独拆出来，下面是异常信息的收集逻辑：

    异常信息的收集

    捕获未知异常

    假设我们现在随便对Licence新增一个字段test，但不修改数据库表结构，然后访问：http://localhost:10000/licence/1。

    增加test字段

    捕获数据库异常

    Error querying database

    小结

    可以看到，测试的异常都能够被捕获，然后以code、message的形式返回。每一个项目/模块，在定义业务异常的时候，只需定义一个枚举类，然后实现接口BusinessExceptionAssert，最后为每一种业务异常定义对应的枚举实例即可，而不用定义许多异常类。使用的时候也很方便，用法类似断言。

    扩展

    在生产环境，若捕获到未知异常或者ServletException，因为都是一长串的异常信息，若直接展示给用户看，显得不够专业，于是，我们可以这样做：当检测到当前环境是生产环境，那么直接返回 "网络异常"。

    生产环境返回“网络异常”

    可以通过以下方式修改当前环境：

    修改当前环境为生产环境

    总结

    使用断言和枚举类相结合的方式，再配合统一异常处理，基本大部分的异常都能够被捕获。为什么说大部分异常，因为当引入spring cloud security后，还会有认证/授权异常，网关的服务降级异常、跨模块调用异常、远程调用第三方服务异常等，这些异常的捕获方式与本文介绍的不太一样，不过限于篇幅，这里不做详细说明，以后会有单独的文章介绍。

    另外，当需要考虑国际化的时候，捕获异常后的异常信息一般不能直接返回，需要转换成对应的语言，不过本文已考虑到了这个，获取消息的时候已经做了国际化映射，逻辑如下：

    获取国际化消息

    最后总结，全局异常属于老生长谈的话题，希望这次通过手机的项目对大家有点指导性的学习。大家根据实际情况自行修改。

    也可以采用以下的jsonResult对象的方式进行处理，也贴出来代码.

    1. @Slf4j
    2. @RestControllerAdvice
    3. public class GlobalExceptionHandler {
    4.  
    5.     /**
    6.      * 没有登录
    7.      * @param request
    8.      * @param response
    9.      * @param e
    10.      * @return
    11.      */
    12.     @ExceptionHandler(NoLoginException.class)
    13.     public Object noLoginExceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)
    14.     {
    15.         log.error("[GlobalExceptionHandler][noLoginExceptionHandler] exception",e);
    16.         JsonResult jsonResult = new JsonResult();
    17.         jsonResult.setCode(JsonResultCode.NO_LOGIN);
    18.         jsonResult.setMessage("用户登录失效或者登录超时,请先登录");
    19.         return jsonResult;
    20.     }
    21.  
    22.     /**
    23.      * 业务异常
    24.      * @param request
    25.      * @param response
    26.      * @param e
    27.      * @return
    28.      */
    29.     @ExceptionHandler(ServiceException.class)
    30.     public Object businessExceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)
    31.     {
    32.         log.error("[GlobalExceptionHandler][businessExceptionHandler] exception",e);
    33.         JsonResult jsonResult = new JsonResult();
    34.         jsonResult.setCode(JsonResultCode.FAILURE);
    35.         jsonResult.setMessage("业务异常,请联系管理员");
    36.         return jsonResult;
    37.     }
    38.  
    39.     /**
    40.      * 全局异常处理
    41.      * @param request
    42.      * @param response
    43.      * @param e
    44.      * @return
    45.      */
    46.     @ExceptionHandler(Exception.class)
    47.     public Object exceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)
    48.     {
    49.         log.error("[GlobalExceptionHandler][exceptionHandler] exception",e);
    50.         JsonResult jsonResult = new JsonResult();
    51.         jsonResult.setCode(JsonResultCode.FAILURE);
    52.         jsonResult.setMessage("系统错误,请联系管理员");
    53.         return jsonResult;
    54.     }
    55. }
  • 相关阅读:
    Netty RPC 实现
    Spring Security 如何实现身份认证和授权？
    postman调用接口报{“detail“:“Method \“DELETE\“ not allowed.“}错误, 解决记录
    前端中断取消网络请求
    Python_11 类的方法
    3_电机的发展及学习方法
    杀掉redis进程 并启动redis
    问：问卷中的多选题数据怎么整理？
    JAVASE---认识异常
    【前端】前端三要素之BOM
  • 原文地址：https://blog.csdn.net/m0_71777195/article/details/127862699