阿里跳槽来的工程师,写个try catch的方式都这么优雅!

大家好，我是小乐。

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

优雅的 Controller

什么是统一异常处理

不同阶段的异常

目标

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

统一异常处理实战

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

用 Assert(断言) 替换 throw exception

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

@Testpublicvoidtest1() {        ...        User user = userDao.selectById(userId);        Assert.notNull(user, "用户不存在.");        ...    }@Testpublicvoidtest2() {// 另一种写法        User user = userDao.selectById(userId);if (user == null) {thrownew IllegalArgumentException("用户不存在.");        }    }

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

publicabstractclassAssert {publicAssert() {    }publicstaticvoidnotNull(@Nullable Object object, String message) {if (object == null) {thrownew IllegalArgumentException(message);        }    }}

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

AssertpublicinterfaceAssert {/**     * 创建异常     * @param args     * @return     */    BaseException newException(Object... args);/**     * 创建异常     * @param t     * @param args     * @return     */    BaseException newException(Throwable t, Object... args);/**     * <p>断言对象<code>obj</code>非空。如果对象<code>obj</code>为空，则抛出异常     *     * @param obj 待判断对象     */defaultvoidassertNotNull(Object obj) {if (obj == null) {throw newException(obj);        }    }/**     * <p>断言对象<code>obj</code>非空。如果对象<code>obj</code>为空，则抛出异常     * <p>异常信息<code>message</code>支持传递参数方式，避免在判断之前进行字符串拼接操作     *     * @param obj 待判断对象     * @param args message占位符对应的参数列表     */defaultvoidassertNotNull(Object obj, Object... args) {if (obj == null) {throw newException(args);        }    }}

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

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

善解人意的 Enum

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

publicinterfaceIResponseEnum {intgetCode();    String getMessage();}/** * <p>业务异常</p> * <p>业务处理时，出现异常，可以抛出该异常</p> */publicclassBusinessExceptionextendsBaseException {privatestaticfinallong serialVersionUID = 1L;publicBusinessException(IResponseEnum responseEnum, Object[] args, String message) {super(responseEnum, args, message);    }publicBusinessException(IResponseEnum responseEnum, Object[] args, String message, Throwable cause) {super(responseEnum, args, message, cause);    }}publicinterfaceBusinessExceptionAssertextendsIResponseEnum, Assert {@Overridedefault BaseException newException(Object... args) {        String msg = MessageFormat.format(this.getMessage(), args);returnnew BusinessException(this, args, msg);    }@Overridedefault BaseException newException(Throwable t, Object... args) {        String msg = MessageFormat.format(this.getMessage(), args);returnnew BusinessException(this, args, msg, t);    }}@Getter@AllArgsConstructorpublicenum ResponseEnum implements BusinessExceptionAssert {/**     * Bad licence type     */    BAD_LICENCE_TYPE(7001, "Bad licence type."),/**     * Licence not found     */    LICENCE_NOT_FOUND(7002, "Licence not found.")    ;/**     * 返回码     */privateint code;/**     * 返回消息     */private String message;}

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

/**     * 校验{@link Licence}存在     * @param licence     */privatevoidcheckNotNull(Licence licence) {        ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);    }

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

