Sprint Boot @ControllerAdvice使用方法详解

Spring Boot的@ControllerAdvice的作用与使用方法

在Spring Boot中，@ControllerAdvice注解用于定义全局异常处理器。通过使用@ControllerAdvice注解，可以方便地处理应用程序中的异常，并提供自定义的异常处理逻辑。在本文中，我们将详细介绍@ControllerAdvice注解的作用和使用方法，并提供两个示例。

@ControllerAdvice注解的作用

@ControllerAdvice注解用于定义全局异常处理器。当应用程序中发生异常时，Spring Boot会自动调用@ControllerAdvice注解标记的类中的方法，以处理异常并提供自定义的异常处理逻辑。

@ControllerAdvice注解的使用方法

以下是使用@ControllerAdvice注解的步骤：

1. 创建一个类并添加@ControllerAdvice注解

首先，创建一个类并添加@ControllerAdvice注解。以下是创建一个类并添加@ControllerAdvice注解的示例：

@ControllerAdvice
public class GlobalExceptionHandler {
    // ...
}

在上面的示例中，我们创建了一个名为GlobalExceptionHandler的类，并添加了@ControllerAdvice注解。

1. 添加异常处理方法

在GlobalExceptionHandler类中，添加异常处理方法。以下是添加异常处理方法的示例：

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

在上面的示例中，我们在GlobalExceptionHandler类中添加了一个名为handleException的异常处理方法。该方法处理所有类型的异常，并返回一个ResponseEntity对象。

在handleException方法中，我们使用@ExceptionHandler注解标记了Exception.class，以指定该方法处理所有类型的异常。当应用程序中发生异常时，Spring Boot会自动调用handleException方法，并将异常对象传递给该方法。

在handleException方法中，我们使用ResponseEntity对象返回一个HTTP响应。在本例中，我们返回一个500 Internal Server Error响应。

示例1：自定义异常处理

以下是自定义异常处理的示例：

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<String> handleUserNotFoundException(UserNotFoundException e) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(e.getMessage());
    }
}

在上面的示例中，我们在GlobalExceptionHandler类中添加了一个名为handleUserNotFoundException的异常处理方法。该方法处理UserNotFoundException类型的异常，并返回一个ResponseEntity对象。

在handleUserNotFoundException方法中，我们使用@ExceptionHandler注解标记了UserNotFoundException.class，以指定该方法处理UserNotFoundException类型的异常。当应用程序中发生UserNotFoundException异常时，Spring Boot会自动调用handleUserNotFoundException方法，并将异常对象传递给该方法。

在handleUserNotFoundException方法中，我们使用ResponseEntity对象返回一个HTTP响应。在本例中，我们返回一个404 Not Found响应，并将异常消息作为响应体返回。

示例2：处理多个异常类型

以下是处理多个异常类型的示例：

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler({IllegalArgumentException.class, IllegalStateException.class})
    public ResponseEntity<String> handleIllegalArgumentException(Exception e) {
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage());
    }
}

在上面的示例中，我们在GlobalExceptionHandler类中添加了一个名为handleIllegalArgumentException的异常处理方法。该方法处理IllegalArgumentException和IllegalStateException类型的异常，并返回一个ResponseEntity对象。

在handleIllegalArgumentException方法中，我们使用@ExceptionHandler注解标记了IllegalArgumentException.class和IllegalStateException.class，以指定该方法处理这两种类型的异常。当应用程序中发生这两种类型的异常时，Spring Boot会自动调用handleIllegalArgumentException方法，并将异常对象传递给该方法。

在handleIllegalArgumentException方法中，我们使用ResponseEntity对象返回一个HTTP响应。在本例中，我们返回一个400 Bad Request响应，并将异常消息作为响应体返回。

结论

本文中，我们详细介绍了@ControllerAdvice注解的作用和使用方法，并提供了两个示例说明。使用@ControllerAdvice注解，可以方便地处理应用程序中的异常，并提供自定义的异常处理逻辑。