GraphQL 是一种用于构建 API 的查询语言。它不仅具有强大的数据查询能力，还支持使用类型系统描述数据模型，并且允许客户端精确控制所需数据的呈现。然而，当请求出现错误时，GraphQL 如何处理这些错误？
在本文中，我们将深入了解 GraphQL 运行时错误处理的机制，并探索如何有效地处理错误。
GraphQL 错误处理
GraphQL 提供了一些机制来处理运行时的错误。其中最重要的是 Errors 类型。这个类型定义了一个 errors 字段，它允许将多个错误作为列表返回：
---- ------ - ------- --------- - ---- ----- - -------- ------- ----- ------ ----- -------- ---------- ---------- - ---- -------- - ----- ---- ------- ---- -
Error 类型包含几个与错误相关的字段：
message：错误消息的字符串表示。code：这个错误的代码。 您可以使用此代码来向客户端提供更具体的错误信息。如果您不需要添加代码，则可以将其留为空。path：导致错误的查询字段的列表。也就是说，当遇到错误时，GraphQL 知道在查询中定位哪一个字段。这是非常有用的，因为客户端可以使用这个路径来定位错误发生的位置。locations：指出查询中错误发生的位置。这个位置是一个由line和column属性组成的对象列表。
当请求出现错误时，可以将多个 Error 对象放在 errors 列表中返回。如果没有发生错误，应用程序将返回一个有效的响应，其中不包含错误属性。但是，处理这些错误需要一些技巧。让我们看看如何处理错误。
GraphQL 错误处理技巧
静默错误处理
在某些情况下，您可能希望将 GraphQL 错误静默处理。这意味着您不会将错误暴露给客户端。相反，您将返回一个不包含错误的响应，而且没有客户端会收到有关出错的通知。
这是一个示例查询：
----- -
-------- ------ -
--
----
------- -
----
-
-
-如果您尝试查询一个不存在的用户，服务器将返回以下响应：
-
------- -
------- ----
-
-但是如果您遇到其他类型的错误，例如无法连接到数据库，您可能希望完全忽略此错误并继续向下执行。在这种情况下，您可以使用 try-catch 块捕获错误并将其忽略：
--- -
----- ------ - ----- ---------
------- -------
--------- ---------
--------------- ---------
---
-- ----
- ----- ------- -
-- -------------- -
-- ----
- ---- -
-- --------- ----- ---
----- ------
-
-这个例子使用 try-catch 块捕获 GraphQL 错误。在开发模式下，错误将被抛出并记录下来（例如在日志中）。但是，在生产模式下，错误将被忽略，并且应用程序将继续运行。请注意，这个技巧只适用于应用程序中不能修复的运行时错误，例如数据库错误或网络错误。
带有错误处理器的中间件
GraphQL 中的一种方法是使用具有错误处理功能的中间件。这个中间件可以捕获（并可能处理）请求过程中发生的任何错误。
----- ------- - -------------------
----- - ----------- - - ---------------------------
----- - ----- - - -------------------
----- ------ - --------------------
----- --- - ----------
--------
-----------
-------------
-------
--------- -----
------------ ----- -- -
---------------------
------ - -------- --- ----- --------- -
-
--
--
---------------- -- -- -
------------------- ------- -- -----------------------
---这个例子使用 Express.js 中的 graphqlHTTP 中间件来创建一个 GraphQL API。 我们还使用了一个 formatError 函数来处理所有运行时错误。 这个函数可以看到发生错误的上下文，并且可以返回一个具有自定义格式的错误。
-
-------- ------ -
--
----
------- -
----
-
-
-如果您尝试查询一个不存在的用户，服务器将返回以下响应：
-
--------- -
-
---------- ------- ---- -------- ------ -- ----------
-
-
-请注意，在这个例子中我们没有提供 try-catch。 这是因为 graphqlHTTP 在内部处理和捕获所有错误，并调用您的 formatError 函数（如果有）来格式化错误。
利用 GraphQL 聚合查询错误
在 GraphQL 中，一个查询可以包含多个子查询或字段。 如果其中一个子查询或字段出错，父查询仍将按照其它部分正常工作。 这就是 GraphQL 的优势之一。即使某些查询失败，您的应用程序仍然可以提供一些可用的数据。 在这种情况下，您可能希望聚合所有子查询的错误并将它们作为单个错误报告给客户端。
为了聚合所有的错误，您可以将所有的路径（即当不可访问时出错的部分）存储在一个列表中，然后将它们传递给 Errors 对象。 下面是这样一个示例：
----- - ------------ - - -------------------
-------- ----------------------- -
----- ----- - --- ------
------
------------- -- -----------
-------------- -- -
----- ------------ - ---------------------
------------------------
---
----- ---------------- - --------------------------- -- -
----- ---- - ------------------------
----- --------- - ------
------------- -- -------------------- --- -------------
---------- -- ----------------
-------------- ----- -- ------------------ ----
----- -------- - ------
------------- -- -------------------- --- -------------
---------- -- ---------------
------ --- ---------------------------- --- ---------- ---------- ---------- ---------- ---------- -
-----
---------
---
---
------ -----------------
-这个聚合错误函数接受一个错误列表，并将它们聚合成一个 Errors 对象。 聚合过程包括两个主要步骤：
- 将所有找到的路径存储在一个集合中。
- 将每个路径的所有错误组合并返回一个
GraphQLError对象。
下面是我们如何使用这个函数：
----- ------ - ----- ---------
------- -------
--------- ---------
--------------- ---------
---
-- --------------- -
----- ------ - -------------------------------
-- --------------- -
----------- - -----
------------- - -------
-
-这个例子检查是否存在运行时错误。 如果存在，则聚合它们并将它们设置为 errors 属性。 请注意，如果有错误，则数据将设置为 null。 这是因为如果错误发生，您不能保证您的 API 将返回有效的数据。
结论
在本文中，我们深入了解了 GraphQL 运行时错误处理的机制，并探索了如何有效地处理错误。我们强烈建议您学习如何使用 GraphQL 中的 Errors 类型来构建更强大的 API 并为您的客户端提供更具体的错误消息。
请记住，错误处理是任何 API 设计的重要部分，因此您应该阅读有关如何设计和构建 GraphQL API 的其他文章和资源，以获得更多信息和最佳实践建议。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/67072907d91dce0dc8656341