Sprint Boot @ExceptionHandler使用方法详解

@ExceptionHandler是Spring Boot中的一个注解，它用于处理控制器方法中抛出的异常。在使用Spring Boot开发Web应用程序时，@ExceptionHandler是非常重要的。本文将详细介绍@ExceptionHandler的作用和使用方法，并提供两个示例说明。

@ExceptionHandler的作用

@ExceptionHandler的作用是处理控制器方法中抛出的异常。使用@ExceptionHandler注解的方法可以处理控制器方法中抛出的异常，并返回适当的响应。@ExceptionHandler注解可以用于类级别和方法级别，用于指定控制器类和控制器方法的异常处理。

@ExceptionHandler使用方法

以下是使用@ExceptionHandler的步骤：

1. 创建控制器

要使用@ExceptionHandler，需要创建一个控制器。可以使用以下代码创建一个控制器：

@RestController
@RequestMapping("/users")
public class UserController {

    private List<User> users = new ArrayList<>();

    @PostMapping
    public void addUser(@RequestBody User user) {
        users.add(user);
    }

    @GetMapping("/{id}")
    public User getUser(@PathVariable int id) {
        if (id >= users.size()) {
            throw new UserNotFoundException("User not found with id " + id);
        }
        return users.get(id);
    }

}

在上面的代码中，我们使用@RestController注解标记了一个名为UserController的类。我们还使用@RequestMapping注解标记了一个名为/users的路径，该路径将映射到控制器类上。我们还使用@PostMapping注解标记了一个名为addUser的方法，该方法将处理HTTP POST请求，并将用户信息添加到列表中。我们还使用@RequestBody注解标记了一个名为user的参数，该参数是HTTP请求体，用于指定要添加的用户信息。我们还使用@GetMapping注解标记了一个名为getUser的方法，该方法将处理HTTP GET请求，并返回指定ID的用户信息。我们还使用@PathVariable注解标记了一个名为id的参数，该参数是HTTP请求路径变量，用于指定要获取的用户的ID。如果指定的ID不存在，则抛出UserNotFoundException异常。

1. 创建异常处理器

要使用@ExceptionHandler，需要创建一个异常处理器。可以使用以下代码创建一个异常处理器：

@RestControllerAdvice
public class UserControllerAdvice {

    @ExceptionHandler(UserNotFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public String handleUserNotFoundException(UserNotFoundException ex) {
        return ex.getMessage();
    }

}

在上面的代码中，我们使用@RestControllerAdvice注解标记了一个名为UserControllerAdvice的类。我们还使用@ExceptionHandler注解标记了一个名为handleUserNotFoundException的方法，该方法将处理UserNotFoundException异常，并返回适当的响应。我们还使用@ResponseStatus注解标记了一个名为HttpStatus.NOT_FOUND的参数，该参数表示HTTP响应状态码为404。如果控制器方法中抛出了UserNotFoundException异常，则将调用handleUserNotFoundException方法，并返回适当的响应。

1. 运行应用程序

要运行应用程序，只需要使用以下命令：

mvn spring-boot:run

在上面的命令中，我们使用Maven运行了Spring Boot应用程序。

1. 测试应用程序

要测试应用程序，可以使用curl命令。以下是使用curl命令测试应用程序的步骤：

• 打开终端
• 输入curl -X POST http://localhost:8080/users -H 'Content-Type: application/json' -d '{"name": "John", "age": 30}'
• 按下回车键
• 输入curl http://localhost:8080/users/0
• 按下回车键

在上面的步骤中，我们使用curl命令添加了一个名为John、年龄为30的用户信息，并获取了ID为0的用户信息。如果指定的ID不存在，则会返回404响应。

示例1：使用@ExceptionHandler处理自定义异常

以下是使用@ExceptionHandler处理自定义异常的示例：

@RestController
@RequestMapping("/users")
public class UserController {

    private List<User> users = new ArrayList<>();

    @PostMapping
    public void addUser(@RequestBody User user) {
        users.add(user);
    }

