技术分享
⚠️统一异常处理
00 分钟
2024-7-28
2024-7-28
type
status
date
Jul 28, 2024 11:40 AM
slug
summary
category
tags
password
icon
统一响应CommonResult异常处理Spring MVC 的异常Filter 的异常业务异常ServiceExceptionServiceExceptionUtil错误码错误码分类系统错误码业务错误码

统一响应

后端提供 RESTful API 给前端时，需要响应前端 API 调用是否成功：
  • 如果成功，成功的数据是什么。后续，前端会将数据渲染到页面上
  • 如果失败，失败的原因是什么。一般，前端会将原因弹出提示给用户
因此，需要有统一响应，而不能是每个接口定义自己的风格。一般来说，统一响应返回信息如下：
  • 成功时，返回成功的状态码 + 数据
  • 失败时，返回失败的状态码 + 错误提示
在标准的 RESTful API 的定义，是推荐使用 HTTP 响应状态码作为状态码。一般来说，我们实践很少这么去做，主要原因如下：
  • 业务返回的错误状态码很多，HTTP 响应状态码无法很好的映射。例如说，活动还未开始、订单已取消等等
  • 学习成本高，开发者对 HTTP 响应状态码不是很了解。例如说，可能只知道 200、403、404、500 几种常见的

CommonResult

失败时的 code 字段，使用全局的错误码，稍后在 错误码 来讲解。
  1. 在 RESTful API 请求成功时，定义 Controller 对应方法的返回类型为 CommonResult，并调用 success(T data)方法来返回。例如：
      2. CommonResult 的 data 字段是泛型，建议定义对应的 VO 类，而不是使用 Map 类。
  1. 在 RESTful API 请求失败时，通过抛出 Exception 异常，具体在 「异常处理」 小节。

异常处理

RESTful API 发生异常时，需要拦截 Exception 异常，转换成统一响应的格式，否则前端无法处理。

Spring MVC 的异常

在 Spring MVC 中，通过 @ControllerAdvice + @ExceptionHandler 注解，声明将指定类型的异常，转换成对应的 CommonResult 响应。实现的代码如下：

Filter 的异常

在请求被 Spring MVC 处理之前，是先经过 Filter 处理的，此时发生异常时，是无法通过 @ExceptionHandler 注解来处理的。只能通过 try catch 的方式来实现，代码如下：

业务异常

在 Service 发生业务异常时，如果进行返回呢？例如说，用户名已经存在，商品库存不足等。常用的方案选择，主要有两种：
  1. 方案一，使用 CommonResult 统一响应结果，里面有错误码和错误提示，然后进行 return 返回
  1. 方案二，使用 ServiceException 统一业务异常，里面有错误码和错误提示，然后进行 throw 抛出
选择方案一 CommonResult 会存在两个问题：
  • 因为 Spring @Transactional 声明式事务，是基于异常进行回滚的，如果使用 CommonResult 返回，则事务回滚会非常麻烦
  • 当调用别的方法时，如果别人返回的是 CommonResult 对象，还需要不断的进行判断，写起来挺麻烦的
因此，采用方案二 ServiceException 异常。

ServiceException

定义 ServiceException 异常类，继承 RuntimeException 异常类，用于定义业务异常。代码如下：
为什么继承 RuntimeException 异常？
大多数业务场景下，我们无需处理 ServiceException 业务异常，而是通过 GlobalExceptionHandler 统一处理，转换成对应的 CommonResult 对象，进而提示给前端即可。
如果真的需要处理 ServiceException 时，通过 try catch 的方式进行主动捕获。

ServiceExceptionUtil

在 Service 需抛出业务异常时，通过调用 ServiceExceptionUtil 的 #exception(ErrorCode errorCode, Object... params) 方法来构建 ServiceException 异常，然后使用 throw 进行抛出。代码如下：
为什么使用 ServiceExceptionUtil 来构建 ServiceException 异常？
错误提示的内容，支持使用管理后台进行动态配置，所以通过 ServiceExceptionUtil 获取内容的配置与格式化。

错误码

错误码，对应 ErrorCode 类，枚举项目中的错误，全局唯一，方便定位是谁的错、错在哪。

错误码分类

错误码分成两类：全局的系统错误码、模块的业务错误码。

系统错误码

  • 全局的系统错误码，使用 0-999 错误码段，和 HTTP 响应状态码 对应。虽然说，HTTP 响应状态码作为业务使用表达能力偏弱，但是使用在系统层面还是非常不错的。
  • 全局的系统错误码定义在 GlobalErrorCodeConstants类，代码如下：

业务错误码

模块的业务错误码，按照模块分配错误码的区间，避免模块之间的错误码冲突。
业务错误码一共 10 位，分成 4 段，按照如下规则分配：
每个业务模块，定义自己的 ErrorCodeConstants错误码枚举类。以 system 模块为例，代码如下：
 
评论
Loading...