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

阅读时长 7 分钟读完

前言

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

纠错
反馈