SpringBoot使用@ControllerAdvice全局异常处理

异常处理

在 Spring Boot 应用中，异常处理是非常重要的一部分，它可以帮助我们捕获并处理应用程序中出现的异常情况，提高应用程序的健壮性和可靠性。在 Spring Boot 中，我们可以使用 @ControllerAdvice 注解来实现全局异常处理。本文将介绍 @ControllerAdvice 注解的使用和原理。

@ControllerAdvice 注解的作用

@ControllerAdvice 注解用于定义全局异常处理器，它可以处理应用程序中任意一个控制器抛出的异常。当控制器抛出异常时，Spring Boot 会自动调用与异常类型匹配的异常处理器，将异常信息传递给异常处理器，由异常处理器进行处理。

@ControllerAdvice 注解的使用

首先，我们创建一个 Spring Boot 应用，并添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.5.3</version>
</dependency>

这些依赖将引入 Spring Boot 的 web 相关组件。

接着，我们创建一个名为 MyExceptionHandler 的类，使用 @ControllerAdvice 注解来定义异常处理器：

@ControllerAdvice
public class MyExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Internal Server Error");
    }
}

在这个类中，我们使用 @ControllerAdvice 注解定义了一个全局异常处理器。@ExceptionHandler 注解用于定义异常处理方法，它可以处理指定类型的异常。在这个例子中，我们使用 Exception.class 来指定处理所有类型的异常。处理方法返回一个 ResponseEntity 对象，它包含了 HTTP 响应的状态码和响应体。

最后，我们在控制器中抛出异常，测试异常处理器的功能：

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello() {
        throw new RuntimeException("Unexpected error");
    }
}

在这个控制器中，我们定义了一个名为 hello 的接口，它会抛出一个 RuntimeException 异常。当我们访问这个接口时，异常处理器会捕获到这个异常，并返回一个 HTTP 500 错误码。

@ControllerAdvice 注解的原理

当控制器抛出异常时，Spring Boot 会查找与异常类型匹配的异常处理器。如果找到了匹配的异常处理器，Spring Boot 会调用异常处理器的处理方法，并将异常信息传递给处理方法。处理方法可以对异常信息进行处理，并返回一个 ResponseEntity 对象，其中包含了 HTTP 响应的状态码和响应体。如果没有找到匹配的异常处理器，Spring Boot 会将异常信息包装成一个默认的 ResponseEntity 对象，并返回给客户端。

在 Spring Boot 应用中，异常处理器是以 Bean 的形式存在的。当我们使用 @ControllerAdvice 注解定义一个异常处理器时，实际上相当于定义了一个 Bean，这个 Bean 中包含了一个或多个 @ExceptionHandler 注解的处理方法。当控制器抛出异常时，Spring Boot 会自动查找与异常类型匹配的异常处理器 Bean，并调用处理方法进行处理。

总结

本文介绍了 @ControllerAdvice 注解的使用和原理。@ControllerAdvice 注解可以用于定义全局异常处理器，它可以处理应用程序中任意一个控制器抛出的异常。当控制器抛出异常时，Spring Boot 会自动调用与异常类型匹配的异常处理器，将异常信息传递给异常处理器，由异常处理器进行处理。异常处理器是以 Bean 的形式存在的，当控制器抛出异常时，Spring Boot 会自动查找与异常类型匹配的异常处理器 Bean，并调用处理方法进行处理。

到此这篇关于SpringBoot使用@ControllerAdvice全局异常处理的文章就介绍到这了,更多相关@ControllerAdvice全局异常处理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论