GraphQL 是一个强大、灵活的 API 查询语言，提供了与旧式 REST API 相比更好的查询控制和数据组合。然而，当您的应用程序在处理 GraphQL 具体的查询时，您可能会遇到一些错误。在这篇文章中，我们将介绍 GraphQL 错误处理的最佳实践，以及如何构建一个反应形式的 API，让您的应用程序具有稳定性和可靠性。
错误类型
在 GraphQL 中，错误可以分为两种类型：语法错误和运行时错误。
语法错误
语法错误发生在客户端的查询语句无效或包含错误的字段、参数或操作名称时。这类错误由 GraphQL 解析器捕获，通常表示为相应的错误消息。例如，以下查询语句将生成一个语法错误：
{
user {
firstName
unknownField # 错误的字段名称
}
}执行上面的查询时，GraphQL 解析器将返回以下错误消息：
-- -------------------- ---- -------
-
--------- -
-
---------- ------- ----- ----- ---------------- -- ---- -----------
------------ -
-
------- --
--------- -
-
-
-
-
-运行时错误
运行时错误发生在处理客户端查询时，服务端发生了错误，例如超时、数据库连接错误、无效的 API 密钥等。这些错误通常是由您的应用程序处理的。
错误处理最佳实践
为了确保 GraphQL API 的稳定性和可靠性，我们需要采用以下最佳实践：
明确的错误消息
为了帮助客户端程序员迅速修复 GraphQL 查询语句中的错误，我们需要提供明确的错误消息，包括错误类型、错误原因以及错误位置。
统一的错误格式
在整个 GraphQL API 中使用统一的错误格式可以提高 API 的可读性，并且可以让客户端程序员更容易地处理和调试错误。
错误分类
将错误分类并使用不同的 HTTP 状态代码表示不同的错误类型，可以让客户端程序员更好地了解 GraphQL API 的错误类型和客户端程序的下一步操作。
预防性错误处理
在处理查询前，您的应用程序需要检查查询中是否包含无效的变量、查询名称、指令或不正确的字段等。预防性错误处理可以提高 GraphQL 查询的可靠性。
GraphQL 中间件
您可以使用 GraphQL 中间件在 GraphQL 执行过程中调用自定义函数，如果发生错误，可以在中间件中处理或抛出异常。例如，以下中间件可以处理大多数运行时错误：
const errorMiddleware = async (resolve, parent, args, context, info) => {
try {
return await resolve()
} catch (err) {
throw new Error(`GraphQL Error: ${err.message}`)
}
}反应式 GraphQL API
许多现代 Web 应用程序需要具备反应形式的技术架构，可以及时捕获问题和错误并快速响应。我们可以通过以下方法来构建反应式 GraphQL API:
日志记录错误
记录 API 的错误和警告的详情和堆栈信息可以帮助您快速识别和解决问题。合适的日志级别和记录格式也是很重要的。
实时监测 GraphQL API
实时监测 GraphQL API 的查询、响应时间、错误率等，可以让您及时发现异常情况并采取相应的措施。
数据验证
在 GraphQL API 中使用数据验证可以确保客户端发送的数据是有效的，并减少其恶意攻击的可能性。
异常处理
在 GraphQL API 中使用异常处理可以减少 API 中的错误，提高 API 的健壮性。将所有异常包装成一个类，以允许 API 客户端更容易地处理和调试错误。
示例代码
以下是一个简单的示例 GraphQL API，它说明了以上所述的错误处理最佳实践和反应式 GraphQL API 构建：
-- -------------------- ---- -------
----- - ------------- --- - - --------------------------------
----- --- - ---------
----- -------- - ----
---- ---- -
--- ---
---------- -------
--------- -------
------ -------
-
---- ----- -
-------- ----- ----
----------- ----- ------ ------ -------
-
---- -------- -
--------------------- -------- --------- -------- ------ --------- -----
-
-
----- ----- - --
----- --------- - -
------ -
----- -------- - -- -- -------- ----- -- -
----- ---- - --------------- -- ------- --- -------------
-- ------- -
----- --- ----------- ---- -- ----- --- --------
-
------ ----
--
--
--------- -
----------- -------- - ---------- --------- ----- -- -------- ----- -- -
----- -- - ----------
----- ---- - - --- ---------- --------- ----- -
----------------
------ ----
--
--
-
----- ------------ - --- --------------
---------
----------
------------ ----- -- --
-------- --------------
----- ----------------------
---------- ----------------
----- -----------
---
--
------------------- ----- ---- ----- -- -
----- ------- - - ------- ------------------------- -
------------
---------------- ----- ----------- ------- --
------------------ ---- ----- ---------- --
--
--------------- ---- ---- ----- -- -
----------------------- -- ----------- -------- ------------- --
--
----- ---- - ---------------- -- ----
---------------- -- -- -
-------------------- --- ------- -- ----------------------------------
--总结
GraphQL API 的错误处理是保持 API 稳定性和可靠性的非常重要的方面。遵循上述最佳实践可以让您的应用程序更加健壮、可靠和反应式。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65a12d9dadd4f0e0ff94cac2