GraphQL 返回错误处理及异常信息解析

面试官：小伙子，你的数组去重方式惊艳到我了

引言

GraphQL 是一种用于 API 的查询语言，它让客户端可以精确地获取所需的数据，避免了过度获取不必要的数据。而当用户发送 GraphQL 查询时，如果查询中存在某些错误，比如字段不存在、类型错误等，GraphQL 服务端会返回一个错误响应。

本文将探讨 GraphQL 返回错误处理及异常信息解析的相关知识，以及如何在前端进行错误处理和异常信息解析。本文假设你已经对 GraphQL 有一定的了解，并且熟悉以下技术栈：React、Apollo Client。

错误响应格式

GraphQL 返回的错误响应格式如下所示：

-
  --------- -
    -
      ---------- ------- ----- ----- ------- -- ---- ------------
      ------------ -
        -
          ------- --
          --------- -
        -
      -
    -
  -
-
  • errors：一个数组，其中每一项都是一个表示错误信息的对象。
  • message：错误信息字符串。
  • locations：一个数组，其中每一项都是表示错误在查询文本中的位置的对象。

错误处理

当 GraphQL 返回错误时，我们需要在前端进行相应的错误处理。在 React 应用中，可以使用 Apollo Client 提供的 ApolloError 类处理 GraphQL 错误。有两种方法可以处理 GraphQL 错误：

1.使用 useQuery

useQuery 是 React Hooks 的一种，它可以与 ApolloProvider 配合使用，方便地从 GraphQL 查询获取数据。useQuery 可以接受一个名为 errorPolicy 的属性，用于指定当 GraphQL 查询返回错误时应采取的策略。errorPolicy 属性有以下几个值：

  • "none"：默认值，将错误传递到组件的 ApolloError 状态中。
  • "ignore"：忽略错误，不会触发任何错误处理逻辑。
  • "all"：将错误传递到组件的 ApolloError 状态中，并显示错误提示。

示例代码：

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

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

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

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

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

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

2.使用 catch

除了在 useQuery 中设置 errorPolicy 属性外，还可以使用 catch 方法捕获错误并进行处理。catch 方法返回一个新的 Observable，它可以让我们在 Apollo Client 缓存之前拦截错误，并采取自定义的错误处理逻辑。

示例代码：

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

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

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

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

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

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

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

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

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

异常信息解析

当 GraphQL 返回错误时，我们可能需要对错误信息进行解析，以便更好地向用户传达错误信息。在解析 GraphQL 异常信息时，我们通常会从以下几个方面入手：

1.错误类型

GraphQL 返回的错误信息可以基于错误类型分类，比如查询错误、验证错误、执行错误等。可以根据错误类型，对错误信息进行分类展示。

示例代码：

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

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

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

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

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

2.错误字段

GraphQL 返回的错误信息中通常会包含错误字段，也就是查询中存在问题的字段。可以将错误字段高亮展示，以帮助用户更快地找到错误。

示例代码：

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

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

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

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

3.错误消息

GraphQL 返回的错误信息可能很长，需要对错误消息进行截断或者格式化，以便更好地展示给用户。可以采取一些常用的格式化方式，比如截断消息、将长消息折叠起来等。

示例代码：

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

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

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

结论

本文探讨了 GraphQL 返回错误处理及异常信息解析的相关知识，并介绍了几种处理 GraphQL 错误的方法。在开发中，我们应该根据实际需求，灵活使用这些技术，以便更好地展示 GraphQL 错误信息，提升用户体验。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/66fffc27485b53fc16b7c4d0

阅读全文

