30. SpringBoot全局异常处理

PangHu大约 5 分钟

1. 前言🔥

今天和大家讨论的是Spring Boot如何统一处理异常。这里先说一下我们为什么需要全局统一处理异常？其实理由很简单，因为程序在运行的过程中，不可避免会产生各种各样的错误。比如说用户传过来的参数不正确，无法连接上数据库，或者在计算某个任务的时候超时等。所以我们一般需要合理的抛出各种异常信息。这些异常信息，一旦不处理，前端就会得到一个500的服务器内部错误，直接展示非常的不友好不优雅，所以我们需要将这些异常捕获，并告知前端，到底错在了哪里。另一个问题是，我们不可能直接将完整的异常信息返回，因为可能涉及到一些内部的重要信息，不能随意泄露，所以我们还需要对异常信息进行过滤和转换，值给前端返回可读的，简洁的，准确的说明信息。

这就是为什么我们需要全局异常处理。

2. 环境说明🔥

本地的开发环境：
开发工具：IDEA 2021.3
JDK版本： JDK 1.8
Spring Boot版本：2.3.1 RELEASE
Maven版本：3.8.2

3. 正文🔥

这里bug菌提供的一种思路是使用全局异常处理器。全局异常处理器不仅能够捕获默认的异常，还能够捕获各种自定义异常。一个简单的全局异常处理器代码如下：

3.1 定义全局异常处理器

GlobalExceptionHandler.java

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

    private Map<String, Object> getResult(ErrorCodeEnum e, boolean status) {
        Map<String, Object> map = new HashMap<>();
        map.put("success", status);
        map.put("code", e.getKey());
        map.put("msg", e.getValue());
        return map;
    }

    /**
     * 参数校验不通过
     *
     * @param e       异常信息
     * @param request 请求信息
     */
    @ExceptionHandler(value = ParamsException.class)
    @ResponseStatus(HttpStatus.OK)
    public Map<String, Object> handleObjectExistException(ParamsException e,
                                                          HttpServletRequest request) {
        return getResult(ErrorCodeEnum.PARAM_EXIST_EXCEPTION, false);
    }

    /**
     * 用户校验不通过
     *
     * @param e       异常信息
     * @param request 请求信息
     */
    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler(value = TokenExpireException.class)
    public Map<String, Object> handle(TokenExpireException e, HttpServletRequest request) {
        return getResult(ErrorCodeEnum.USER_NOT_LOGIN, false);
    }

    /**
     * 全局异常处理
     *
     * @param e       异常信息
     * @param request 请求信息
     */
    @ResponseStatus()
    @ExceptionHandler(value = Throwable.class)
    public Map<String, Object> handle(Exception e, HttpServletRequest request) {
        return getResult(ErrorCodeEnum.SYSTEM_ERROR, false);
    }


}

这里我对所有的异常信息返回结果都做了统一的处理，只返回success，code，msg三个字段。在内部封装了一个getResult私有方法，便于统一处理，然后分别使用不同的方法处理不同的异常信息，比如ParamsException，TokenExpireException，SystemRunningException等

以上的这仨皆属于自定义异常，代码如下：

3.2 定义参数异常ParamsException类

这里先定义参数异常的信息扑捉，思路也比较简单，就是除了msg之外，不需要接收code，只便于更加灵活的实现返回值数据。

public class ParamsException extends RuntimeException {

    private static final long serialVersionUID = 1L;

    private String message;

    public ParamsException() {
    }

    public ParamsException(String msg) {
        this.message = msg;
    }

    public ParamsException(ErrorCodeEnum e) {
        this.message = e.getValue();
    }

    @Override
    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

3.3 定义异常TokenExpireException类

这里我们再来定义一个扑捉token用户登陆信息过期的异常类，目的是更直接用于相关token异常信息的捕捉。由于我们直接也是定义了默认的token Error错误码枚举，顾我们也是只需要定义msg信息的接收即可，但如果你都想自定义，那你就把对应的code、success、msg都定义赋值也行，具体代码如下：

package com.example.demo.exception;

import com.example.demo.enums.ErrorCodeEnum;

/**
 * 用户登陆信息过期异常
 */
public class TokenExpireException extends RuntimeException {

    private static final long serialVersionUID = 1L;

    private String message;

    public TokenExpireException() {
    }

    public TokenExpireException(String msg) {
        this.message = msg;
    }

    public TokenExpireException(ErrorCodeEnum e) {
        this.message = e.getValue();
    }

    @Override
    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

}

3.4 定义一个ExceptionController测试

这里我们写两个接口直接模拟异常返回，查阅具体的异常信息是否被正常捕捉，然后其他的测试你们就自己玩啦，这里给大家举个例子。

3.4.1 测试参数异常

我们直接定义一个Get请求，然后设置一个参数，我们在传值的过程中，我们直接传空，我们即可验证是否能捕获参数异常的全局信息返回。

@RestController
@RequestMapping("/exception")
@Api(tags = "全局异常测试模块", description = "全局异常测试模块")
public class ExceptionController {

    @Autowired
    private UserService userService;

    /**
     * 根据用户id查询用户信息
     */
    @GetMapping("/find-user-by-id")
    @ApiOperation(value = "根据用户id查询用户信息", notes = "根据用户id查询用户信息")
    public ResultResponse<UserEntity> saveUser(@RequestParam("userId") String userId) throws ParamsException {
        if (StringUtils.isBlank(userId)) {
            throw new ParamsException(PARAM_EXIST_EXCEPTION);
        }
        return new ResultResponse<>(userService.getById(userId));
    }
}

3.4.2 Swagger请求校验

重启项目，我们将userId参数传空格，我们直接请求，可以看看接口返回体具体是啥内容？

可以看到，正是我们展示的PARAM_EXIST_EXCEPTION(101001, "参数异常")这句，我们也可以自定义，也可以采用默认的提示，成功的并统一处理了返回结果。

3.4.3 测试token异常

测试代码如下，仅供参考：

less复制代码    @GetMapping("/login")
    @ApiOperation(value = "登录", notes = "登录")
    public ResultResponse<Boolean> login(@RequestParam("token") String token) throws TokenExpireException {
        throw new TokenExpireException();
    }

3.4.4 Swagger请求校验

重启项目后请求一遍，可以看下接口的返回值如下：

可以发现，我们成功的捕获到了默认的Exception异常和自定义的TokenExpireException

异常，并统一处理了返回结果。

两轮测试结果比较令人满意，希望能帮助到大家，剩下的测试或者自定义异常，你们可以大胆发挥，这里我就不一一赘述啦。

3.5 附上接口返回错误码枚举类

具体代码如下，仅供参考：

typescript复制代码/**
 * 接口返回错误码枚举
 */
public enum ErrorCodeEnum implements IEnum {

    /* 系统异常 */
    SYSTEM_RUNNING(100000, "系统运行异常"),
    SYSTEM_ERROR(101000, "系统未知异常"),
    PARAM_EXIST_EXCEPTION(101001, "参数异常"),

    /* token相关 */
    TOKEN_IS_EMPTY(102001, "该请求没有携带token！请先获取token"),
    TOKEN_IS_INVALID(102002, "token失效，请重新登录！"),
    TOKEN_IS_ERROR(102003, "非法token！请重新登录！"),
    USER_NOT_LOGIN(103006, "请先登录"),


    ;
    private Integer key;
    private String value;

    ErrorCodeEnum(Integer key, String value) {
        this.key = key;
        this.value = value;
    }

    @Override
    public Integer getKey() {
        return this.key;
    }

    @Override
    public String getValue() {
        return this.value;
    }

}

... ...

ok，以上就是我这期的全部内容啦