作者:巨人大哥 try {...} catch {...} finally {...} 代码块,不仅有大量的冗余代码,而且还影响代码的可读性。Controller 层,如果是在Service 层,可能会有更多的try catch 代码块。这将会严重影响代码的可读性、“美观性”。什么是统一异常处理Spring 在3.2版本增加了一个注解@ControllerAdvice ,可以与@ExceptionHandler 、@InitBinder 、@ModelAttribute 等注解注解配套使用。@ExceptionHandler ,从字面上看,就是 异常处理器 的意思,其实际作用也是:若在某个Controller 类定义一个异常处理方法,并在方法上添加该注解,那么当出现指定的异常时,会执行该处理异常的方法,其可以使用springmvc提供的数据绑定,比如注入HttpServletRequest等,还可以接受一个当前抛出的Throwable对象。Controller 类都定义一套这样的异常处理方法,因为异常可以是各种各样。这样一来,就会造成大量的冗余代码,而且若需要新增一种异常的处理逻辑,就必须修改所有Controller 类了,很不优雅。BaseController 的基类,这样总行了吧。Controller ,我为啥非得继承这样一个类呢,万一已经继承其他基类了呢。大家都知道Java 只能继承一个类。Controller 耦合,也可以将定义的 异常处理器 应用到所有控制器呢?所以注解@ControllerAdvice 出现了,简单的说,该注解可以把异常处理器应用到所有控制器,而不是单个控制器。@ControllerAdvice ,统一对 不同阶段的 、不同异常 进行处理。这就是统一异常处理的原理。Controller 前的异常 和 Service 层异常,具体可以参考下图:目标try catch 代码块,以优雅的 Assert (断言) 方式来校验业务的异常情况,只关注业务逻辑,而不用花费大量精力写冗余的 try catch 代码块。统一异常处理实战用 Assert(断言) 替换 throw exceptionAssert(断言) 大家都很熟悉,比如 Spring 家族的 org.springframework.util.Assert ,在我们写测试用例的时候经常会用到,使用断言能让我们编码的时候有一种非一般丝滑的感觉,比如:public void test1() { ... User user = userDao.selectById(userId); Assert.notNull(user, '用户不存在.'); ... } @Test public void test2() { // 另一种写法 User user = userDao.selectById(userId); if (user == null) { throw new IllegalArgumentException('用户不存在.'); } } if {...} 代码块。那么
神奇的 Assert.notNull() 背后到底做了什么呢?下面是 Assert 的部分源码:
Assert 其实就是帮我们把 if {...} 封装了一下,是不是很神奇。虽然很简单,但不可否认的是编码体验至少提升了一个档次。那么我们能不能模仿org.springframework.util.Assert ,也写一个断言类,不过断言失败后抛出的异常不是IllegalArgumentException 这些内置异常,而是我们自己定义的异常。下面让我们来尝试一下。public interface Assert { /** * 创建异常 * @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 待判断对象 */ default void assertNotNull(Object obj) { if (obj == null) { throw newException(obj); } } /** * <p>断言对象<code>obj</code>非空。如果对象<code>obj</code>为空,则抛出异常 * <p>异常信息<code>message</code>支持传递参数方式,避免在判断之前进行字符串拼接操作 * * @param obj 待判断对象 * @param args message占位符对应的参数列表 */ default void assertNotNull(Object obj, Object... args) { if (obj == null) { throw newException(args); } } } Assert 断言方法是使用接口的默认方法定义的,然后有没有发现当断言失败后,抛出的异常不是具体的某个异常,而是交由2个newException 接口方法提供。null ,此时抛出的异常可能为UserNotFoundException ,并且有特定的异常码(比如7001)和异常信息“用户不存在”。所以具体抛出什么异常,有Assert 的实现类决定。善解人意的EnumBaseException 有2个属性,即code 、message ,这样一对属性,有没有想到什么类一般也会定义这2个属性?没错,就是枚举类。且看我如何将 Enum 和 Assert 结合起来,相信我一定会让你眼前一亮。如下:
BAD_LICENCE_TYPE 、LICENCE_NOT_FOUND ,分别对应了BadLicenceTypeException 、LicenceNotFoundException 两种异常。LicenceService 有校验Licence 是否存在的方法,如下:* 校验{@link Licence}存在 * @param licence */ private void checkNotNull(Licence licence) { ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence); }
Assert ,只需根据特定的异常情况定义不同的枚举实例,如上面的BAD_LICENCE_TYPE 、LICENCE_NOT_FOUND ,就能够针对不同情况抛出特定的异常(这里指携带特定的异常码和异常消息),这样既不用定义大量的异常类,同时还具备了断言的良好可读性,当然这种方案的好处远不止这些,请继续阅读后文,慢慢体会。
定义统一异常处理器类@Component @ControllerAdvice @ConditionalOnWebApplication @ConditionalOnMissingBean(UnifiedExceptionHandler.class) public class UnifiedExceptionHandler { /** * 生产环境 */ private final static String ENV_PROD = 'prod'; @Autowired private 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) @ResponseBody public ErrorResponse handleBusinessException(BaseException e) { log.error(e.getMessage(), e); return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e)); } /** * 自定义异常 * * @param e 异常 * @return 异常结果 */ @ExceptionHandler(value = BaseException.class) @ResponseBody public ErrorResponse handleBaseException(BaseException e) { log.error(e.getMessage(), e); return new 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 }) @ResponseBody public 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); return new ErrorResponse(code, message); } return new ErrorResponse(code, e.getMessage()); } /** * 参数绑定异常 * * @param e 异常 * @return 异常结果 */ @ExceptionHandler(value = BindException.class) @ResponseBody public ErrorResponse handleBindException(BindException e) { log.error('参数绑定校验异常', e); return wrapperBindingResult(e.getBindingResult()); } /** * 参数校验异常,将校验失败的所有异常组合成一条错误信息 * * @param e 异常 * @return 异常结果 */ @ExceptionHandler(value = MethodArgumentNotValidException.class) @ResponseBody public 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()); } return new ErrorResponse(ArgumentResponseEnum.VALID_ERROR.getCode(), msg.substring(2)); } /** * 未定义异常 * * @param e 异常 * @return 异常结果 */ @ExceptionHandler(value = Exception.class) @ResponseBody public 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); return new ErrorResponse(code, message); } return new ErrorResponse(CommonResponseEnum.SERVER_ERROR.getCode(), e.getMessage()); } } ServletException 、ServiceException ,还记得上文提到的 按阶段分类 吗,即对应 进入Controller 前的异常 和 Service 层异常;然后 ServiceException 再分成自定义异常、未知异常。对应关系如下:
异常处理器说明handleServletExceptionhttp 请求,在到达Controller 前,会对该请求的请求信息与目标控制器信息做一系列校验。这里简单说一下:Url 查找有没有对应的控制器,若没有则会抛该异常,也就是大家非常熟悉的404 异常;http 方法不同,如:Get、Post等),则尝试将请求的http 方法与列表的控制器做匹配,若没有对应http 方法的控制器,则抛该异常;content-type 请求头,若控制器的参数签名包含注解@RequestBody ,但是请求的content-type 请求头的值没有包含application/json ,那么会抛该异常(当然,不止这种情况会抛这个异常);/licence/{licenceId} ,参数签名包含@PathVariable('licenceId') ,当请求的url为/licence ,在没有明确定义url为/licence 的情况下,会被判定为:缺少路径参数;HttpMediaTypeNotSupportedException 举的例子完全相反,即请求头携带了'content-type: application/json;charset=UTF-8' ,但接收参数却没有添加注解@RequestBody ,或者请求体携带的 json 串反序列化成 pojo 的过程中失败了,也会抛该异常;handleBindExceptionhandleValidExceptionhandleBusinessException、handleBaseExceptionhandleBaseException 处理的是除了 BusinessException 意外的所有业务异常。就目前来看,这2个是可以合并成一个的。handleException
异于常人的404NoHandlerFoundException 异常,但其实默认情况下不是这样,默认情况下会出现类似如下页面:forward 跳转到/error 控制器,spring 也提供了默认的error 控制器,如下:properties 文件中加入如下配置即可:
统一返回结果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 包。主要代码public class LicenceService extends ServiceImpl<LicenceMapper, Licence> { @Autowired private 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); return new 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); return new 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 */ private void checkNotNull(Licence licence) { ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence); } } mybatis-plus 。启动时,自动插入的数据为:
开始验证捕获自定义异常licence 详情:http://localhost:10000/licence/5。成功响应的请求:licenceId=1licence type 获取 licence 列表:http://localhost:10000/licence/list?licenceType=ddd。可选的 licence type 为:user、core-prod 。捕获未知异常Licence 新增一个字段 test ,但不修改数据库表结构,然后访问:http://localhost:10000/licence/1。小结code 、message 的形式返回。每一个项目/模块,在定义业务异常的时候,只需定义一个枚举类,然后实现接口 BusinessExceptionAssert ,最后为每一种业务异常定义对应的枚举实例即可,而不用定义许多异常类。使用的时候也很方便,用法类似断言。ServletException ,因为都是一长串的异常信息,若直接展示给用户看,显得不够专业,于是,我们可以这样做:当检测到当前环境是生产环境,那么直接返回 '网络异常'。总结spring cloud security 后,还会有认证/授权异常,网关的服务降级异常、跨模块调用异常、远程调用第三方服务异常等,这些异常的捕获方式与本文介绍的不太一样,不过限于篇幅,这里不做详细说明,以后会有单独的文章介绍。@RestControllerAdvice public class GlobalExceptionHandler { /** * 没有登录 * @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; } } |
|