GraphQL 抛出非空字段错误的解决方案

前言

GraphQL 是一种用于构建 API 的查询语言,它是由 Facebook 开发的一种新兴技术。GraphQL 在解决 RESTful API 中出现的一些问题时表现出了非常好的性能。

在实际开发过程中使用这种技术时,我们时常会遇到一些问题和错误。其中一个主要的问题是 GraphQL 抛出非空字段错误。该错误的原因在于由于某些数据缺失或者其他错误原因,我们无法返回一个 null 值。

在本文中,我们将深入探讨 GraphQL 抛出非空字段错误的解决方案。

问题描述

GraphQL 具有严格的类型检查机制,当查询或者变异的输入或者输出不符合指定的 schema 时,GraphQL 会抛出错误。当我们查询一个包含非 null 值的字段时,如果该字段的返回值为空,就会抛出一个非空字段错误。例如,假设我们需要查询一个图书列表,其中包含每本书的作者信息,我们定义了如下的 schema:

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

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

假设我们查询了一个没有作者信息的书籍,GraphQL 就会抛出非空字段错误。因为 author 不能返回 null 值。

如果 SampleQuery 包含如下查询:

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

当我们查询没有作者信息的书籍时,GraphQL 就会抛出一个类似如下的错误:

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

解决方案

1. 通过异常处理解决问题

这是最常见的解决方案。我们可以使用异常处理器来处理 GraphQL 抛出的错误。在这种方案下,我们可以让 GraphQL 报错,并且在我们的代码中捕获这个错误,从而防止它传播到客户端。这个方案非常简单,只需要在 resolver 中添加 try-catch 代码块即可。

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

这种方法的优点是非常简单而且容易理解。我们可以直接把错误信息输出到 console 中,并且传递错误给客户端。

但是这种方法的缺点也比较明显:因为我们已经取消了 GraphQL 的非空字段的检查,因此我们可能在客户端获取到空值,而无法感知问题。

2. 完全检查输入对象

在 resolver 中检查所有输入参数值,并且在检查到没有返回值时抛出错误。

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

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

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

在该方案中,我们检查了每个输入值,并且在缺失必要值时,抛出错误。 这是一种很好的解决方法,可以避免出现 GraphQL 规范的非空字段错误。

但是,这种方法开发成本较高。 检查输入值的代码可能会非常复杂,特别是当字段中包含许多嵌套元素时。 此外,我们仍然需要执行大量的检查并跟踪每个非空字段。 但是,对于具有极高数据完整性的应用程序而言,这是一个必须的解决方案。

3. 合并 schema 和 resolvers,不抛出任何异常

这种解决方案是不生成任何异常。 我们能够在查询期间实时验证非空字段,并以不影响我们应用程序流程的方式返回错误。 该方法需要我们合并 schema 和 resolver 以及使用第三方库。 在 Node.js 中,该库可用于检查策略(包含许多其他优秀的功能)。

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

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

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

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

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

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

在该方案中,我们使用的库是 graphql-middleware。 它允许我们优雅地管理和分类不同类型的验证规则。 现在,如果我们查询一个缺少某个非空字段的书籍,将返回如下错误:

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

这样做的好处是它让我们可以避免抛出异常,并且在我们偏离开发路线的时候给我们提供错误提示。

总结

当我们使用 GraphQL 技术时,我们时常会遇到非空字段错误的问题。在本文中,我们介绍了三种常见的解决方案。

第一种方案是使用异常处理器。这种方法简单明了,但是我们可能会处理到 null 值,并没有及时感知问题。

第二种方案是完全检查所有输入值。 这种方案开发成本较高,对于具有极高数据完整性的应用来说是必要解决方案。

第三种方案是合并 schema 和 resolvers 并使用 graphql-middleware 库,在查询期间实时验证所有非空字段,并在必要时返回错误。

我们需要根据自己的实际情况来选择合适的方案,并可以根据需要灵活地进行选择和调整。

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


