GraphQL 中的错误处理:最佳实践

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

GraphQL 是一种新兴的 web 应用程序开发协议,旨在解决 REST API 中存在的一些痛点。它提供了一种基于类型系统的查询语言,通过定义客户端需要哪些数据来提高查询效率和灵活性。与 REST API 不同的是,GraphQL 在执行过程中可能会返回多个错误。

在本文中,我们将讨论在 GraphQL 中错误处理的最佳实践。我们将介绍如何识别和处理 GraphQL 中的错误,并提供一些示例代码来演示如何在应用程序中实现这些最佳实践。

1. 错误处理策略

GraphQL 查询中的错误可以分为两类:常规错误和状态错误。常规错误是指与应用程序状态无关的错误,例如输入不正确或者错误的身份验证信息。状态错误则是针对目标资源的错误,例如请求未找到或请求无效。

在处理 GraphQL 中的错误时,我们需要遵循以下的策略:

1.1 统一处理错误

为了避免重复代码和增加代码的复杂性,我们需要在应用程序中统一处理所有错误。这可以通过使用中央错误处理程序或者框架中的错误机制来实现。

1.2 返回关键信息

GraphQL 应该返回有意义的错误信息,以便于客户端能够理解并且适当地处理错误。

1.3 区分常规错误和状态错误

对于常规错误,我们应该返回适当的 HTTP 状态码。对于状态错误,我们应该返回更具体的错误信息以方便客户端做出正确的行动。

2. 最佳实践

2.1 使用 GraphQL Error 类型

GraphQL 中有一个内置的 Error 类型,它可以轻松地表示错误信息。该类型包含字符串型的 message 字段和一个可选的路径字段,用于指定出错的哪个操作。

---- ------------ -
  -------- -------
  ----- --------
-

该类型可以用于任何错误信息,而不仅仅是执行查询所引发的错误。因此,使用该类型的好处是能够轻松处理所有类型的错误,并与客户端交互。

2.2 使用 GraphQL Extension

Extensions 在 GraphQL 中提供了一种机制,它允许我们自定义处理程序,以便在查询期间执行某些任务。Extensions 中的信息可以通过对 GraphQLResponse 扩展来添加,这使得返回的响应数据集更具可读性。

下面的示例演示了如何在 GraphQL 中设置 Extensions,以便返回错误信息:

----- ------------- - -------------- -- --
  ------- -
    --- ---------------- ----- --------- -------- ----- -----------
  --
--

----- ------ - --- --------------
  ---------
  ----------
  --------
  ----------- ----------------
--

上述代码中 useExtensions 函数接受 requestContext 作为参数,可以从它中获取更多关于查询的信息。

Extensions 使错误处理更加灵活,可以将错误信息集成到响应中,避免了显式地返回错误信息的需要。

2.3 使用 Graphql-middleware

如果您正在使用 Node.js,可以使用 graphql-middleware 来处理 GraphQL 查询中的错误。它是一个针对 GraphQL 的高级中间件,可以在执行查询之前和之后执行函数。

下面的示例演示了如何在 GraphQL 中使用 graphql-middleware 来处理错误:

------ - --------------- - ---- --------------------

----- ----------- - -
  ------ -
    --- -- -- -----
  --
-

----- ---------- - -
  -- ------ ---------------------
  --------- ----- ----- -------- ----- -- -
    -- --------------- -
      ----- --- ---------- ---- -- ---------------
    -

    ------ ------------- ----- -------- -----
  --
-

----- ------ - ----------------
  ---------------------- --------- --------- ---
  ------------
  -------------
-

在上述示例中,我们定义了一个权限模块和一个中间件模块。中间件模块每次执行查询时都会被调用,根据定义检查用户是否有权执行该查询。

如果用户未通过身份验证,则会抛出一个未经授权的错误。

它可以将错误与某些读取器或其他处理程序捆绑在一起,并通过中间件机制来统一处理所有错误。

结论

本文介绍了 GraphQL 中的错误处理的最佳实践。我们讨论了如何识别常规错误和状态错误,以及如何返回适当的错误信息。我们还介绍了使用 GraphQL Error 类型、Extensions 和 graphql-middleware 的技术,并提供了示例代码来演示这些实践。

在应用程序中正确地处理错误是构建健壮和稳定的应用程序的关键。通过遵循本文介绍的最佳实践,您可以更好地处理所有类型的错误,并将其与客户端交互。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/67173faaad1e889fe22082fb


