SpringBoot如何自定义错误处理逻辑

发布时间：2022-10-23 17:07:28 作者：iii
来源：亿速云阅读：198

SpringBoot如何自定义错误处理逻辑

在开发Web应用程序时，错误处理是一个不可避免的部分。无论是由于用户输入错误、服务器内部错误还是其他原因，应用程序都需要能够优雅地处理这些错误，并向用户提供有意义的反馈。Spring Boot 提供了强大的错误处理机制，允许开发者自定义错误处理逻辑，以满足特定的业务需求。

本文将详细介绍如何在Spring Boot中自定义错误处理逻辑，包括以下几个方面：

Spring Boot默认错误处理机制
自定义错误页面
使用@ControllerAdvice和@ExceptionHandler处理异常
自定义错误响应
处理特定类型的异常
全局异常处理
自定义错误属性
处理HTTP状态码
使用ErrorController自定义错误处理
总结

1. Spring Boot默认错误处理机制

Spring Boot 提供了一套默认的错误处理机制。当应用程序抛出异常时，Spring Boot 会自动捕获这些异常，并根据请求的Accept头信息返回相应的错误响应。例如，如果请求的Accept头信息包含application/json，Spring Boot 会返回一个JSON格式的错误响应；如果请求的Accept头信息包含text/html，Spring Boot 会返回一个HTML格式的错误页面。

默认情况下，Spring Boot 会为常见的HTTP错误状态码（如404、500等）提供默认的错误页面。这些页面通常包含错误状态码、错误信息和时间戳等信息。

2. 自定义错误页面

虽然Spring Boot提供了默认的错误页面，但在实际应用中，我们通常希望自定义错误页面，以便更好地与应用程序的整体风格保持一致。

2.1 自定义静态错误页面

Spring Boot 允许我们在src/main/resources/static/error目录下放置自定义的错误页面。这些页面的文件名应与HTTP状态码相对应。例如，404.html用于处理404错误，500.html用于处理500错误。

src/main/resources/static/error/
├── 404.html
├── 500.html
└── error.html

404.html和500.html分别用于处理404和500错误，而error.html则用于处理其他未明确指定的错误。

2.2 自定义动态错误页面

除了静态错误页面外，我们还可以使用Thymeleaf、Freemarker等模板引擎来生成动态错误页面。动态错误页面可以包含更多的动态内容，如当前时间、用户信息等。

在src/main/resources/templates/error目录下放置模板文件，文件名同样应与HTTP状态码相对应。

src/main/resources/templates/error/
├── 404.html
├── 500.html
└── error.html

例如，404.html可以是一个Thymeleaf模板：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>404 Not Found</title>
</head>
<body>
    <h1>404 Not Found</h1>
    <p>Sorry, the page you are looking for does not exist.</p>
    <p>Timestamp: <span th:text="${timestamp}"></span></p>
    <p>Path: <span th:text="${path}"></span></p>
</body>
</html>

3. 使用@ControllerAdvice和@ExceptionHandler处理异常

Spring Boot 提供了@ControllerAdvice和@ExceptionHandler注解，允许我们以全局或局部的方式处理异常。

3.1 局部异常处理

我们可以使用@ExceptionHandler注解在控制器中处理特定的异常。例如：

@RestController
public class MyController {

    @GetMapping("/example")
    public String example() {
        throw new RuntimeException("An error occurred");
    }

    @ExceptionHandler(RuntimeException.class)
    public ResponseEntity<String> handleRuntimeException(RuntimeException ex) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(ex.getMessage());
    }
}

在这个例子中，handleRuntimeException方法会处理RuntimeException，并返回一个包含错误信息的ResponseEntity。

3.2 全局异常处理

如果我们希望在多个控制器中共享异常处理逻辑，可以使用@ControllerAdvice注解。@ControllerAdvice注解的类可以包含多个@ExceptionHandler方法，这些方法会应用于所有的控制器。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(RuntimeException.class)
    public ResponseEntity<String> handleRuntimeException(RuntimeException ex) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(ex.getMessage());
    }

    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity<String> handleResourceNotFoundException(ResourceNotFoundException ex) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ex.getMessage());
    }
}

在这个例子中，GlobalExceptionHandler类会处理所有控制器中抛出的RuntimeException和ResourceNotFoundException。

4. 自定义错误响应

在某些情况下，我们可能希望自定义错误响应的格式。例如，我们可能希望返回一个包含错误码、错误信息和时间戳的JSON对象。

我们可以通过自定义@ExceptionHandler方法来实现这一点。例如：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(RuntimeException.class)
    public ResponseEntity<ErrorResponse> handleRuntimeException(RuntimeException ex) {
        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), ex.getMessage(), System.currentTimeMillis());
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorResponse);
    }

    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity<ErrorResponse> handleResourceNotFoundException(ResourceNotFoundException ex) {
        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.NOT_FOUND.value(), ex.getMessage(), System.currentTimeMillis());
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(errorResponse);
    }
}

public class ErrorResponse {
    private int status;
    private String message;
    private long timestamp;

    public ErrorResponse(int status, String message, long timestamp) {
        this.status = status;
        this.message = message;
        this.timestamp = timestamp;
    }

    // Getters and setters
}