    @GetMapping("/{id}")
    public User getUser(@PathVariable int id) {
        if (id >= users.size()) {
            throw new UserNotFoundException("User not found with id " + id);
        }
        return users.get(id);
    }

}

在上面的示例中，我们使用@RestController注解标记了一个名为UserController的类。我们还使用@RequestMapping注解标记了一个名为/users的路径，该路径将映射到控制器类上。我们还使用@PostMapping注解标记了一个名为addUser的方法，该方法将处理HTTP POST请求，并将用户信息添加到列表中。我们还使用@RequestBody注解标记了一个名为user的参数，该参数是HTTP请求体，用于指定要添加的用户信息。我们还使用@GetMapping注解标记了一个名为getUser的方法，该方法将处理HTTP GET请求，并返回指定ID的用户信息。我们还使用@PathVariable注解标记了一个名为id的参数，该参数是HTTP请求路径变量，用于指定要获取的用户的ID。如果指定的ID不存在，则抛出UserNotFoundException异常。

@RestControllerAdvice
public class UserControllerAdvice {

    @ExceptionHandler(UserNotFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public String handleUserNotFoundException(UserNotFoundException ex) {
        return ex.getMessage();
    }

}

在上面的示例中，我们使用@RestControllerAdvice注解标记了一个名为UserControllerAdvice的类。我们还使用@ExceptionHandler注解标记了一个名为handleUserNotFoundException的方法，该方法将处理UserNotFoundException异常，并返回适当的响应。我们还使用@ResponseStatus注解标记了一个名为HttpStatus.NOT_FOUND的参数，该参数表示HTTP响应状态码为404。如果控制器方法中抛出了UserNotFoundException异常，则将调用handleUserNotFoundException方法，并返回适当的响应。

示例2：使用@ExceptionHandler处理全局异常

以下是使用@ExceptionHandler处理全局异常的示例：

@RestController
@RequestMapping("/users")
public class UserController {

    private List<User> users = new ArrayList<>();

    @PostMapping
    public void addUser(@RequestBody User user) {
        if (user.getName() == null || user.getName().isEmpty()) {
            throw new InvalidUserException("User name cannot be empty");
        }
        users.add(user);
    }

    @GetMapping("/{id}")
    public User getUser(@PathVariable int id) {
        if (id >= users.size()) {
            throw new UserNotFoundException("User not found with id " + id);
        }
        return users.get(id);
    }

}

在上面的示例中，我们使用@RestController注解标记了一个名为UserController的类。我们还使用@RequestMapping注解标记了一个名为/users的路径，该路径将映射到控制器类上。我们还使用@PostMapping注解标记了一个名为addUser的方法，该方法将处理HTTP POST请求，并将用户信息添加到列表中。我们还使用@RequestBody注解标记了一个名为user的参数，该参数是HTTP请求体，用于指定要添加的用户信息。如果用户姓名为空，则抛出InvalidUserException异常。我们还使用@GetMapping注解标记了一个名为getUser的方法，该方法将处理HTTP GET请求，并返回指定ID的用户信息。我们还使用@PathVariable注解标记了一个名为id的参数，该参数是HTTP请求路径变量，用于指定要获取的用户的ID。如果指定的ID不存在，则抛出UserNotFoundException异常。

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public String handleException(Exception ex) {
        return "An error occurred: " + ex.getMessage();
    }

}

在上面的示例中，我们使用@RestControllerAdvice注解标记了一个名为GlobalExceptionHandler的类。我们还使用@ExceptionHandler注解标记了一个名为handleException的方法，该方法将处理所有异常，并返回适当的响应。我们还使用@ResponseStatus注解标记了一个名为HttpStatus.INTERNAL_SERVER_ERROR的参数，该参数表示HTTP响应状态码为500。如果控制器方法中抛出了任何异常，则将调用handleException方法，并返回适当的响应。

结论

在本文中，我们详细介绍了@ExceptionHandler的作用和使用方法，并提供了两个示例说明。使用@ExceptionHandler可以方便地处理控制器方法中抛出的异常，并返回适当的响应。通过使用@ExceptionHandler，我们可以将开发Web应用程序的时间和精力集中在业务逻辑上，而是处理异常和响应。