猜你喜欢

  • ESLint 如何在 React Native 项目中使用

    介绍 ESLint 是一个针对 JavaScript 代码的静态代码分析工具,常用于规范代码风格和发现一些潜在的问题。在 React Native 项目中使用 ESLint 可以帮助我们更快速地发现和...

    21 天前
  • 使用 Mocha 测试 React 应用程序

    在前端开发中,测试是不可或缺的环节。而 React 作为目前非常热门的前端框架,其测试也需要我们特别关注。在本文中,我们将介绍如何使用 Mocha 测试 React 应用程序,并深入探讨其实现原理和具...

    21 天前
  • Express.js 如何处理和存储用户密码

    Express.js 如何处理和存储用户密码 在现代 Web 应用程序中,用户账户是非常普遍和必要的一部分。为了保护用户的安全,所有的 Web 应用程序都需要为用户保密的资料,例如密码。

    21 天前
  • 从 Headless CMS 到静态网站生成器——JAMstack及技术选型

    随着互联网的不断发展,一些新的技术也层出不穷。其中JAMstack技术近年来获得了广泛关注。那么,JAMstack到底是什么呢?如何选型呢?本文将为您一一解答。 什么是 JAMstack JAMsta...

    21 天前
  • MongoDB 高可用架构实现方法解析

    MongoDB 是当今最流行的 NoSQL 数据库之一,它以其高可扩展性、性能和灵活性而闻名,成为众多企业应用程序的首选。然而,随着应用程序的规模不断增加,如何保证 MongoDB 的高可用性变得越来...

    21 天前
  • Next.js 中如何实现代码分割?

    在前端开发中,代码分割是一种优化性能和提高用户体验的常用技术。Next.js 是一款基于 React 的 SSR 框架,它内置了代码分割功能,可以帮助你更好地管理和优化你的应用程序。

    21 天前
  • PM2 实现 Node.js 自动化运维

    随着近年来 Node.js 的流行,越来越多的企业开始使用 Node.js 开发 Web 应用程序,但是生产环境下的 Node.js 应用程序管理十分麻烦,需要手动启动应用程序,监控应用程序的状态等等...

    21 天前
  • Docker-LNMP 环境配置

    前言 在开发过程中,环境配置是极其重要的一环,一个好的环境可以提高开发效率,而 Docker 可以帮助我们快速搭建出所需的环境并且方便管理与维护。本文将介绍如何使用 Docker 搭建 LNMP 环境...

    21 天前
  • 聚焦残障人士的无障碍设计理念

    引言 在网站和移动应用程序设计中,无障碍设计是非常重要的概念。它指的是让所有用户都能够访问和使用产品,包括那些残障人士。因此,无障碍设计尤其重要,因为许多人都是残障人士,比如视力、听力、运动和认知障碍...

    21 天前
  • 使用 Mocha 和 Chai 以及其他 npm 包进行前端单元测试

    在前端开发中,单元测试可以大大提高代码的质量和可维护性,也是现代前端开发流程中的一个关键环节。而 Mocha 和 Chai 就是使用最为广泛的前端单元测试工具之一。

    21 天前
  • Hapi 中 JWT 的验证与实现

    在这个数字化时代,身份认证和授权是网站和应用程序的一个重要部分。JSON Web Token(JWT)是一种用于在网络上安全传输声明的标准方法,它们可以包含用户身份认证信息和其他相关的元数据。

    21 天前
  • 如何使用客户端技术优化性能

    在以客户端为主导的Web应用程序中,性能优化一直是一个非常重要的话题。随着web前端技术的不断发展,越来越多的方案和技巧被提出来,以帮助我们优化Web应用性能。本文将会为您介绍一些客户端技术,可以用来...

    21 天前
  • 响应式设计中如何解决图像失真问题

    在响应式设计中,为不同设备提供适当的图像是至关重要的。然而,当图像尺寸改变时,可能会面临图像失真的问题。本文将介绍一些解决图像失真问题的技术,以确保响应式图像呈现的清晰度和质量。

    21 天前
  • 如何在 Node.js 中使用 NPM 来管理依赖包?

    在 Node.js 中使用 NPM(Node Package Manager,即 Node.js 包管理器)来管理依赖包是非常常见的做法。NPM 允许开发者们通过一个简单的命令行工具来下载并管理 No...

    21 天前
  • Next.js 中如何优化页面的加载速度?

    Next.js 是一个基于 React 的服务端渲染框架,可以帮助我们快速构建 React 应用。但是,随着页面变得越来越复杂,页面加载速度就成了一个越来越重要的问题。

    21 天前
  • 使用 Vue 开发 SPA 应用中的路由问题及如何解决

    Vue 是一种流行的前端框架,用于创建单页面应用(SPA)。尽管 Vue 的路由功能相当强大,但仍然有一些问题需要仔细研究和解决。这篇文章将介绍在使用 Vue 开发 SPA 应用时可能会遇到的一些路由...

    21 天前
  • Web Components 兼容性解决方案 | LitElement 库简介

    前言 Web Components 是一个日益流行的标准,它是一种用于创建可复用Web组件的技术,可以使我们创建更灵活、可维护的Web应用程序。然而,由于浏览器的兼容性问题,在实现 Web Compo...

    21 天前
  • 快速入门 Mocha 测试框架

    Mocha 是一款灵活且易于使用的 JavaScript 测试框架,它可以用于浏览器端和 Node.js 环境。本文向你介绍 Mocha 的基本用法,让你快速上手使用。

    21 天前
  • SSE 中 response 缓存导致的消息推送延迟问题解决方案

    背景 Server-Sent Events(SSE)是 HTML5 中一种常见的实现服务器推送消息至浏览器的技术。在使用 SSE 时,浏览器向服务端发送一个请求,服务端将 response strea...

    21 天前
  • Koa.js 中 API 版本控制最佳实践

    在开发 API 服务时,版本控制是非常重要的。它允许我们在不破坏客户端应用程序的情况下更改 API 的行为或结构。而 Koa.js 是一个非常灵活的 Web 框架,使用它来实现 API 版本控制是一个...

    21 天前

相关推荐

    暂无文章