猜你喜欢

  • ES7 目前的新特性列表

    ES7 （ECMAScript 2016）是 JavaScript 的下一个版本，它已在 2016 年发布。与前代版本相比，ES7 引入了许多重要的特性和改进，使得编写和维护代码变得更加容易和高效。

    13 天前
  • Sequelize，Node.js 和 MySQL：基本查询

    前言 随着互联网时代的不断发展，Web 应用程序越来越复杂。前端技术框架如雨后春笋一般迅速发展，提供了更快速、简单、灵活、可复用的开发方式。为了满足复杂的业务需求，后端技术也需要不断向前发展，因为 W...

    14 天前
  • Serverless 架构：优点和缺点

    在构建 Web 应用程序时，Serverless 架构是一个越来越流行和引人注目的选择。由于它的优点和独特性，并且它的云供应商现在提供越来越多的Serverless服务。

    14 天前
  • 如何在 Deno 中实现自动部署

    在当今的软件开发环境中，自动化部署已经变得非常重要。通过自动化部署，可以加快软件的开发周期并确保产品的质量和稳定性。在本文中，我们将讨论如何在 Deno 中实现自动部署。

    14 天前
  • ES6增强了什么？开发者应该如何学习

    ES6是ECMAScript的第6个版本，全称为ECMAScript 2015。它是JavaScript语言的一次巨大升级，引入了许多新特性和语法糖，使得前端开发变得更加灵活、高效、易于维护。

    14 天前
  • 无障碍测试与修复技术

    前言 如今，随着科技的不断发展，我们的生活已经开始了数字化转型之路，同时也给了很多残障人士更多的机会融入这个数字化的世界。但是，由于网络产品设计和开发者的知识和资历不同，导致其无法在使用辅助技术辅助下...

    14 天前
  • ECMAScript2019 (ES10) 和 ES2020 (ES11) 的新功能详解

    自从JavaScript成为前端开发的主流技术后，一直在不断地更新和升级。ECMAScript是JavaScript的标准，而ES10和ES11是最新的版本，引入了一些新的功能和特性。

    14 天前
  • Mongoose 中使用 $pull 方法删除数组类型数据相关记录

    在 MongoDB 中，可以使用数组类型数据记录相关信息。在 Mongoose 中，可以使用 $pull 方法删除这些信息。本篇文章将详细介绍 $pull 方法的用法和示例代码，以帮助开发者更好地应用...

    14 天前
  • MongoDB 集群环境的搭建与维护

    简介 MongoDB 是目前非常流行的 NoSQL 数据库，在 web 开发和大数据领域应用广泛。在大数据和高并发的情况下，为了保证数据安全和可用性，我们需要搭建 MongoDB 集群环境。

    14 天前
  • 响应式设计中的清除浮动问题及方案

    在进行响应式设计时，通常都会遇到浮动元素引起的问题。在使用浮动元素时，需要注意浮动元素的位置和大小，否则页面布局可能会出现混乱的情况。为了避免这种情况，我们需要在浮动元素后面加上清除浮动。

    14 天前
  • Docker 容器中如何安装 PostgreSQL？

    前言 在前端开发过程中，我们经常需要使用到各种数据库，比如 PostgreSQL。而在使用 Docker 搭建开发环境时，我们需要在容器中安装 PostgreSQL。

    14 天前
  • 为什么选择 Serverless 架构？

    随着云计算的发展，越来越多的企业开始关注 Serverless 架构。Serverless 架构是一种全新的应用架构模型，具有许多优点，如可扩展性、高可用性、低成本等。

    14 天前
  • 使用 TypeScript 编写 RESTful API 时遇到的坑和解决方案

    在开发 RESTful API 的过程中，使用 TypeScript 可以大大提高代码的可读性、可维护性和健壮性。但是，我们也会遇到一些坑点。在本文中，我们将分享一些在编写 TypeScript 中 ...

    14 天前
  • Cypress 测试 React 应用时如何模拟异步数据

    在前端开发的过程中，我们经常会遇到需要模拟异步数据来测试页面展示的情况。针对 React 应用，Cypress 提供了多种方法来模拟异步数据，使得我们的测试能够更加健壮可靠。

    14 天前
  • 如何使用 ES12 的 for-await-of 来处理异步 Iterable

    随着前端应用变得越来越复杂，异步编程（asynchronous programming）已成为非常重要的一部分，但在使用 Promise、async/await 等异步编程技术时也会遇到一些问题，例如...

    14 天前
  • 如何在 CSS Flexbox 布局中实现图文混排

    CSS Flexbox 布局是一种流行的前端布局技术，可以轻易地实现自适应、可伸缩的布局，同时也支持图文混排。本文将详细介绍如何在 Flexbox 布局中实现图文混排，并提供示例代码和实践指导，帮助读...

    14 天前
  • 无障碍演示技巧

    随着互联网的不断发展和普及，越来越多的人使用互联网进行学习、娱乐和工作等。但是有一类人群却面临着障碍，他们是视觉障碍者、听觉障碍者以及行动障碍者等。为了让我们的网站和应用更具包容性，我们需要考虑到障碍...

    14 天前
  • 如何在 Jest 测试中模拟简单重定向

    当开发一个前端应用时，我们需要经常测试我们的代码。针对每个组件和功能进行测试可以帮助我们确保应用程序正常工作，并且随时可以检测到和修复错误。在现代的前端应用程序中，我们通常使用 Jest 作为我们的测...

    14 天前
  • 经验分享：如何在 Webpack 中构建 Web Components？

    Web Components 是一种浏览器的原生组件，有着许多优秀的特性，包括封装、复用、解耦等。在现今的 Web 开发中越来越受到开发者们的关注和使用。 Webpack 作为前端领域最受欢迎的模块打...

    14 天前
  • 如何使用 JProfiler 进行 Java 程序性能分析与调优

    随着Web应用程序越来越复杂和庞大，优化程序的性能变得日益重要。 JProfiler是一款功能强大的Java性能分析器，可以帮助您找出性能问题，并提供有用的信息来改进您的代码。

    14 天前

相关推荐

    暂无文章