浅谈 GraphQL Mutation 中的错误处理

阅读时长 6 分钟读完

前言

在使用 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

纠错
反馈