前言
GraphQL 是一种用于 API 设计的语言，它可以帮助前端开发人员更高效地获取和更新数据。然而，在使用 GraphQL 进行开发时，错误和异常将随时可能发生，这就需要我们了解 GraphQL 中的错误处理和异常处理方法。
本文将详细介绍 GraphQL 中的错误处理及异常处理方法，并提供一些示例代码。希望可以对前端开发人员有所帮助。
GraphQL 中的错误处理
在 GraphQL 中，错误可以分成两类：语法错误和运行时错误。语法错误通常是在定义 GraphQL Schema 或者编写查询语句时出现的错误，这些错误可以在编码过程中被发现并修复。运行时错误则是指在服务器端执行查询时出现的错误，例如查询不存在的字段、参数错误等等。
在 GraphQL 中，如果服务器端执行查询过程中出现了错误，GraphQL 会将错误信息打包在一个统一的报告中，称为 GraphQL 错误报告。该报告包含了以下信息：
- 一个错误数组，包含每个出现的错误信息
- 每个错误信息包含具体错误类型、错误描述和扩展错误信息等
- 请求和响应的数据
GraphQL 错误报告可以让开发人员更方便地定位问题，同时也可以提高系统的健壮性。下面将介绍如何在 GraphQL 中处理错误。
服务端错误处理
GraphQL 的服务端错误处理通常分为以下几个步骤：
检查查询合法性：在服务器端执行查询之前，需要先检查查询语句的合法性，包括查询语句是否符合 Schema 规范、查询参数是否合法等。
返回错误信息：如果查询不合法或者执行查询过程中发生了错误，服务器端需要返回一个包含错误信息的 JSON 对象。
例如，在 Node.js 中可以使用以下代码处理错误：
graphql(schema, query).then(result => {
if (result.errors) {
res.status(400).json({ errors: result.errors })
} else {
res.json({ data: result.data })
}
})如果查询过程中出现了错误，就将错误信息返回给客户端。
客户端错误处理
在 GraphQL 中，客户端也需要处理错误，主要是针对查询参数的错误处理。
GraphQL 提供了一种方式让客户端检测输入参数是否合法，即使用 Fragment：
-- -------------------- ---- -------
-------- -------- -- ---- -
--
----
-----
-
----- ------------- ---- -
-------- -------- -
-----------
----- -
--
-----
-
-
-通过 Fragment，可以先定义查询需要返回的类型，并在查询中引用。如果 Fragment 中定义的类型与实际返回的类型不一致，GraphQL 将会返回一个类型错误。
注意，需要在查询中声明参数变量并赋值，以防止参数错误。
-- -------------------- ---- -------
----- ------------- ---- -
-------- -------- -
-----------
----- -
--
-----
-
-
-
----------
-
--------- -------
-可以使用以下代码处理客户端错误：
const errors = result.errors ? result.errors.map(error => error.message).join('\n') : null
if (errors) {
alert(errors)
}在客户端中，如果查询不合法或者执行查询过程中发生了错误，应该提示用户错误信息。
GraphQL 中的异常处理
在 GraphQL 中，异常处理和错误处理有些不同。错误处理是指在执行查询过程中发生的问题，而异常处理则是指在解析查询语句时发生的问题。
异常处理通常包括以下两个方面：
数据源异常：在解析查询语句时，可能会调用数据源或者第三方 API ，这时会发生异常。如果不处理这些异常，将会退出整个应用程序。
安全性问题：在解析查询语句时，可能会发现查询包含非法参数或者条件，这可能会造成安全性问题。因此，需要对查询进行安全性检查和过滤。
以下是一个例子，用于演示如何在 GraphQL 中处理异常：
-- -------------------- ---- ------- ---- ----- - ----------- ------ ---- - ---- ---- - --- ---- --------- ------ - ---- -------- - -------------------- -------- ---- -
上面的代码定义了一个查询 getUser 和一个变更 createUser。现在我们要在执行 createUser 时，检查 username 是否已存在。
可以使用以下代码处理异常：
-- -------------------- ---- ------- ----- - -------- - - ---- -- --------- -- -------------------- -- ------------- --- ---------- - ----- --- --------------- ----------- -- ------- ------- - ----- ------- - - --- ----------------- - -- -------- - ------------------------ ------ -------
如果 username 已经存在，则会抛出异常，并返回错误信息。
总结
在 GraphQL 中，错误和异常处理对于系统的稳定性和安全性至关重要。本文详细介绍了 GraphQL 中的错误处理及异常处理方法，并提供了一些示例代码。建议前端开发人员在开发过程中，注意错误和异常处理，提高系统的可靠性和安全性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65a34782add4f0e0ffb64ae6