• 代码中统一异常如何处理，才能让代码更清晰

    背景

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

    上面的示例，还只是比较简单的方法，复杂一些的可能会有更多的try catch代码块。这将会严重影响代码的可读性、“美观性”。 所以如果是我的话，我肯定偏向于第二种，我可以把更多的精力放在业务代码的开发，同时代码也会变得更加简洁。 既然业务代码不显式地对异常进行捕获、处理，而异常肯定还是处理的，不然系统岂不是动不动就崩溃了，所以必须得有其他地方捕获并处理这些异常。那么问题来了，如何优雅的处理各种异常？ 

    基础知识点认识：

    下面我们先认识两个注解@RestControllerAdvice和@ExceptionHandler

    @RestControllerAdvice注解定义全局异常处理类，此注解通过对异常的拦截实现的统一异常返回处理。

    @ExceptionHandler 一个异常拦截器（处理器），指定某个或某些异常后，会捕获到相应的异常。

    使用 @ControllerAdvice + @ExceptionHandler 进行全局的 Controller 层异常处理，只要设计得当，就再也不用在 Controller 层进行 try-catch 了！而且@Validated 校验器注解的异常，也可以一起处理，减少模板代码，减少编码量，提升扩展性和可维护性。

    异常按阶段分类

    异常按阶段分可分为Controller前的异常和service层异常，具体可参考下图

    断言：

    在定义统一异常处理类之前，先来介绍一下如何优雅的判定异常情况并抛异常。 用 Assert(断言) 替换 throw exception 想必 Assert(断言) 大家都很熟悉，比如 Spring 家族的 org.springframework.util.Assert，在我们写测试用例的时候经常会用到，使用断言能让我们编码的时候有一种非一般丝滑的感觉，比如：

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

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

    1. package com.XX.edu.common.exception.assertion;
    2.  
    3. import com.XX.edu.common.exception.BaseException;
    4.  
    5. import java.util.List;
    6.  
    7. public interface Assert {
    8.     /**
    9.      * 创建异常
    10.      */
    11.     BaseException newException(Object... args);
    12.     /**
    13.      * 创建异常
    14.      */
    15.     BaseException newException(Throwable t, Object... args);
    16.     /**
    17.      * 
      断言对象obj非空。如果对象obj为空，则抛出异常
    18.      *
    19.      * @param obj 待判断对象
    20.      */
    21.     default void assertNotNull(Object obj) {
    22.         if (obj == null) {
    23.             throw newException(obj);
    24.         }
    25.     }
    26.  
    27.     /**
    28.      * 
      断言对象obj非空。如果对象obj为空，则抛出异常
    29.      * 
      异常信息message支持传递参数方式，避免在判断之前进行字符串拼接操作
    30.      *
    31.      * @param obj  待判断对象
    32.      * @param args message占位符对应的参数列表
    33.      */
    34.     default void assertNotNull(Object obj, Object... args) {
    35.         if (obj == null) {
    36.             throw newException(args);
    37.         }
    38.     }
    39.  
    40.     /**
    41.      * 如果为false抛出异常
    42.      **/
    43.     default void assertIsTrue(boolean res, Object... args) {
    44.         if (!res) {
    45.             throw newException(args);
    46.         }
    47.     }
    48.  
    49.     /**
    50.      * 如果为true抛出异常
    51.      **/
    52.     default void assertIsFalse(boolean res, Object... args) {
    53.         if (res) {
    54.             throw newException(args);
    55.         }
    56.     }
    57.  
    58.     /**
    59.      * 如果不为空抛出异常
    60.      **/
    61.     default void assertIsEmpty(Object obj, Object... args) {
    62.  
    63.         if (obj instanceof List) {
    64.             if (obj != null && ((List) obj).size() > 0) {
    65.                 throw newException(args);
    66.             }
    67.         } else {
    68.             if (obj != null) {
    69.                 throw newException(args);
    70.             }
    71.         }
    72.     }
    73.  
    74.     /**
    75.      * 如果为空抛出异常
    76.      **/
    77.     default void assertIsNotEmpty(Object obj, Object... args) {
    78.         if (obj instanceof List) {
    79.             if (obj == null || ((List) obj).size() == 0) {
    80.                 throw newException(args);
    81.             }
    82.         } else {
    83.             if (obj == null) {
    84.                 throw newException(args);
    85.             }
    86.         }
    87.     }
    88. }

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

    看到这里，您可能会有这样的疑问，按照上面的说法，那岂不是有多少异常情况，就得有定义等量的断言类和异常类，这显然是不可行的。下面我们来将 Enum 和 Assert 结合起来。看能否解决这个问题。

    先来看一张UML类图：

    1. package com.XX.edu.common.exception.enums;
    2.  
    3. public interface IResponseEnum {
    4.     /**
    5.      * 获取返回码
    6.      * @return 返回码
    7.      */
    8.     int getCode();
    9.  
    10.     /**
    11.      * 获取返回信息
    12.      * @return 返回信息
    13.      */
    14.     String getMessage();
    15. }
    1. package com.XX.edu.common.exception.assertion;
    2.  
    3. import cn.hutool.core.util.ArrayUtil;
    4. import com.XX.edu.common.exception.ArgumentException;
    5. import com.XX.edu.common.exception.BaseException;
    6. import com.XX.edu.common.exception.enums.IResponseEnum;
    7.  
    8. import java.text.MessageFormat;
    9.  
    10.  
    11. public interface CommonExceptionAssert extends IResponseEnum, Assert {
    12.  
    13.     @Override
    14.     default BaseException newException(Object... args) {
    15.         String msg = this.getMessage();
    16.         if (ArrayUtil.isNotEmpty(args)) {
    17.             msg = MessageFormat.format(this.getMessage(), args);
    18.         }
    19.  
    20.         return new ArgumentException(this, args, msg);
    21.     }
    22.  
    23.     @Override
    24.     default BaseException newException(Throwable t, Object... args) {
    25.         String msg = this.getMessage();
    26.         if (ArrayUtil.isNotEmpty(args)) {
    27.             msg = MessageFormat.format(this.getMessage(), args);
    28.         }
    29.  
    30.         return new ArgumentException(this, args, msg, t);
    31.     }
    32.  
    33. }
    1. package com.XX.edu.common.exception.assertion;
    2.  
    3. import com.XX.edu.common.exception.BaseException;
    4. import com.XX.edu.common.exception.BusinessException;
    5. import com.XX.edu.common.exception.enums.IResponseEnum;
    6.  
    7. import java.text.MessageFormat;
    8. //接口可以继承多个接口
    9. public interface BusinessExceptionAssert extends IResponseEnum, Assert {
    10. //jdk8以后接口里面可以包含方法体,但必须使用default或static修饰，
    11. // 而且我们知道实现类如果继承了接口，实现类必须强制重现接口的方法，但是这两种方式是不需要强制重写的，相当于没有abstract修饰
    12.     @Override
    13.     default BaseException newException(Object... args) {
    14.         String msg = MessageFormat.format(this.getMessage(), args);
    15.  
    16.         return new BusinessException(this, args, msg);
    17.     }
    18.  
    19.     @Override
    20.     default BaseException newException(Throwable t, Object... args) {
    21.         String msg = MessageFormat.format(this.getMessage(), args);
    22.  
    23.         return new BusinessException(this, args, msg, t);
    24.     }
    25.  
    26. }
    1. package com.XX.edu.common.exception.enums;
    2.  
    3. import com.XX.edu.common.exception.assertion.BusinessExceptionAssert;
    4. import lombok.AllArgsConstructor;
    5. import lombok.Getter;
    6.  
    7. /**
    8.  * 
      业务
    9.  */
    10. @Getter
    11. @AllArgsConstructor
    12. public enum BusinessResponseEnum implements BusinessExceptionAssert {
    13.  
    14.     UNCLASSIFIED(5001, "根据课程id={0}，班级id={1}未查询到班级信息"),
    15.     UNEXERCISEiNFO(5002, "根据习题id={0}未查询到习题详情"),
    16.     UNEXERCISE(5003, "习题id={0}不存在"),
    17.     DUMPLICATEEXERCISE(5004, "习题ID={0}已在删除状态，不可重复删除"),
    18.     CANNOTDELETEEXERCISE(5005, "习题ID={0}正在使用中，不可删除"),
    19.     NOMIGRATIONEXERCISE(5006, "没有需要迁移的历史数据"),
    20.     ;
    21.     /**
    22.      * 返回码
    23.      */
    24.     private int code;
    25.     /**
    26.      * 返回消息
    27.      */
    28.     private String message;
    29.  
    30.  
    31. }
    1. package com.XX.edu.common.exception.enums;
    2.  
    3. import com.XX.edu.common.exception.assertion.CommonExceptionAssert;
    4. import lombok.AllArgsConstructor;
    5. import lombok.Getter;
    6.  
    7. /**
    8.  * 
      通用返回结果
    9.  *
    10.  */
    11. @Getter
    12. @AllArgsConstructor
    13. public enum CommonResponseEnum implements CommonExceptionAssert {
    14.     /**
    15.      * 成功
    16.      */
    17.     SUCCESS(0, "SUCCESS"),
    18.     /**
    19.      * 服务器繁忙，请稍后重试
    20.      */
    21.     SERVER_BUSY(9998, "服务器繁忙"),
    22.     /**
    23.      * 服务器异常，无法识别的异常，尽可能对通过判断减少未定义异常抛出
    24.      */
    25.     SERVER_ERROR(9999, "网络异常");
    26.  
    27.     /**
    28.      * 返回码
    29.      */
    30.     private int code;
    31.     /**
    32.      * 返回消息
    33.      */
    34.     private String message;
    35.  
    36.  
    37. }

     

    1. package com.XX.edu.common.exception.enums;
    2.  
    3. import com.XX.edu.common.exception.assertion.CommonExceptionAssert;
    4. import lombok.AllArgsConstructor;
    5. import lombok.Getter;
    6.  
    7. /**
    8.  * 
      参数校验异常返回结果
    9.  *
    10.  * @author sprainkle
    11.  * @date 2019/5/2
    12.  */
    13. @Getter
    14. @AllArgsConstructor
    15. public enum ArgumentResponseEnum implements CommonExceptionAssert {
    16.     /**
    17.      * 绑定参数校验异常
    18.      */
    19.     VALID_ERROR(6000, "参数校验异常");
    20.  
    21.     /**
    22.      * 返回码
    23.      */
    24.     private int code;
    25.     /**
    26.      * 返回消息
    27.      */
    28.     private String message;
    29.  
    30. }
    1. package com.XX.edu.common.exception.enums;
    2.  
    3. import lombok.AllArgsConstructor;
    4. import lombok.Getter;
    5.  
    6. import javax.servlet.http.HttpServletResponse;
    7.  
    8. /**
    9.  * 
      异常类与http status对照关系
    10.  *
    11.  * @author
    12.  * @date 2022/11/1
    13.  * @see org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler
    14.  */
    15. @Getter
    16. @AllArgsConstructor
    17. public enum ServletResponseEnum {
    18.     MethodArgumentNotValidException(4400, "", HttpServletResponse.SC_BAD_REQUEST),
    19.     MethodArgumentTypeMismatchException(4400, "", HttpServletResponse.SC_BAD_REQUEST),
    20.     MissingServletRequestPartException(4400, "", HttpServletResponse.SC_BAD_REQUEST),
    21.     MissingPathVariableException(4400, "", HttpServletResponse.SC_BAD_REQUEST),
    22.     BindException(4400, "", HttpServletResponse.SC_BAD_REQUEST),
    23.     MissingServletRequestParameterException(4400, "", HttpServletResponse.SC_BAD_REQUEST),
    24.     TypeMismatchException(4400, "", HttpServletResponse.SC_BAD_REQUEST),
    25.     ServletRequestBindingException(4400, "", HttpServletResponse.SC_BAD_REQUEST),
    26.     HttpMessageNotReadableException(4400, "", HttpServletResponse.SC_BAD_REQUEST),
    27.     NoHandlerFoundException(4404, "", HttpServletResponse.SC_NOT_FOUND),
    28.     NoSuchRequestHandlingMethodException(4404, "", HttpServletResponse.SC_NOT_FOUND),
    29.     HttpRequestMethodNotSupportedException(4405, "", HttpServletResponse.SC_METHOD_NOT_ALLOWED),
    30.     HttpMediaTypeNotAcceptableException(4406, "", HttpServletResponse.SC_NOT_ACCEPTABLE),
    31.     HttpMediaTypeNotSupportedException(4415, "", HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE),
    32.     ConversionNotSupportedException(4500, "", HttpServletResponse.SC_INTERNAL_SERVER_ERROR),
    33.     HttpMessageNotWritableException(4500, "", HttpServletResponse.SC_INTERNAL_SERVER_ERROR),
    34.     AsyncRequestTimeoutException(4503, "", HttpServletResponse.SC_SERVICE_UNAVAILABLE)
    35.     ;
    36.  
    37.     /**
    38.      * 返回码，目前与{@link #statusCode}相同
    39.      */
    40.     private int code;
    41.     /**
    42.      * 返回信息，直接读取异常的message
    43.      */
    44.     private String message;
    45.     /**
    46.      * HTTP状态码
    47.      */
    48.     private int statusCode;
    49. }

     

    1. package com.XX.edu.common.exception;
    2.  
    3. import com.XX.edu.common.exception.enums.IResponseEnum;
    4. import lombok.Getter;
    5.  
    6. /**
    7.  * @Description: 异常基类
    8.  * @Title: BaseException
    9.  * @Package com.XX.edu.common.exception
    10.  * @Author:
    11.  * @Copyright 
    12.  * @CreateTime: 2022/11/1 13:43
    13.  */
    14.  
    15. @Getter
    16. public class BaseException extends RuntimeException {
    17.     private static final long serialVersionUID = 1L;
    18.  
    19.     /**
    20.      * 返回码
    21.      */
    22.     protected IResponseEnum responseEnum;
    23.     /**
    24.      * 异常消息参数
    25.      */
    26.     protected Object[] args;
    27.  
    28.     public BaseException(IResponseEnum responseEnum) {
    29.         super(responseEnum.getMessage());
    30.         this.responseEnum = responseEnum;
    31.     }
    32.  
    33.     public BaseException(int code, String msg) {
    34.         super(msg);
    35.         this.responseEnum = new IResponseEnum() {
    36.             @Override
    37.             public int getCode() {
    38.                 return code;
    39.             }
    40.  
    41.             @Override
    42.             public String getMessage() {
    43.                 return msg;
    44.             }
    45.         };
    46.     }
    47.  
    48.     public BaseException(IResponseEnum responseEnum, Object[] args, String message) {
    49.         super(message);
    50.         this.responseEnum = responseEnum;
    51.         this.args = args;
    52.     }
    53.  
    54.     public BaseException(IResponseEnum responseEnum, Object[] args, String message, Throwable cause) {
    55.         super(message, cause);
    56.         this.responseEnum = responseEnum;
    57.         this.args = args;
    58.     }
    59. }
    1. package com.XX.edu.common.exception;
    2.  
    3.  
    4. import com.XX.edu.common.exception.enums.IResponseEnum;
    5.  
    6. /**
    7.  * 
      参数异常
    8.  * 
      在处理业务过程中校验参数出现错误, 可以抛出该异常
    9.  * 
      编写公共代码（如工具类）时，对传入参数检查不通过时，可以抛出该异常
    10.  *
    11.  */
    12. public class ArgumentException extends  BaseException {
    13.  
    14.     private static final long serialVersionUID = 1L;
    15.  
    16.     public ArgumentException(IResponseEnum responseEnum, Object[] args, String message) {
    17.         super(responseEnum, args, message);
    18.     }
    19.  
    20.     public ArgumentException(IResponseEnum responseEnum, Object[] args, String message, Throwable cause) {
    21.         super(responseEnum, args, message, cause);
    22.     }
    23. }

     

    1. package com.XX.edu.common.exception;
    2.  
    3. import com.XX.edu.common.exception.enums.IResponseEnum;
    4.  
    5. /**
    6.  * @Description: 业务异常，业务处理时，出现异常，可以抛出该异常
    7.  * @Title: BusinessException
    8.  * @Package com.XX.edu.common.exception
    9.  * @Author:
    10.  * @Copyright 
    11.  * @CreateTime: 2022/11/1 13:32
    12.  */
    13. public class BusinessException extends  BaseException {
    14.  
    15.     private static final long serialVersionUID = 1L;
    16.  
    17.     public BusinessException(IResponseEnum responseEnum, Object[] args, String message) {
    18.         super(responseEnum, args, message);
    19.     }
    20.  
    21.     public BusinessException(IResponseEnum responseEnum, Object[] args, String message, Throwable cause) {
    22.         super(responseEnum, args, message, cause);
    23.     }
    24.  
    25. }
    1. package com.XX.edu.common.exception.i18n;
    2.  
    3. import org.springframework.context.MessageSource;
    4. import org.springframework.context.i18n.LocaleContextHolder;
    5. import org.springframework.stereotype.Service;
    6.  
    7. import javax.annotation.Resource;
    8. import java.util.Locale;
    9.  
    10. @Service
    11. public class UnifiedMessageSource {
    12.  
    13.     @Resource
    14.     private MessageSource messageSource;
    15.  
    16.     /**
    17.      * 获取国际化消息
    18.      * @param code 消息code
    19.      * @return
    20.      */
    21.     public String getMessage(String code) {
    22.  
    23.         return getMessage(code, null);
    24.     }
    25.  
    26.     /**
    27.      * 获取国际化消息
    28.      * @param code 消息code
    29.      * @param args 参数
    30.      * @return
    31.      */
    32.     public String getMessage(String code, Object[] args) {
    33.  
    34.         return getMessage(code, args, "");
    35.     }
    36.  
    37.     /**
    38.      * 获取国际化消息
    39.      * @param code 消息code
    40.      * @param args 参数
    41.      * @param defaultMessage 默认消息
    42.      * @return
    43.      */
    44.     public String getMessage(String code, Object[] args, String defaultMessage) {
    45.         Locale locale = LocaleContextHolder.getLocale();
    46.  
    47.         return messageSource.getMessage(code, args, defaultMessage, locale);
    48.     }
    49. }

     使用枚举类结合(继承)Assert，只需根据特定的异常情况定义不同的枚举实例，就能够针对不同情况抛出特定的异常（这里指携带特定的异常码和异常消息），这样既不用定义大量的异常类，同时还具备了断言的良好可读性。 

    使用：

     

    全局异常处理

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

    下面我们来看一下全局异常如何处理

    1. package com.XX.edu.common.exception.handler;
    2.  
    3. /**
    4.  * @Description: 定义统一异常处理器类
    5.  * @Title: UnifiedExceptionHandler
    6.  * @Package com.XX.edu.common.exception
    7.  * @Author:
    8.  * @Copyright
    9.  * @CreateTime: 2022/11/1 14:02
    10.  */
    11.  
    12. import com.XX.edu.common.bean.ResultTO;
    13. import com.XX.edu.common.exception.BaseException;
    14. import com.XX.edu.common.exception.BusinessException;
    15. import com.XX.edu.common.exception.enums.ArgumentResponseEnum;
    16. import com.XX.edu.common.exception.enums.CommonResponseEnum;
    17. import com.XX.edu.common.exception.enums.ServletResponseEnum;
    18. import com.XX.edu.common.exception.i18n.UnifiedMessageSource;
    19. import org.slf4j.Logger;
    20. import org.slf4j.LoggerFactory;
    21. import org.springframework.beans.ConversionNotSupportedException;
    22. import org.springframework.beans.TypeMismatchException;
    23. import org.springframework.beans.factory.annotation.Autowired;
    24. import org.springframework.beans.factory.annotation.Value;
    25. import org.springframework.http.converter.HttpMessageNotReadableException;
    26. import org.springframework.http.converter.HttpMessageNotWritableException;
    27. import org.springframework.validation.BindException;
    28. import org.springframework.validation.BindingResult;
    29. import org.springframework.validation.FieldError;
    30. import org.springframework.validation.ObjectError;
    31. import org.springframework.web.HttpMediaTypeNotAcceptableException;
    32. import org.springframework.web.HttpMediaTypeNotSupportedException;
    33. import org.springframework.web.HttpRequestMethodNotSupportedException;
    34. import org.springframework.web.bind.MethodArgumentNotValidException;
    35. import org.springframework.web.bind.MissingPathVariableException;
    36. import org.springframework.web.bind.MissingServletRequestParameterException;
    37. import org.springframework.web.bind.ServletRequestBindingException;
    38. import org.springframework.web.bind.annotation.ExceptionHandler;
    39. import org.springframework.web.bind.annotation.RestControllerAdvice;
    40. import org.springframework.web.context.request.async.AsyncRequestTimeoutException;
    41. import org.springframework.web.multipart.support.MissingServletRequestPartException;
    42. import org.springframework.web.servlet.NoHandlerFoundException;
    43.  
    44.  
    45. /**
    46.  * 
      全局异常处理器
    47.  */
    48. @RestControllerAdvice
    49. public class UnifiedExceptionHandler {
    50.     Logger logger = LoggerFactory.getLogger(getClass());
    51.     /**
    52.      * 生产环境BusinessException
    53.      */
    54.     private final static String ENV_PROD = "prod";
    55.  
    56.     @Autowired
    57.     private UnifiedMessageSource unifiedMessageSource;
    58.     /**
    59.      * 当前环境
    60.      */
    61.     @Value("${spring.profiles.active}")
    62.     private String profile;
    63.  
    64.  
    65.     /**
    66.      * 自定义异常
    67.      * 
    68.      * BaseException extends RuntimeException
    69.      *
    70.      * @param e 异常
    71.      * @return 异常结果
    72.      */
    73.     @ExceptionHandler(value = BaseException.class)
    74.     public ResultTO handleBaseException(BaseException e) {
    75.         logger.error(e.getMessage(), e);
    76.  
    77.         return ResultTO.FAILURE(getMessage(e), e.getResponseEnum().getCode());
    78.     }
    79.  
    80.     /**
    81.      * 未定义异常
    82.      *
    83.      * @param e 异常
    84.      * @return 异常结果
    85.      */
    86.     @ExceptionHandler(value = Exception.class)
    87.     public ResultTO handleException(Exception e) {
    88.         logger.error(e.getMessage(), e);
    89.  
    90.         if (ENV_PROD.equals(profile)) {
    91.             // 当为生产环境, 不适合把具体的异常信息展示给用户, 比如数据库异常信息.
    92.             int code = CommonResponseEnum.SERVER_ERROR.getCode();
    93.             BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);
    94.             String message = getMessage(baseException);
    95.             return ResultTO.FAILURE(message, code);
    96.         }
    97.         return ResultTO.FAILURE(e.getMessage(), CommonResponseEnum.SERVER_ERROR.getCode());
    98.     }
    99.  
    100.     /**
    101.      * 业务异常
    102.      *
    103.      * @param e 异常
    104.      * @return 异常结果
    105.      */
    106.     @ExceptionHandler(value = BusinessException.class)
    107.     public ResultTO handleBusinessException(BaseException e) {
    108.         logger.error(e.getMessage(), e);
    109.  
    110.         return  ResultTO.FAILURE(getMessage(e),e.getResponseEnum().getCode());
    111.     }
    112.  
    113.     /**
    114.      * Controller上一层相关异常
    115.      *
    116.      * @param e 异常
    117.      * @return 异常结果
    118.      */
    119.     @ExceptionHandler({
    120.             NoHandlerFoundException.class,
    121.             HttpRequestMethodNotSupportedException.class,
    122.             HttpMediaTypeNotSupportedException.class,
    123.             HttpMediaTypeNotAcceptableException.class,
    124.             MissingPathVariableException.class,
    125.             MissingServletRequestParameterException.class,
    126.             TypeMismatchException.class,
    127.             HttpMessageNotReadableException.class,
    128.             HttpMessageNotWritableException.class,
    129.             // BindException.class,
    130.             // MethodArgumentNotValidException.class
    131.             ServletRequestBindingException.class,
    132.             ConversionNotSupportedException.class,
    133.             MissingServletRequestPartException.class,
    134.             AsyncRequestTimeoutException.class
    135.     })
    136.  
    137.     public ResultTO handleServletException(Exception e) {
    138.         logger.error(e.getMessage(), e);
    139.         int code = CommonResponseEnum.SERVER_ERROR.getCode();
    140.         try {
    141.             ServletResponseEnum servletExceptionEnum = ServletResponseEnum.valueOf(e.getClass().getSimpleName());
    142.             code = servletExceptionEnum.getCode();
    143.         } catch (IllegalArgumentException e1) {
    144.             logger.error("class [{}] not defined in enum {}", e.getClass().getName(), ServletResponseEnum.class.getName());
    145.         }
    146.  
    147.         if (ENV_PROD.equals(profile)) {
    148.             // 当为生产环境, 不适合把具体的异常信息展示给用户, 比如404.
    149.             code = CommonResponseEnum.SERVER_ERROR.getCode();
    150.             BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);
    151.             String message = getMessage(baseException);
    152.             return ResultTO.FAILURE(message, code);
    153.         }
    154.  
    155.         return ResultTO.FAILURE(e.getMessage(), code);
    156.     }
    157.  
    158.  
    159.     /**
    160.      * 参数绑定异常
    161.      *
    162.      * @param e 异常
    163.      * @return 异常结果
    164.      */
    165.     @ExceptionHandler(value = BindException.class)
    166.     public ResultTO handleBindException(BindException e) {
    167.         logger.error("参数绑定校验异常", e);
    168.  
    169.         return wrapperBindingResult(e.getBindingResult());
    170.     }
    171.  
    172.     /**
    173.      * 参数校验(Valid)异常，将校验失败的所有异常组合成一条错误信息
    174.      *
    175.      * @param e 异常
    176.      * @return 异常结果
    177.      */
    178.     @ExceptionHandler(value = MethodArgumentNotValidException.class)
    179.     public ResultTO handleValidException(MethodArgumentNotValidException e) {
    180.         logger.error("参数绑定校验异常", e);
    181.  
    182.         return wrapperBindingResult(e.getBindingResult());
    183.     }
    184.  
    185.     /**
    186.      * 包装绑定异常结果
    187.      *
    188.      * @param bindingResult 绑定结果
    189.      * @return 异常结果
    190.      */
    191.     private ResultTO wrapperBindingResult(BindingResult bindingResult) {
    192.         StringBuilder msg = new StringBuilder();
    193.  
    194.         for (ObjectError error : bindingResult.getAllErrors()) {
    195.             msg.append(", ");
    196.             if (error instanceof FieldError) {
    197.                 msg.append(((FieldError) error).getField()).append(": ");
    198.             }
    199.             msg.append(error.getDefaultMessage() == null ? "" : error.getDefaultMessage());
    200.  
    201.         }
    202.  
    203.         return ResultTO.FAILURE(msg.substring(2), ArgumentResponseEnum.VALID_ERROR.getCode());
    204.     }
    205.  
    206.  
    207.     /**
    208.      * 获取国际化消息
    209.      *
    210.      * @param e 异常
    211.      * @return
    212.      */
    213.     public String getMessage(BaseException e) {
    214.         String code = "response." + e.getResponseEnum().toString();
    215.         String message = unifiedMessageSource.getMessage(code, e.getArgs());
    216.  
    217.         if (message == null || message.isEmpty()) {
    218.             return e.getMessage();
    219.         }
    220.         return message;
    221.     }
    222.  
    223. }

    这样项目抛出的异常就会到异常处理类中统一处理~~

    收工~！！

  • 相关阅读:
    十三、SpringBoot错误处理底层组件和异常处理流程分析
    GPU是什么?GPU有多重要?
    JavaScript 数据结构与算法3(链表)
    第二章《Java程序世界初探》第2节：常量的使用
    C++ 学习 之 成员指针
    基于web的医疗设备销售业务系统的设计与实现
    2022 ICPC Gran Premio de Mexico 1ra Fecha （B、D、E、F）
    Endnote 中批量导出PDF
    【LeetCode】2651.计算列车到站时间
    【虹科】物联网时代，加个网关or加个软件，设备上云原来如此简单
  • 原文地址：https://blog.csdn.net/feixiangdexiaozhidan/article/details/127689767