浅谈 GraphQL Mutation 中的错误处理

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

前言

在使用 GraphQL 进行数据操作的时候,我们可以使用 Mutation 语句来进行数据的增删改操作,这个过程中可能会发生一些错误,比如非空字段为空、数据验证不通过等等。因此,我们需要对 GraphQL Mutation 中的错误处理进行认真的讨论和学习。

Mutation 错误类型

在 GraphQL 中,Mutation 可以返回两种类型的错误,分别为字段级别的错误和实体级别的错误。

字段级别的错误

字段级别的错误指的是某个字段的某个值或某个操作无法完成,比如非空字段为空或数据验证不通过等等。这种错误不会影响整个 Mutation 的执行,而是只会影响到某个字段。

在 GraphQL 中,我们可以使用 Non Null 字段类型(比如 String!Int! 等)来确保某个字段不为空。当这个字段为空的时候,GraphQL 会返回一个 null 值,并且在查询结果中添加一个路径用于指示错误发生的位置,我们可以在客户端通过这个路径来进行相应的错误处理。

例如,我们有一个创建用户的 Mutation,其中有一个非空字段 name

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

当我们调用这个 Mutation 的时候,如果未传递 name 字段或者 name 字段为空字符串,GraphQL 会返回类似以下的错误信息:

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

实体级别的错误

实体级别的错误指的是整个 Mutation 无法完成,比如插入或者更新数据库时出现了错误。

在 GraphQL 中,我们可以使用异常来表示实体级别的错误,并在 Mutation 的返回值中添加 errors 字段来返回异常的信息。

例如,我们有一个更新用户的 Mutation,当更新失败的时候会抛出一个 UserNotFoundException 异常:

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

当我们调用这个 Mutation 的时候,如果传递的 id 不存在,GraphQL 会返回类似以下的错误信息:

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

Mutation 错误处理

如何处理 Mutation 中的错误呢?下面是一些处理 Mutation 错误的建议:

在文档中说明错误

在文档中说明 Mutation 可能会返回哪些错误以及错误的原因,这样可以让客户端更加清楚地知道错误的信息和如何处理这些错误。

例如,我们可以在文档中添加 Mutation 的注释说明:

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

---------

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

返回错误信息

在 Mutation 的返回值中添加 errors 字段来返回错误信息,这样客户端就可以根据错误信息来进行相应的错误处理。

例如,在 GraphQL 的解析器中可以这样返回错误信息:

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

使用 Union 类型

如果有多种类型的错误,我们可以使用 Union 类型来表示这些错误,例如:

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

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

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

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

使用一致的错误代码

使用一致的错误代码可以让客户端更加容易地处理错误。例如,HTTP 中的状态码和错误码可以使用一致的编号来表示。

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

总结

在使用 GraphQL 进行数据操作的时候,我们需要对 Mutation 中的错误处理进行认真的讨论和学习。比如在文档中说明错误、返回错误信息、使用 Union 类型、使用一致的错误代码等等。这些建议可以帮助我们更好地处理 Mutation 中的错误,提高开发效率,这对于前端开发来说是非常重要的。

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


