GraphQL 是一种用于 API 开发的查询语言，具有强大的灵活性、易于扩展和适应多种数据源的能力。然而，不可避免地，由于多方面原因，GraphQL API 会抛出异常。因此，如何进行合理的异常处理，是我们在开发 GraphQL API 时必须要考虑的一个关键问题。
在本文中，我们将介绍 GraphQL 异常的基本概念，以及如何在前端应用程序中合理地处理异常，以保证应用程序的健壮性和可靠性。
GraphQL 异常的基本概念
GraphQL 查询中可能包含的异常主要分为以下几类：
- 语法错误（Syntax Errors）
当查询中包含语法错误时，GraphQL 服务器会抛出语法异常。这种异常通常是由于查询语句中的拼写错误或者缺少必需的参数等原因而引起的。
- 运行时错误（Runtime Errors）
运行时错误是指在查询中引用的数据、字段或类型等不存在时，GraphQL 服务器会抛出的异常，这种异常通常与后端数据源相关。
- 权限错误（Permission Errors）
如果查询包含需要授权才能执行的字段，但用户没有权限，则 GraphQL 服务器会抛出权限异常。
- 自定义错误（Custom Errors）
有时，我们需要在查询中检查自定义逻辑，并因此引发异常。此时，我们可以定义自定义异常类型，以便在应用程序中进行处理。
GraphQL 异常处理的基本原则
在处理 GraphQL 异常时，有几个重要的原则需要遵循：
- 合理定义错误类型
异常通常会分为多个类型，以提供更好的异常信息并使错误的处理更加直观。在定义异常类型时，应牢记以下原则：
- 异常类型应该明确地指出出错了什么。
- 异常应该被定义为清晰且有意义的数据结构，包含错误信息以及调试所需的有用信息。
- 异常类型应优化为易于使用和维护的形式，例如，尽量使用标准的 JavaScript 对象或类。
- 保护机密信息
GraphQL 异常处理的另一个关键原则是保护敏感信息，例如数据库的密码、API 密钥或其他私人数据。在处理异常时，需要牢记以下原则：
- 避免向客户端披露敏感数据。
- 报告和处理异常时，应该尽可能少地披露异常的根本原因。
- 对于安全性要求更高的应用程序，可能需要网关、中间层或其他实现机制，以过滤异常中的敏感信息。
- 合理处理异常
最后一个重要原则是合理地处理异常。对于 GraphQL 的客户端应用程序，以下原则非常重要：
- 应该尽可能早地捕获 GraphQL 异常。
- 在处理异常时，应该提供足够的错误信息以便于调试和修复异常。
- 当处理异常时，应该提供有用的帮助信息，例如向用户展示友好的错误信息，而不是一眼看不懂的堆栈跟踪信息。
实战：如何合理地处理 GraphQL 异常
接下来我们将通过一个示例程序，介绍如何在前端应用程序中合理地处理 GraphQL 异常。
本文使用的是 Apollo Client 作为客户端库。Apollo Client 是一个流行的 GraphQL 客户端，它集成了许多强大的特性，为我们提供了轻松创建和管理 GraphQL 客户端的优秀体验。
在开始之前，我们需要确保已经按照以下步骤配置了我们的 Apollo Client：
- 安装所需的依赖项：
--- ------- ------------- ------- ----------- ------------
- 创建 Apollo Client 对象：
------ - ------------ - ---- ----------------
------ - -------- - ---- -------------------
------ - ------------- - ---- ------------------------
----- ------ - --- --------------
----- --- ----------
---- --------------------------------
------
---
------ --- ----------------
---在此示例中，我们创建了一个 Apollo Client 实例，并将其链接到远程服务器。客户端使用 HttpLink 与远程服务器进行数据交互，使用 InMemoryCache 对数据进行缓存。
有了这个 Apollo Client，我们就可以开始查询我们的 GraphQL 服务器了。然而，当我们向服务器发送查询时，可能会出现异常。因此，在接下来的代码中，我们将展示如何合理处理这些异常。
在实例代码中，我们将使用一个简单的 GraphQL 查询来查询仓库列表：
------ --- ---- --------------
----- ---------------- - ----
----- ------------------------- -------- ------ -------- -
----------------- ------- ----- ------ -
--
----
---------
-
-
--我们将使用 react-apollo 包装我们的组件，以便在组件的 props 中使用我们的查询：
------ ----- ---- --------
------ - ------- - ---- ---------------
----- -------------- ------- --------------- -
-------- -
----- - ----- - ------ ---------- - - - -----------
-- ------- -
------ -
-----
----------------------
------
--
-
-- ------------- -
------ -
-----
-----------------
------
--
-
------ -
-----
--------------------------
---------- -- --------------------------
------
--
-
-
------ ------- ------------------------- -
-------- ------- -- --
---------- -
------ ------------
----- -----------
--
---
-------------------在上面的代码中，我们有一个 RepositoryList 组件，该组件使用 graphql 高阶函数将 REPOSITORY_QUERY 绑定到我们的组件上。在渲染组件时，我们首先检查我们是否遇到了异常，并根据异常情况返回错误信息或正在加载的提示信息。最后，如果查询成功，则返回仓库信息。
至此，我们已经介绍了如何在前端应用程序中合理地处理 GraphQL 异常。虽然这里只是一个示例代码，但是我们可以根据这个示例代码扩展出更为复杂的实现方式，并根据我们所使用的具体框架或库来处理查询的异常。
结论
GraphQL 异常处理在前端应用程序开发中是一个关键问题。在这篇文章中，我们介绍了 GraphQL 异常的基本概念，以及在前端应用程序中合理处理异常的几个原则。最后，我们通过示例代码演示了如何使用 Apollo Client 和 react-apollo 包装组件来处理 GraphQL 查询的异常，以便读者了解如何在实践中处理 GraphQL 查询的异常。
如果您正在开发一个需要使用 GraphQL 的前端应用程序，我们强烈建议您查阅 GraphQL 的官方文档，以了解更多关于异常处理的详细信息，并根据您的具体情况来选择适当的异常处理方案。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/670f4c195f55128102639a01