猜你喜欢

  • npm 包 get-object-path 使用教程

    我们在前端开发中经常需要处理 JavaScript 对象,有时候需要操作嵌套对象的属性,这时候就需要使用一个方便快捷的方法来访问对象的属性,这个时候 get-object-path 就派上用场了。

    7 个月前
  • npm包stylco使用教程

    在Web开发领域,CSS样式是网站重要的视觉设计元素。但是,CSS的样式管理常常会变得混乱和难以维护。 stylco是一个npm软件包,可以解决CSS样式管理问题。

    7 个月前
  • npm 包 aliyun-cs-client 使用教程

    前言 在今天的云计算和容器化浪潮的背景下,阿里云容器服务(Alibaba Cloud Container Service,简称 ACS)成为了越来越多企业解决容器化方案的首选。

    7 个月前
  • npm 包 darmody-fine-uploader 使用教程

    在前端开发中,文件上传是一个常见的需求。而 npm 包 darmody-fine-uploader 就是一个非常好用的文件上传包,支持多种上传方式和自定义样式等功能。

    7 个月前
  • npm 包 nativescript-utilities 使用教程

    简介 nativescript-utilities 是一个为 NativeScript 应用程序开发而设计的 npm 包,旨在帮助开发者提高效率和增强功能。它常用于简化常见工作,如 HTTP 请求、文...

    7 个月前
  • npm 包 serverless-plugin-scripts 使用教程

    简介 serverless-plugin-scripts 是一个 npm 包,可以帮助开发者在 serverless 构架中方便地运行脚本,包括在 pipeline 中运行 bash 脚本、在 bui...

    7 个月前
  • npm 包 simple-dispatch 使用教程

    npm 包 simple-dispatch 使用教程 前言 在前端开发过程中,我们经常会遇到需要进行事件的订阅和发布的情况,例如发送一个全局通知,或者监控一个按钮的点击事件是否触发,这时候我们可以使用...

    7 个月前
  • npm 包 zup 使用教程

    简介 zup 是一个基于 puppeteer 的可视化 web 页面自动化测试工具。它可以方便地模拟用户操作,进行页面元素的自动点击、填写等操作,实现 UI 测试、性能测试、爬虫等多种应用。

    7 个月前
  • npm 包 clarkchen633 使用教程

    前言 在前端开发过程中,我们常常需要使用一些外部的库和工具来提高开发效率和代码质量。npm(Node Package Manager)是世界上最大的软件库之一,其中不乏许多优秀的前端工具包和插件。

    7 个月前
  • npm 包 my-package-zpy 使用教程

    简介 my-package-zpy 是一个开源的 npm 包,旨在提供一些有用的前端工具函数和组件。这个包是由前端开发者 zpy 所编写和维护,并在他的开源项目中使用。

    7 个月前
  • npm包didi_texi使用教程

    在前端开发中,npm是不可或缺的依赖管理工具,能够方便地引入各种第三方包。在这里,我们介绍一款非常实用的npm包——didi_texi,它可以方便地处理各种文本格式。

    7 个月前
  • npm 包 gh-compare-commits 使用教程

    随着开源社区的不断发展,GitHub 成为一个被广泛使用的版本管理平台。在进行代码开发的过程中,常常需要进行代码比较,以便了解代码变更的情况。这个时候,一个比较好用的工具就是 gh-compare-c...

    7 个月前
  • npm 包 ng2-uimodule-thetasp 使用教程

    在前端开发中,使用 npm 包是十分常见的。npm 包为我们提供了许多实用功能和工具,大大提升了前端开发的效率。在本文中,我们将介绍一个非常有用的 npm 包 ng2-uimodule-thetasp...

    7 个月前
  • npm 包 cordova-plugin-ddplugin 使用教程

    什么是 cordova-plugin-ddplugin cordova-plugin-ddplugin 是一个针对 Cordova 应用开发的插件,可以快速简便地实现钉钉 API 功能的调用。

    7 个月前
  • npm 包 webpack-cdnizer 使用教程

    随着前端项目越来越复杂,依赖的第三方库也越来越多,经常会有这样的场景:相同的库在不同的页面都被引用,导致重复加载,浪费带宽和加载时间。该怎么办呢?CDN 选择是个不错的方案,webpack-cdniz...

    7 个月前
  • npm 包 cordova.plugin.location 使用教程

    前言 在开发移动应用过程中,获取用户位置信息是非常常见的需求之一。而 cordova.plugin.location 这个 npm 包便是一个很好的解决方案。本文将深入介绍如何使用 cordova.p...

    7 个月前
  • npm 包 feathers-postgres 使用教程

    在现代的 Web 应用开发中,一般使用前端框架与后端框架配合使用。前端框架可以帮助我们快速开发客户端页面,而后端框架可以帮助我们完成数据存储和处理等任务。其中,SQL 数据库是常用的一种存储方式,而 ...

    7 个月前
  • npm 包 lite-bencode 使用教程

    前言 随着云计算和大数据的兴起,种子文件在文件共享和文件传输中的地位越来越重要。在种子文件中,bencode 是一种常用的编码方式。因此,很多前端开发者也需要掌握 bencode 编解码的技能。

    7 个月前
  • npm 包 react-native-action-sheet-veedy 使用教程

    在 React Native 开发中,弹出对话框是非常常见的需求。其中,ActionSheet 对话框是一种在 App 中用来展示一组可供选择的操作项的组件,通常用于提示用户在不同情境中可使用的操作,...

    7 个月前
  • npm 包 feathers-postgresql 使用教程

    介绍 feathers-postgresql 是一个 Node.js API 服务开发框架 FeathersJS 的一个 PostgreSQL 数据库适配器。使用该适配器,开发人员可以轻松地对 Pos...

    7 个月前