在这个例子中，ErrorResponse类定义了一个包含状态码、错误信息和时间戳的JSON对象。handleRuntimeException和handleResourceNotFoundException方法会返回一个包含ErrorResponse对象的ResponseEntity。

5. 处理特定类型的异常

在某些情况下，我们可能需要处理特定类型的异常，并为每种异常类型提供不同的处理逻辑。例如，我们可能希望为ResourceNotFoundException返回404状态码，而为ValidationException返回400状态码。

我们可以通过为每种异常类型定义单独的@ExceptionHandler方法来实现这一点。例如：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity<ErrorResponse> handleResourceNotFoundException(ResourceNotFoundException ex) {
        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.NOT_FOUND.value(), ex.getMessage(), System.currentTimeMillis());
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(errorResponse);
    }

    @ExceptionHandler(ValidationException.class)
    public ResponseEntity<ErrorResponse> handleValidationException(ValidationException ex) {
        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.BAD_REQUEST.value(), ex.getMessage(), System.currentTimeMillis());
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errorResponse);
    }
}

在这个例子中，handleResourceNotFoundException方法会处理ResourceNotFoundException，并返回404状态码；handleValidationException方法会处理ValidationException，并返回400状态码。

6. 全局异常处理

在某些情况下，我们可能希望为所有未处理的异常提供一个全局的异常处理逻辑。我们可以通过定义一个通用的@ExceptionHandler方法来实现这一点。例如：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleException(Exception ex) {
        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), ex.getMessage(), System.currentTimeMillis());
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorResponse);
    }
}

在这个例子中，handleException方法会处理所有未处理的异常，并返回500状态码。

7. 自定义错误属性

在某些情况下，我们可能希望在错误响应中包含更多的属性，如错误码、错误类型等。我们可以通过扩展ErrorResponse类来实现这一点。例如：

public class ErrorResponse {
    private int status;
    private String message;
    private long timestamp;
    private String errorCode;
    private String errorType;

    public ErrorResponse(int status, String message, long timestamp, String errorCode, String errorType) {
        this.status = status;
        this.message = message;
        this.timestamp = timestamp;
        this.errorCode = errorCode;
        this.errorType = errorType;
    }

    // Getters and setters
}

然后，我们可以在@ExceptionHandler方法中使用这个扩展的ErrorResponse类。例如：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(RuntimeException.class)
    public ResponseEntity<ErrorResponse> handleRuntimeException(RuntimeException ex) {
        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), ex.getMessage(), System.currentTimeMillis(), "ERR-500", "Internal Server Error");
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorResponse);
    }
}

8. 处理HTTP状态码

在某些情况下，我们可能需要根据不同的HTTP状态码返回不同的错误响应。我们可以通过使用ResponseEntity的status方法来实现这一点。例如：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(RuntimeException.class)
    public ResponseEntity<ErrorResponse> handleRuntimeException(RuntimeException ex) {
        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), ex.getMessage(), System.currentTimeMillis());
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorResponse);
    }

    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity<ErrorResponse> handleResourceNotFoundException(ResourceNotFoundException ex) {
        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.NOT_FOUND.value(), ex.getMessage(), System.currentTimeMillis());
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(errorResponse);
    }
}

在这个例子中，handleRuntimeException方法会返回500状态码，而handleResourceNotFoundException方法会返回404状态码。

9. 使用ErrorController自定义错误处理

在某些情况下，我们可能需要更细粒度的控制错误处理逻辑。我们可以通过实现ErrorController接口来自定义错误处理逻辑。

@Controller
public class MyErrorController implements ErrorController {

    @RequestMapping("/error")
    public ResponseEntity<ErrorResponse> handleError(HttpServletRequest request) {
        Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");
        Exception exception = (Exception) request.getAttribute("javax.servlet.error.exception");
        String errorMessage = exception != null ? exception.getMessage() : "Unknown error";

        ErrorResponse errorResponse = new ErrorResponse(statusCode, errorMessage, System.currentTimeMillis());
        return ResponseEntity.status(statusCode).body(errorResponse);
    }

    @Override
    public String getErrorPath() {
        return "/error";
    }
}

在这个例子中，handleError方法会处理所有未处理的错误，并返回一个包含错误信息的ResponseEntity。getErrorPath方法返回错误处理的路径。

10. 总结

Spring Boot 提供了强大的错误处理机制，允许开发者自定义错误处理逻辑，以满足特定的业务需求。通过使用@ControllerAdvice、@ExceptionHandler、自定义错误页面、自定义错误响应等方法，我们可以灵活地处理各种异常情况，并向用户提供有意义的反馈。

在实际应用中，我们应根据具体的业务需求选择合适的错误处理策略，并确保错误处理逻辑与应用程序的整体架构保持一致。通过合理地使用Spring Boot的错误处理机制，我们可以提高应用程序的健壮性和用户体验。

SpringBoot如何自定义错误处理逻辑

SpringBoot如何自定义错误处理逻辑

1. Spring Boot默认错误处理机制

2. 自定义错误页面

2.1 自定义静态错误页面

2.2 自定义动态错误页面

3. 使用@ControllerAdvice和@ExceptionHandler处理异常

3.1 局部异常处理

3.2 全局异常处理

4. 自定义错误响应

5. 处理特定类型的异常

6. 全局异常处理

7. 自定义错误属性

8. 处理HTTP状态码

9. 使用ErrorController自定义错误处理

10. 总结

相关阅读