privatevoidcheckNotNull(Licence licence) {if (licence == null) {thrownew LicenceNotFoundException();// 或者这样thrownew BusinessException(7001, "Bad licence type.");        }    }

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

定义统一异常处理器类

@Slf4j@Component@ControllerAdvice@ConditionalOnWebApplication@ConditionalOnMissingBean(UnifiedExceptionHandler.class)publicclassUnifiedExceptionHandler {/**     * 生产环境     */privatefinalstatic String ENV_PROD = "prod";@Autowiredprivate UnifiedMessageSource unifiedMessageSource;/**     * 当前环境     */@Value("${spring.profiles.active}")private String profile;/**     * 获取国际化消息     *     * @param e 异常     * @return     */public String getMessage(BaseException e) {        String code = "response." + e.getResponseEnum().toString();        String message = unifiedMessageSource.getMessage(code, e.getArgs());if (message == null || message.isEmpty()) {return e.getMessage();        }return message;    }/**     * 业务异常     *     * @param e 异常     * @return 异常结果     */@ExceptionHandler(value = BusinessException.class)@ResponseBodypublic ErrorResponse handleBusinessException(BaseException e) {        log.error(e.getMessage(), e);returnnew ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));    }/**     * 自定义异常     *     * @param e 异常     * @return 异常结果     */@ExceptionHandler(value = BaseException.class)@ResponseBodypublic ErrorResponse handleBaseException(BaseException e) {        log.error(e.getMessage(), e);returnnew ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));    }/**     * Controller上一层相关异常     *     * @param e 异常     * @return 异常结果     */@ExceptionHandler({            NoHandlerFoundException.class,            HttpRequestMethodNotSupportedException.class,            HttpMediaTypeNotSupportedException.class,            MissingPathVariableException.class,            MissingServletRequestParameterException.class,            TypeMismatchException.class,            HttpMessageNotReadableException.class,            HttpMessageNotWritableException.class,            // BindException.class,            // MethodArgumentNotValidException.class            HttpMediaTypeNotAcceptableException.class,            ServletRequestBindingException.class,            ConversionNotSupportedException.class,            MissingServletRequestPartException.class,            AsyncRequestTimeoutException.class    })@ResponseBodypublic ErrorResponse handleServletException(Exception e) {        log.error(e.getMessage(), e);int code = CommonResponseEnum.SERVER_ERROR.getCode();try {            ServletResponseEnum servletExceptionEnum = ServletResponseEnum.valueOf(e.getClass().getSimpleName());            code = servletExceptionEnum.getCode();        } catch (IllegalArgumentException e1) {            log.error("class [{}] not defined in enum {}", e.getClass().getName(), ServletResponseEnum.class.getName());        }if (ENV_PROD.equals(profile)) {            // 当为生产环境, 不适合把具体的异常信息展示给用户, 比如404.            code = CommonResponseEnum.SERVER_ERROR.getCode();            BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);            String message = getMessage(baseException);returnnew ErrorResponse(code, message);        }returnnew ErrorResponse(code, e.getMessage());    }/**     * 参数绑定异常     *     * @param e 异常     * @return 异常结果     */@ExceptionHandler(value = BindException.class)@ResponseBodypublic ErrorResponse handleBindException(BindException e) {        log.error("参数绑定校验异常", e);return wrapperBindingResult(e.getBindingResult());    }/**     * 参数校验异常，将校验失败的所有异常组合成一条错误信息     *     * @param e 异常     * @return 异常结果     */@ExceptionHandler(value = MethodArgumentNotValidException.class)@ResponseBodypublic ErrorResponse handleValidException(MethodArgumentNotValidException e) {        log.error("参数绑定校验异常", e);return wrapperBindingResult(e.getBindingResult());    }/**     * 包装绑定异常结果     *     * @param bindingResult 绑定结果     * @return 异常结果     */private ErrorResponse wrapperBindingResult(BindingResult bindingResult) {        StringBuilder msg = new StringBuilder();for (ObjectError error : bindingResult.getAllErrors()) {            msg.append(", ");if (error instanceof FieldError) {                msg.append(((FieldError) error).getField()).append(": ");            }            msg.append(error.getDefaultMessage() == null ? "" : error.getDefaultMessage());        }returnnew ErrorResponse(ArgumentResponseEnum.VALID_ERROR.getCode(), msg.substring(2));    }/**     * 未定义异常     *     * @param e 异常     * @return 异常结果     */@ExceptionHandler(value = Exception.class)@ResponseBodypublic ErrorResponse handleException(Exception e) {        log.error(e.getMessage(), e);if (ENV_PROD.equals(profile)) {// 当为生产环境, 不适合把具体的异常信息展示给用户, 比如数据库异常信息.int code = CommonResponseEnum.SERVER_ERROR.getCode();            BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);            String message = getMessage(baseException);returnnew ErrorResponse(code, message);        }returnnew ErrorResponse(CommonResponseEnum.SERVER_ERROR.getCode(), e.getMessage());    }}

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

• 自定义异常: handleBusinessException、handleBaseException

• 未知异常: handleException

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

异常处理器说明

handleServletException

handleBindException

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

handleValidException

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

handleBusinessException、handleBaseException

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

handleException

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

异于常人的 404

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

Whitelabel Error Page

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

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

spring.mvc.throw-exception-if-no-handler-found=truespring.resources.add-mappings=false

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

捕获 404 对应的异常

统一返回结果

验证统一异常处理

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

主要代码

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

@ServicepublicclassLicenceServiceextendsServiceImpl<LicenceMapper, Licence> {@Autowiredprivate OrganizationClient organizationClient;/**     * 查询{@link Licence} 详情     * @param licenceId     * @return     */public LicenceDTO queryDetail(Long licenceId) {        Licence licence = this.getById(licenceId);        checkNotNull(licence);        OrganizationDTO org = ClientUtil.execute(() -> organizationClient.getOrganization(licence.getOrganizationId()));return toLicenceDTO(licence, org);    }/**     * 分页获取     * @param licenceParam 分页查询参数     * @return     */public QueryData<SimpleLicenceDTO> getLicences(LicenceParam licenceParam) {        String licenceType = licenceParam.getLicenceType();        LicenceTypeEnum licenceTypeEnum = LicenceTypeEnum.parseOfNullable(licenceType);// 断言, 非空        ResponseEnum.BAD_LICENCE_TYPE.assertNotNull(licenceTypeEnum);        LambdaQueryWrapper<Licence> wrapper = new LambdaQueryWrapper<>();        wrapper.eq(Licence::getLicenceType, licenceType);        IPage<Licence> page = this.page(new QueryPage<>(licenceParam), wrapper);returnnew QueryData<>(page, this::toSimpleLicenceDTO);    }/**     * 新增{@link Licence}     * @param request 请求体     * @return     */@Transactional(rollbackFor = Throwable.class)public LicenceAddRespData addLicence(LicenceAddRequest request) {        Licence licence = new Licence();        licence.setOrganizationId(request.getOrganizationId());        licence.setLicenceType(request.getLicenceType());        licence.setProductName(request.getProductName());        licence.setLicenceMax(request.getLicenceMax());        licence.setLicenceAllocated(request.getLicenceAllocated());        licence.setComment(request.getComment());this.save(licence);returnnew LicenceAddRespData(licence.getLicenceId());    }/**     * entity -> simple dto     * @param licence {@link Licence} entity     * @return {@link SimpleLicenceDTO}     */private SimpleLicenceDTO toSimpleLicenceDTO(Licence licence) {// 省略    }/**     * entity -> dto     * @param licence {@link Licence} entity     * @param org {@link OrganizationDTO}     * @return {@link LicenceDTO}     */private LicenceDTO toLicenceDTO(Licence licence, OrganizationDTO org) {// 省略    }/**     * 校验{@link Licence}存在     * @param licence     */privatevoidcheckNotNull(Licence licence) {        ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);    }}

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

-- licenceINSERT INTO licence(licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)VALUES(1, 1, 'user','CustomerPro', 100,5);INSERT INTO licence(licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)VALUES(2, 1, 'user','suitability-plus', 200,189);INSERT INTO licence(licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)VALUES(3, 2, 'user','HR-PowerSuite', 100,4);INSERT INTO licence(licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)VALUES(4, 2, 'core-prod','WildCat Application Gateway', 16,16);-- organizationsINSERT INTO organization(id, name, contact_name, contact_email, contact_phone)VALUES(1, 'customer-crm-co', 'Mark Balster', 'mark.balster@custcrmco.com', '823-555-1212');INSERT INTO organization(id, name, contact_name, contact_email, contact_phone)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

校验非空

捕获 Bad licence type 异常

Bad licence type

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

捕获 404 异常

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

PostMapping

捕获 Request method not supported 异常

Request method not supported

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

getLicences

LicenceParam

捕获参数绑定校验异常

licence type cannot be empty

addLicence

LicenceAddRequest

请求 url 即结果

捕获参数绑定校验异常

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

异常信息的收集

捕获未知异常

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

增加 test 字段

捕获数据库异常

Error querying database

小结

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

扩展

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

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

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

修改当前环境为生产环境

总结

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

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

@Slf4j@RestControllerAdvicepublicclassGlobalExceptionHandler {/**     * 没有登录     * @param request     * @param response     * @param e     * @return     */@ExceptionHandler(NoLoginException.class)public Object noLoginExceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)    {        log.error("[GlobalExceptionHandler][noLoginExceptionHandler] exception",e);        JsonResult jsonResult = new JsonResult();        jsonResult.setCode(JsonResultCode.NO_LOGIN);        jsonResult.setMessage("用户登录失效或者登录超时,请先登录");return jsonResult;    }/**     * 业务异常     * @param request     * @param response     * @param e     * @return     */@ExceptionHandler(ServiceException.class)public Object businessExceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)    {        log.error("[GlobalExceptionHandler][businessExceptionHandler] exception",e);        JsonResult jsonResult = new JsonResult();        jsonResult.setCode(JsonResultCode.FAILURE);        jsonResult.setMessage("业务异常,请联系管理员");return jsonResult;    }/**     * 全局异常处理     * @param request     * @param response     * @param e     * @return     */@ExceptionHandler(Exception.class)public Object exceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)    {        log.error("[GlobalExceptionHandler][exceptionHandler] exception",e);        JsonResult jsonResult = new JsonResult();        jsonResult.setCode(JsonResultCode.FAILURE);        jsonResult.setMessage("系统错误,请联系管理员");return jsonResult;    }}

为了跟上AI时代我干了一件事儿，我创建了一个知识星球社群：ChartGPT与副业。想带着大家一起探索ChatGPT和新的AI时代。
有很多小伙伴搞不定ChatGPT账号，于是我们决定，凡是这三天之内加入ChatPGT的小伙伴，我们直接送一个正常可用的永久ChatGPT独立账户。
不光是增长速度最快，我们的星球品质也绝对经得起考验，短短一个月时间，我们的课程团队发布了8个专栏、12个副业项目：