RESTful API 是一种常见的 Web 开发方式，但在实际开发中，处理错误和异常的能力显得尤为重要，因为它们会影响到 API 的运行稳定性、可扩展性和可维护性。因此，本文将围绕 RESTful API 中的错误与异常处理展开，详细讨论如何处理异常，并给出相关示例代码。
1. HTTP 状态码
RESTful API 是基于 HTTP 协议的，所以 HTTP 的状态码非常重要。HTTP 状态码是服务器向客户端返回的 3 位数字代码，它表示了请求的状态。常见的 HTTP 状态码有：
- 1xx：信息性状态码。
- 2xx：成功状态码，表示执行成功。
- 3xx：重定向状态码，表示客户端需要采取进一步的操作才能完成请求。
- 4xx：客户端错误状态码，表示客户端发送的请求有误。
- 5xx：服务器错误状态码，表示服务器执行请求时出现了错误。
在实际开发中，我们可以根据返回的 HTTP 状态码来判断 API 是否执行成功。例如，当 API 执行成功时，服务器可以返回一个 200 状态码，而当 API 执行失败时，服务器可以返回一个 4xx 或 5xx 的状态码。
2. 错误码
在 RESTful API 中，除了 HTTP 状态码外，错误码也是非常重要的。错误码是自定义的，它是服务器向客户端返回的具体错误信息。在实际开发中，我们可以根据错误码来快速定位代码中的错误，从而更快地解决问题。
常见的错误码格式如下：
{
"code": 1001,
"message": "This is an error message.",
"data": {}
}- code：错误码，一般是一个数字。
- message：错误信息，一般是一个字符串。
- data：异常数据，根据实际情况可选。
当服务器返回错误码时，客户端可以根据 code 和 message 来处理错误，例如：
{
"code": 1001,
"message": "This is an error message.",
"data": {}
}在客户端可以根据 code 判断错误类型，从而执行相应的操作。
3. 异常处理
在 RESTful API 中，异常处理是非常重要的。异常处理可以有效地避免 API 执行失败，提高应用程序的健壮性和可靠性。以下是 RESTful API 中的异常处理指南：
3.1. 标准异常处理
标准异常处理是一个非常常见的异常处理方式。它包括以下步骤：
- 调用服务方法。
- 如果抛出异常，则将异常转换为错误码和异常消息并返回给客户端。
- 如果服务方法执行成功，则将成功结果返回给客户端。
以下是一个 Java 单体应用程序中的标准异常处理方法：
-- -------------------- ---- -------
------ ----------------- ----------- --- -
--- -
-----------------------
------ ----------------------
-
----- ---------- -- -
-------------------- ---- -------- ---
------ ---------------------------------------------------- --------------------------------------
-
-在上面的代码中，当服务方法执行失败时，会先将异常转换为错误码和异常消息，然后返回到客户端。如果执行成功，则返回一个成功的结果。
3.2. 增强异常处理
在标准异常处理的基础上，我们可以增加一些错误信息，例如请求 API 的用户、请求 API 的时间等。这对于排查异常非常有帮助。
下面是一个示例代码：
-- -------------------- ---- -------
------ ----------------- ----------- --- -
--- -
-----------------------
------ ----------------------
-
----- ---------- -- -
---------------------------------- ---- ------ ------- -------- ---------- --- ------------------------------------------- --- -------- ---
------ ---------------------------------------------------- --------------------------------------
-
-在上面的代码中，请求 API 的用户和请求 API 的时间被记录在日志中，这样可以帮助开发者更快速地定位问题。
3.3. 统一异常处理
在实际开发中，我们可能会有多个服务方法，每个服务方法都有相应的异常处理方式。这样会使代码显得比较繁琐，我们可以采用 AOP 的方式，将异常处理统一放在一个类中处理。
以下是一个 Spring Boot 应用程序中的异常处理类：
-- -------------------- ---- -------
---------------------
------ ----- --------------- -
-----------------------------------------
------ ----------------- --------------------------------------- -- -
--------------------- ----------- ---
------ --------------------------------------------------- ----------------
-
----------------------------------
------ ----------------- ------------------------- -- -
-------------------- ----------- ---
------ --------------------------------------------------- -------------------------------------
-
-在上面的代码中，我们定义了两个异常处理方法，handleRuntimeException 处理 RuntimeException，handleException 处理所有其他类型的异常。当 API 执行出现异常时，会执行其中一个方法，将异常转换为错误码和异常消息并返回给客户端。
4. 总结
在本文中，我们详细讨论了 RESTful API 中的错误与异常处理。我们了解了 HTTP 状态码、错误码以及如何处理异常。我们还给出了一些示例代码，帮助开发者更好地理解。
当然，以上只是一些基础的处理方式，还有很多其它的处理方式，需要根据实际业务需求进行定制化开发。在实际应用中，对错误与异常处理有全面的认识和深入的研究将会更加有益。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/648943bc48841e989478fea6