SpringBoot 异常处理：轻松掌握异常返回的正确姿势

2024-02-18 22:51:37

1. SpringBoot 异常处理的基础知识

在 SpringBoot 中，异常处理主要通过 @ExceptionHandler 注解来实现。@ExceptionHandler 注解可以应用于控制器方法或类级别，用于处理特定类型的异常。当控制器方法或类中发生异常时，Spring Boot 会自动调用带有 @ExceptionHandler 注解的方法来处理该异常。

例如，以下代码演示了如何处理 NullPointerException 异常：

@RestController
public class MyController {

    @GetMapping("/hello")
    public String hello() {
        if (name == null) {
            throw new NullPointerException("name cannot be null");
        }
        return "Hello, " + name;
    }

    @ExceptionHandler(NullPointerException.class)
    public ResponseEntity<String> handleNullPointerException(NullPointerException ex) {
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("name cannot be null");
    }
}

在上面的代码中，@ExceptionHandler(NullPointerException.class) 注解表示当控制器方法 hello() 发生 NullPointerException 异常时，Spring Boot 会自动调用 handleNullPointerException() 方法来处理该异常。handleNullPointerException() 方法返回一个 ResponseEntity 对象，其中包含了异常信息和 HTTP 状态码。

2. SpringBoot 异常处理的最佳实践

在使用 SpringBoot 处理异常时，有以下几个最佳实践可以遵循：

使用 Spring Boot 的预定义异常处理程序： Spring Boot 提供了一些预定义的异常处理程序，这些异常处理程序可以处理常见的异常情况。例如，DefaultErrorAttributes 可以处理常见的 HTTP 错误，ResponseEntityExceptionHandler 可以处理常见的 HTTP 异常。
使用合适的 HTTP 状态码： 当返回异常信息时，应使用合适的 HTTP 状态码。例如，当返回 404 错误时，应使用 HttpStatus.NOT_FOUND 状态码。
提供有用的错误信息： 异常信息应清晰、简洁，并且对用户或开发人员有帮助。避免使用过于技术性的语言或晦涩难懂的术语。
记录异常信息： 异常信息应被记录下来，以便于开发人员进行问题排查。可以将异常信息记录到日志文件或数据库中。