GraphQL 是一种针对 API 的查询语言和运行时环境，用于通过一个统一的端点来查询、修改和订阅数据。与 REST API 相比，GraphQL 具有更高的灵活性和可定制性。但是，当我们在使用 GraphQL 进行数据查询时，经常会遇到一些错误。本文将介绍 GraphQL 中的错误处理方式以及如何在应用程序中处理这些错误。
错误处理方式
常见错误类型
GraphQL 中的错误类型通常包括以下几种：
- 语法错误：查询语句无法解析或解释。
- 运行时错误：在查询中执行过程中发生的错误，例如访问未定义的对象或试图除以零。
- 校验错误：查询违反了 Schema 中的定义，例如查询了不存在的字段或类型不匹配。
GraphQL 错误响应
处理错误的第一步是了解 GraphQL 如何响应错误。当出现错误时，GraphQL 将返回带有 errors 字段的 JSON 响应。该字段是一个包含错误信息的数组，每个错误对象包含以下字段：
message：错误消息，为字符串类型；locations（可选）：该错误发生的位置数组，每个项包含行号和列号信息；path（可选）：导致错误的查询字段路径。
以下是一个示例错误响应：
-- -------------------- ---- -------
-
--------- -
-
---------- ----- --- --------
------------ -
-
------- --
--------- -
-
--
------- -
-----------
------
-
-
-
-GraphQL 错误处理
前端应用程序中的错误处理需要对 GraphQL 返回的错误响应进行解析和处理。我们可以在 GraphQL 客户端中使用错误处理器（error handler）来处理该响应。
错误处理器可用于捕获 GraphQL 客户端中的错误，并在出现错误时执行相应的操作。例如，可以使用错误处理器在页面上显示错误消息，或将错误消息发送到错误日志。
以下是一个简单的错误处理器示例：
-- -------------------- ---- -------
----- --------------------- - ---------- -- -
-- ----------------- -
----------------------------- -- -
-----------------------------
---
- ---- -
---------------------------
-
-错误处理指南
以下是一些处理 GraphQL 错误的最佳实践：
定义自定义错误类型
自定义错误类型可以让我们更清晰地区分不同类型的错误。例如，我们可以使用自定义错误类型来表示身份验证错误、数据库错误、输入验证错误等。
-- -------------------- ---- -------
----- ------------------- ------- ----- -
------------- -
--------------------- --------
--------- - ----------------------
-
-
----- ------------- ------- ----- -
------------- -
--------------- --------
--------- - ----------------
-
-
----- -------------------- ------- ----- -
------------- -
------------ ---------- --------
--------- - -----------------------
-
-处理错误堆栈
当我们从后端收到 GraphQL 错误响应时，错误堆栈可能会被截断。在我们的代码中，我们可以尝试解组错误对象，以便更清楚地了解错误发生的位置。
-- -------------------- ---- -------
----- --------------------- - ---------- -- -
-- ----------------- -
----------------------------- -- -
-----------------------------
-- ----------------- -
----------------- ----------------------------------------------------------
-
---
- ---- -
---------------------------
-
-忽略无用的错误
当我们提交查询时，我们有时会得到一些不重要或无用的错误。这些错误可能由某些查询参数或接口版本造成，而不是我们实际写的查询本身。
在这种情况下，我们可以尝试忽略这些错误，只处理重要的错误。例如，我们可以使用正则表达式来过滤掉某些错误消息。
-- -------------------- ---- -------
----- -------------- - -
--------- ----------
------ ----------
--
----- --------------------- - ---------- -- -
-- ----------------- -
----------------------------- -- -
-- ------------------------ -- ------------------------ -
-----------------------------
-
---
- ---- -
---------------------------
-
-示例代码
以下是一个使用 JavaScript 和 React 的 GraphQL 查询示例。该应用程序演示了如何从 GraphQL 响应中提取数据和错误，并将错误消息显示在页面上。
-- -------------------- ---- -------
------ ------ - -------- - ---- --------
------ - ---- -------- - ---- -----------------
----- ---------- - ----
----- -------------- ---- -
------------ ---- -
--
----
-----
-
-
--
----- ---- - -- -- -- -- -
----- - -------- ------ ---- - - -------------------- -
---------- - -- --
---
----- -------------- ---------------- - ---------------
-- --------- ------ ------------------
-- ------- -
-----------------------------
-------------------------------
------ -----
-
------ -
-----
------------- -- ----------------------
-------- ------------------------
--------- -------------------------
------
--
--
------ ------- -----以上代码使用 useQuery 钩子查询数据库，如果出现错误，则将 error.message 存储在组件状态中，并将其显示在页面上。
结论
在使用 GraphQL 进行数据查询时，我们经常会遇到各种错误。了解 GraphQL 的错误处理方式以及如何在应用程序中处理这些错误非常重要。在本文中，我们介绍了 GraphQL 中的错误类型，以及如何使用错误处理器处理错误响应。我们还讨论了一些处理 GraphQL 错误的最佳实践，包括定义自定义错误类型、处理错误堆栈和忽略无用的错误。最后，我们提供了一个示例代码，展示了如何从 GraphQL 响应中提取数据和错误。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67034e4ad91dce0dc84af56f