Spring Boot 中的 Rest Controller 自定义异常处理：告别 500 错误

2024-03-24 15:04:02

自定义异常处理：为 Rest Controller 返回正确的响应

导言

在 Spring Boot 应用程序中使用自定义异常来处理 Rest Controller 中的错误时，我们可能会遇到控制器返回 500 Internal Server Error 响应的问题。本文将探讨如何使用 try-catch 块来捕获特定异常，并针对每个异常返回适当的 HTTP 状态代码和响应消息，从而解决此问题。

问题概述

当控制器返回 DuplicateNumberException 或 NotFoundException 等自定义异常时，我们会收到 500 Internal Server Error 响应。这是因为默认情况下，Spring Boot 将所有未处理的异常都映射到 500 错误代码。

解决方案

要解决此问题，我们可以使用以下步骤：

在控制器方法中使用 try-catch 块。
捕获特定异常，例如 DuplicateNumberException 和 NotFoundException。
针对每个异常返回适当的 HTTP 状态代码和响应消息。

代码示例

考虑以下修改后的控制器代码：

@PostMapping("/add")
public ResponseEntity<String> insertRecord(@RequestBody Map<String, String> payload) {
    try {
        // 业务逻辑...
    } catch (DuplicateNumberException e) {
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("Duplicate number. Record not inserted.");
    } catch (NotFoundException e) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body("No records found for the given String.");
    } catch (Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                .body("An unexpected error occurred while processing the request.");
    }
}

解释

修改后的代码包含一个 try-catch 块，用于捕获：

DuplicateNumberException： 400 Bad Request，"Duplicate number. Record not inserted."
NotFoundException： 404 Not Found，"No records found for the given String."
其他异常： 500 Internal Server Error，"An unexpected error occurred while processing the request."

通过使用 try-catch 块，我们确保控制器在出现异常时返回正确的 HTTP 状态代码和响应消息，而不是默认的 500 错误代码。这有助于客户端应用程序正确处理错误并采取适当的措施。

好处

使用自定义异常处理提供了以下好处：

准确的错误处理： 每个异常都映射到特定的 HTTP 状态代码，提供准确的错误信息。
增强客户端应用程序的鲁棒性： 客户端应用程序可以根据特定的 HTTP 状态代码处理错误，从而提高应用程序的整体鲁棒性。
改善用户体验： 为用户提供明确的错误消息可以提高用户体验。

常见问题解答

我可以使用自定义异常处理来处理所有异常吗？
是的，你可以使用自定义异常处理来处理任何异常，但建议只处理应用程序中常见的可预见的异常。
我应该为每个异常创建一个单独的处理程序吗？
不一定。你可以为一组相关的异常创建一个处理程序，只要确保你捕获了所有可能的异常情况。
我可以使用自定义异常处理来处理验证错误吗？
是的，你可以使用自定义异常处理来处理验证错误，只要你将它们映射到适当的 HTTP 状态代码，例如 400 Bad Request。
如何自定义异常消息？
可以在自定义异常构造函数中设置异常消息，提供有关错误的更多详细信息。
在应用程序中使用自定义异常处理的最佳做法是什么？
最佳做法包括使用特定的异常类型、为每个异常定义明确的 HTTP 状态代码、提供有用的异常消息以及记录异常。