GraphQL 是一种用于 API 构建的查询语言，它具有高度的灵活性和可扩展性。然而，当开发者在使用 GraphQL 时，错误处理是一个不可避免的问题，因为当请求出现错误时，客户端需要得到清晰的反馈以便进行调整和修正。本文将探讨 GraphQL 错误处理的最佳实践，包括如何定义错误类型、记录错误、格式化错误信息等。
定义错误类型
首先，我们需要为 GraphQL 定义自定义的错误类型。这可以通过创建一个包含错误代码、消息和可选详细信息的对象来实现。例如：
---- --------- - ---------------- ------------------- -------------- - ---- ------- - ----- ---------- -------- ------- -------- ------ -
在这种情况下，我们定义了一个枚举类型 ErrorCode，它包含了一些常见的错误类型。然后我们定义了一个 MyError 类型，它包含了错误编码、错误消息和可选的详细信息。根据实际情况，我们可以自由地定义自己的错误类型以适应项目需求。
记录错误
其次，我们需要确保错误是被捕获并记录的。对于 GraphQL，这意味着我们需要在执行查询时捕获所有错误，并在服务器端记录它们。这可以通过通用的错误处理程序来实现。例如：
------------------- -------------
-------
--------- -----
------------ ----- -- -
-- ----
--------------------
-- ------
------ -
----- -------------------------
-------- --- ---------- ----- --------- ------ --- ----- -------
--
-
----在这种情况下，我们使用了 graphqlHTTP 中的 formatError 选项来捕获错误并记录它们。我们还可以根据需要自定义错误消息和错误代码。
格式化错误信息
最后，我们需要确保将错误信息以一种易于理解的格式返回给客户端。对于 GraphQL，我们可以使用 GraphQL 规范中定义的错误格式。例如：
-
--------- -
-
---------- -------- ----- --- ----- ----------
------------ -
-
------- --
--------- -
-
--
------- -
-------
--
------------- -
------- -------------------
---------- ------ -- --- -------
-
-
--
------- ----
-在这种情况下，我们返回了一个包含 errors 和 data 属性的 JSON 对象。errors 属性是一个数组，其中包含了一个或多个错误对象，每个错误对象都包含了消息、位置、路径和扩展信息。客户端可以使用这些信息来了解错误的原因以及如何修复它。
结论
在 GraphQL 中进行错误处理是不可或缺的，本文介绍了三个最佳实践：定义错误类型、记录错误和格式化错误信息。这些实践可以使我们更好地理解和调试问题，并使客户端更容易理解错误消息。使用这些实践，我们可以设计出更健壮的 GraphQL API。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/6729d3932e7021665e25c599