GraphQL 是一种用于 API 开发的查询语言，它提供了一种更加灵活和高效的方式来请求和响应数据。而 Apollo Server 是一个支持 GraphQL 的服务器，它可以帮助我们快速构建高可用的 GraphQL API。在开发 GraphQL API 的过程中，错误处理是一个必须要考虑的问题。本文将介绍如何在 Apollo Server 中处理错误，以及如何优雅地向客户端返回错误信息。
错误处理
在 Apollo Server 中，错误可以分为两类：业务错误和系统错误。业务错误是由于客户端请求参数不合法或者数据查询失败等原因引起的错误，这些错误是可以预见的，我们需要在代码中进行处理。系统错误则是由于代码本身的问题引起的错误，例如数据库连接失败、内存溢出等，这些错误是不可预见的，我们需要在代码中进行捕获和处理，以防止服务器崩溃。
在 Apollo Server 中，我们可以使用 try-catch 语句来捕获异常并处理业务错误。例如，当客户端请求一个不存在的用户时，我们可以抛出一个 UserNotFoundError 异常，并在 catch 语句中返回一个包含错误信息的 GraphQL 错误对象。
-- -------------------- ---- -------
------ - ----------- - ---- ----------------
----- --------- - -
------ -
-------- ----- --- - -- -- -- -
--- -
----- ---- - ----- ----------------
-- ------- -
----- --- --------------------
-
------ -----
- ----- ------- -
----- --- -------------------------- ------------------
-
--
--
--在上面的例子中，当 getUserById 函数返回 null 时，我们会抛出一个 UserNotFoundError 异常。在 catch 语句中，我们使用 ApolloError 类来创建一个包含错误信息和错误码的 GraphQL 错误对象。这个错误对象会被 Apollo Server 自动捕获并返回给客户端，客户端可以根据错误码来进行相应的处理。
除了使用 try-catch 语句来处理业务错误之外，我们还可以使用 Apollo Server 提供的 ValidationError 类来进行参数验证。例如，当客户端请求一个不存在的用户时，我们可以使用 ValidationError 类来验证参数，如果参数不合法，则会抛出一个包含错误信息和错误码的 GraphQL 错误对象。
-- -------------------- ---- -------
------ - --------------- - ---- ----------------
----- --------- - -
------ -
-------- ----- --- - -- -- -- -
----- ---- - ----- ----------------
-- ------- -
----- --- --------------------- --- ------- ------------------
-
------ -----
--
--
--在上面的例子中，当 id 参数不合法时，我们会抛出一个 ValidationError 异常。这个异常会被 Apollo Server 捕获并返回一个包含错误信息和错误码的 GraphQL 错误对象。
错误格式化
在 Apollo Server 中，我们可以使用 formatError 选项来自定义错误格式化。这个选项接收一个函数作为参数，这个函数会在捕获到错误时被调用，并返回一个格式化后的错误对象。我们可以使用这个函数来自定义错误信息和错误码的格式。
-- -------------------- ---- -------
----- ------ - --- --------------
---------
----------
------------ ------- -- -
----- ------- - ----------------------------- -- ----
----- ---- - --------------------- -- ------------------------
------ - -------- ---- --
--
---在上面的例子中，我们自定义了一个 formatError 函数，这个函数会去掉错误信息中的 Error 前缀，并将错误码设置为 extensions.code 或者 INTERNAL_SERVER_ERROR。
错误分类
在 Apollo Server 中，我们可以使用自定义错误类来对错误进行分类。这样做可以更加清晰地区分不同类型的错误，并且可以方便地进行错误处理和调试。例如，我们可以创建一个 UserNotFoundError 类来表示用户不存在的错误。
class UserNotFoundError extends Error {
constructor(message = 'User not found') {
super(message);
this.name = 'UserNotFoundError';
this.extensions = { code: 'USER_NOT_FOUND' };
}
}在上面的例子中，我们创建了一个 UserNotFoundError 类，这个类继承自 Error 类，表示一个用户不存在的错误。我们可以在这个类中设置错误信息和错误码，并且可以在代码中使用 throw new UserNotFoundError() 来抛出这个错误。
总结
在 Apollo Server 中，错误处理是一个必须要考虑的问题。我们可以使用 try-catch 语句来捕获异常并处理业务错误，使用 ValidationError 类来进行参数验证，使用 formatError 选项来自定义错误格式化，使用自定义错误类来对错误进行分类。这些技巧可以帮助我们更加优雅地处理错误，并且提高代码的可读性和可维护性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65d653131886fbafa4411c82