猜你喜欢

  • 如何在 Express.js 中使用 JWT 进行身份验证?

    随着互联网及移动互联网的快速发展,越来越多的应用程序需要进行用户身份验证及管理。为了满足这些需求,使用 JSON Web Token(JWT)进行用户身份验证已经成为技术领域的常见做法。

    43 分钟前
  • 在 GraphQL 中处理复杂的对象关系

    在现代的 web 应用中,对象之间的关系变得越来越复杂。例如,一个出售商品的商店可能会有许多不同的商品,其中每个商品可能会有多个大小、颜色、类型等变体。在以前,为了处理这种情况,我们需要在后端编写各种...

    44 分钟前
  • 如何使用 Jest 测试 Node.js 应用?

    Jest 是一款由 Facebook 开发的开源 JavaScript 测试框架。它被广泛用于前端和 Node.js 应用程序的单元测试、集成测试和端到端测试。在本篇文章中,我们将学习如何使用 Jes...

    1 小时前
  • Android 开发中 Material Design 中 TabLayout 的使用技巧

    前言 随着移动互联网的快速发展,在 Android 开发中,Material Design 成为了最流行的设计指南之一。TabLayout 是 Material Design 中一个重要的组件,具有良...

    1 小时前
  • PM2 与 NGINX:构建高性能的 Node.js 应用程序

    Node.js 是一个快速而又高效的 JavaScript 运行环境,正因为如此,它已经成为了构建 Web 应用、REST API 和实时应用的理想选择。但随着 Node.js 应用程序的愈加复杂,它...

    1 小时前
  • Headless CMS 中使用 Webhooks 实现自动构建

    随着静态网页生成器的流行,Headless CMS 越来越受到开发者们的重视。Headless CMS 不仅提供了现代化的管理界面,还允许开发者通过 API 或 Webhooks 来获取内容。

    1 小时前
  • ES10 实战教程

    前言 ES10,也就是 ECMAScript 2019,是 JavaScript 的最新版本。自 2015 年发布了 ES6 以来,JavaScript 变得越来越流行,并且在近几年里,前端技术发展迅...

    1 小时前
  • Serverless 如何实现自动备份?

    在 Serverless 架构中,由于无需维护服务器,开发者可以更专注于实现业务逻辑。但是,我们还是需要解决一些重要问题,如数据备份、数据恢复和灾难恢复等。在本文中,我们将探讨如何使用 Serverl...

    1 小时前
  • Jest 测试 React 组件中使用 context 的方法探究

    在 React 应用中,我们可能需要在组件间共享一些数据或者函数,这时可以通过 Context 来实现。但是在测试使用 Context 的组件时,我们可能会遇到一些问题。

    1 小时前
  • SSE 如何设置头信息?

    简介 SSE(Server-Sent Events)是一种轻量级的实时推送技术,在前端开发中经常用于推送服务器实时消息,比如聊天、订阅等。SSE 可以通过 HTTP 协议进行传输,因此需要设置合适的头...

    1 小时前
  • 在 Docker 容器中使用 SSH

    随着前端应用程序的复杂性增加,开发环境的设置变得越来越麻烦。 Docker 是一个流行的容器化解决方案,它可以帮助我们在标准化的环境中进行开发。在这篇文章中,我们将学习如何在 Docker 容器中使用...

    1 小时前
  • CSS Grid 游戏(Grid Garden)学习笔记

    CSS Grid 游戏(Grid Garden)学习笔记 CSS Grid 是一个强大的布局工具,它可以让我们轻松地实现复杂的网页布局。但是,学习 CSS Grid 的过程可能会有些枯燥。

    1 小时前
  • React 中使用 setInterval 时的注意事项

    引言 在 React 中,我们很常见地使用 setInterval 来创建周期性的任务。在实际开发中,我们需要注意一些细节和陷阱,以确保周期性任务能够正确地运行。本文将会介绍 React 中使用 se...

    1 小时前
  • 如何在使用 CSS Reset 的情况下保持 flexbox 布局?

    什么是 CSS Reset? 在我们开始探讨在使用 CSS Reset 的情况下保持 flexbox 布局之前,我们需要先了解什么是 CSS Reset。CSS Reset 是一种用于归零不同浏览器之...

    1 小时前
  • 使用 Web Components 构建可重用的模态框组件

    Web Components 是 Web 技术的一种新型组成部分,可以让开发者创建封装的自定义元素。通过 Web Components,开发者可以更加轻松地构建可重用的 UI 组件。

    1 小时前
  • 如何优化 iOS 应用程序的性能

    作为一名前端开发人员,我们常常需要优化我们的应用程序的性能,以提供更好的用户体验。在 iOS 平台上,优化应用程序的性能尤为重要。本文将介绍一些优化 iOS 应用程序性能的技巧和策略,帮助开发人员提高...

    1 小时前
  • 响应式设计中的样式调整

    随着移动设备的普及,人们越来越多地使用手机和平板电脑浏览网站。因此,响应式设计已成为现代 Web 设计的必要趋势。在响应式设计中,我们需要针对不同的设备大小和屏幕分辨率,调整样式和布局以确保网站能够良...

    1 小时前
  • 在 Fastify 中处理文件上传

    Fastify 是一个快速、低开销和易于学习的 Web 框架,其性能排名领先。在开发过程中,我们经常需要处理文件上传。本文将介绍如何在 Fastify 中处理文件上传。

    1 小时前
  • ES11 中的 Object.fromEntries() - 一个实用工具

    ES11 中的 Object.fromEntries() - 一个实用工具 在 ES2019 中,一个新的 Object 静态方法 fromEntries() 加入了 JavaScript。

    1 小时前
  • 如何用良好的界面设计提升 App 无障碍性?

    随着技术的不断进步和社会的不断发展,越来越多的人开始重视无障碍性设计,这样有助于让更多的人都能够顺利、愉快地使用各种应用程序。尤其是在移动应用程序中,良好的界面设计不仅可以提高用户的使用体验,还可以提...

    1 小时前