SpringBoot初始教程之统一异常处理详解

在SpringBoot应用中，异常处理是一个非常重要的话题。一个好的异常处理可以提高系统的健壮性和稳定性，同时也能让开发者更快地定位问题。本教程将详细讲解SpringBoot中统一异常处理的基本知识和实现方法。

为什么需要统一异常处理

在SpringBoot应用中，可能存在各种不可避免的异常情况，比如系统错误、数据访问异常、业务异常等等。如果没有合适的异常处理机制，这些异常可能会导致应用崩溃或者无法正常运行。而如果每个异常都单独处理，不仅代码冗余，而且容易出错。因此，我们需要一个统一的异常处理机制来统一处理所有异常。

统一异常处理的基本原理

SpringBoot中的统一异常处理基本原理是：将所有异常都转化成统一的异常类型，并通过异常处理器进行统一处理。具体来说，就是将所有异常捕获，然后将其封装成统一的ErrorResponse对象，再将该对象序列化成JSON格式返回给客户端。这样，我们可以在客户端看到一致的异常信息，方便开发者定位问题。

统一异常处理的实现方法

在SpringBoot中，实现统一异常处理一般需要完成以下步骤：

1. 自定义异常类：我们首先需要自定义一个异常类，该异常类继承自Exception或者RuntimeException，并可以根据需要添加一些属性和方法。比如：

```java
public class MyException extends RuntimeException {
private Integer code;
private String message;

   public MyException(Integer code, String message) {
       this.code = code;
       this.message = message;
   }

   public Integer getCode() {
       return code;
   }

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

   public String getMessage() {
       return message;
   }

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

}
```

1. 自定义异常处理器：我们还需要自定义一个异常处理器，用于处理所有抛出的异常。该处理器需要实现异常处理的逻辑，并将结果封装成ErrorResponse对象返回给客户端。比如：

java
@RestControllerAdvice
public class MyExceptionHandler {
@ExceptionHandler(value = Exception.class)
public ErrorResponse handleException(Exception e) {
// TODO 处理异常，生成ErrorResponse对象并返回
}
}

1. 定义ErrorResponse类：由于所有返回的异常信息都需要被封装成JSON格式，因此我们需要定义一个ErrorResponse类：

```java
public class ErrorResponse {
private Integer code;
private String message;

   public ErrorResponse(Integer code, String message) {
       this.code = code;
       this.message = message;
   }

   public Integer getCode() {
       return code;
   }

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

   public String getMessage() {
       return message;
   }

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

}
```

通过以上三个步骤，我们就可以实现SpringBoot中的统一异常处理。

示例说明

为了更好地理解如何实现SpringBoot中的统一异常处理，我们来看两个具体的示例：

示例1：系统错误

假设我们在一个控制器方法中调用了一个空引用的对象，会抛出NullPointerException异常。此时，我们可以通过统一异常处理器来捕获异常并返回ErrorResponse对象。代码如下：

@RestController
public class TestController {
    @GetMapping("/test")
    public void test() {
        Object obj = null;
        System.out.println(obj.toString());
    }
}

@RestControllerAdvice
public class MyExceptionHandler {
    @ExceptionHandler(value = Exception.class)
    public ErrorResponse handleException(Exception e) {
        return new ErrorResponse(500, "系统错误，请稍后重试！");
    }
}

当我们访问该控制器方法时，会返回如下的JSON格式的异常信息：

{
    "code": 500,
    "message": "系统错误，请稍后重试！"
}

示例2：业务错误

假设我们在一个控制器方法中需要根据ID查询一条用户信息，但该ID在数据库中不存在。此时，我们可以通过抛出自定义的MyException异常来表示业务错误，并通过统一异常处理器来返回ErrorResponse对象。代码如下：

@RestController
public class UserController {
    @GetMapping("/users/{id}")
    public void getUserById(@PathVariable Long id) {
        User user = userService.getById(id);
        if (user == null) {
            throw new MyException(400, "用户不存在！");
        }
    }
}

@RestControllerAdvice
public class MyExceptionHandler {
    @ExceptionHandler(value = MyException.class)
    public ErrorResponse handleMyException(MyException e) {
        return new ErrorResponse(e.getCode(), e.getMessage());
    }

    @ExceptionHandler(value = Exception.class)
    public ErrorResponse handleException(Exception e) {
        return new ErrorResponse(500, "系统错误，请稍后重试！");
    }
}

当我们访问该控制器方法时，会返回如下的JSON格式的异常信息：

{
    "code": 400,
    "message": "用户不存在！"
}

以上两个示例展示了在SpringBoot应用中如何实现统一异常处理的基本方法。通过自定义异常和异常处理器，我们可以更好地处理各种异常情况。