如何用SpringBoot优雅地对异常进行统一的捕获和处理呢？

​

一、 前言

在日常项目开发中，异常是常见的，但是如何更高效的处理好异常信息，让我们能快速定位到BUG，是很重要的，不仅能够提高我们的开发效率，还能让你代码看上去更舒服，SpringBoot的项目已经对有一定的异常处理了，但是对于我们开发者而言可能就不太合适了，因此我们需要对这些异常进行统一的捕获并处理。

如果不进行异常处理，当出现错误的时候，返回的信息可能是如下图这样的:

​

二、异常分类 1. 从定义角度的异常分类

​

(1). Error（错误）

程序在执行过程中所遇到的硬件或 *** 作系统的错误。错误对程序而言是致命的，将导致程序无法运行。常见的错误有内存溢出，jvm 虚拟机自身的非正常运行，calss 文件没有主方法。程序本生是不能处理错误的，只能依靠外界干预。Error 是系统内部的错误，由 jvm 抛出，交给系统来处理。

(2). Exception（错误）

是程序正常运行中，可以预料的意外情况。比如数据库连接中断，空指针，数组下标越界。异常出现可以导致程序非正常终止，也可以预先检测，被捕获处理掉，使程序继续运行。 EXCEPTION（异常）按照性质，又分为编译异常（可检测）和运行时异常（不可检测）。

a.编译时异常

又叫可检查异常，通常时由语法错和环境因素（外部资源）造成的异常。比如输入输出异常 IOException，数据库 *** 作 SQLException。其特点是，Java 语言强制要求捕获和处理所有非运行时异常。通过行为规范，强化程序的健壮性和安全性。

b.运行时异常

又叫不检查异常 RuntimeException，这些异常一般是由程序逻辑错误引起的，即语义错。比如算术异常，空指针异常 NullPointerException，下标越界 IndexOutOfBoundsException。运行时异常应该在程序测试期间被暴露出来，由程序员去调试，而避免捕获。

2. 从开发的角度对异常分类

我们也可以把异常分类已知异常和未知异常。

(1). 已知异常

代表我们可以控制的异常，比如当一个资源没找到的时候，要返回给前端，抛出资源没有找到。 当校验参数的时候，参数缺失，抛出参数缺失给前端。

(2). 未知异常

代表我们也不知道什么时候程序可能会报错，可能某个地方判断不严谨，导致空指针或下标越界等。

三、如何优雅的进行异常捕获（重点是已知异常的处理）

我们知道，使用springboot的时候，我们可以使用@ControllerAdvice和@ExceptionHandler对异常进行全局异常捕获，但如何做，才能使异常捕获更加的优雅呢？

我们可以从已知异常和未知异常进行自定义的异常处理。

1. 未知异常的处理

1. 新建一个GlobalExceptionAdvice全局异常处理的类，加上@ControllerAdvice注解
2. 捕获Exception.class

@ExceptionHandler(Exception.class)
    @ResponseBody
    @ResponseStatus(code = HttpStatus.INTERNAL_SERVER_ERROR)
    public ReturnMsgEntity handlerException(HttpServletRequest request, Exception e) {
        String uri = request.getRequestURI();
        String method = request.getMethod();
        ReturnMsgEntity message = new ReturnMsgEntity(9999, codeConfiguration.getMessage(9999), null, method + "  " + uri);
        return message;
    }
复制代码

解释: 为了防止硬编码，写了一个codeConfiguration配置类，作用是读取某个路径下的文件，封装成一个map

@Component
@ConfigurationProperties(prefix="aisino")
@PropertySource("classpath:config/exception-code.properties")
public class ExceptionCodeConfiguration {
    private Map codes = new HashMap<>();

    public  String getMessage(int code){
        return codes.get(code);
    }

    public Map getCodes() {
        return codes;
    }

    public void setCodes(Map codes) {
        this.codes = codes;
    }
}
复制代码

exception-code.properties配置文件如下:

aisino.codes[9999] = 服务器未知异常

aisino.codes[10000] = 通用异常

aisino.codes[10001] = 通用参数错误

aisino.codes[0] = ok

aisino.codes[10002] = 资源未找到

复制代码

1. 以上对于未知异常的处理就完事了，看看效果，模拟一个空指针异常的接口，访问结果如下

​

2. 已知异常的处理（重点）

已知异常有很多种，比如禁止访问，参数缺失，没有找到资源，没有认证，难道我们要把每个错误都写在GlobalExceptionAdvice类中吗？这样写是不是不容易维护，比如当资源不存在该如何抛出呢？

针对以上问题，可以在GlobalExceptionAdvice中捕获一个自己定义的HttpException，其他的错误类都HttpException，HttpException又继承RuntimeException类，这样我们就可以实现抛出自己定义的错误了，具体的HttpException类如下:

public class HttpException extends RuntimeException{
    //自定义错误码
    protected Integer code;
    // 默认的状态码
    protected Integer httpStatusCode = 500;

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public Integer getHttpStatusCode() {
        return httpStatusCode;
    }

    public void setHttpStatusCode(Integer httpStatusCode) {
        this.httpStatusCode = httpStatusCode;
    }
}

复制代码

我们还需要定义其他具体的子类，继承上面的类，比如NotFoundException,如下代码:

public class NotFoundException extends HttpException {
    public NotFoundException(int code){
        this.httpStatusCode = 404;
        this.code = code;
    }
}
复制代码

在GlobalExceptionAdvice中就可以捕获HttpException类了，代码如下:

@ExceptionHandler(HttpException.class)
    @ResponseBody
    public ResponseEntity handlerHttpException(HttpServletRequest request, HttpException e) {
        // 获得请求路径
        String requestUrl = request.getRequestURI();
        // 获得请求方法
        String method = request.getMethod();
        // e.getcode 根据我们自定义的状态码获取具体的错误信息
        ReturnMsgEntity message = new ReturnMsgEntity(e.getCode(), codeConfiguration.getMessage(e.getCode()), null, method + "  " + requestUrl);
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        // 设置我们自定义的http状态码，比如404对应资源没找到，前端收到的状态码不是200，是404了
        HttpStatus httpStatus = HttpStatus.resolve(e.getHttpStatusCode());
        ResponseEntity responseEntity = new ResponseEntity<>(message, headers, httpStatus);
        return responseEntity;

    }
复制代码

最后我们使用一下，比如：

​

​当查不到用户信息的时候，返回信息如下:

​

编辑切换为居中

添加图片注释，不超过 140 字（可选）

从中我们可以看到，状态码为我们自己定义的404，返回的code是我们传入的。

作者：用户3737044292553 链接：https://juejin.cn/post/7080023434448601096