GraphQL 中的各类操作符详解

GraphQL 是一种用于 API 构建的查询语言。它提供了一些关键字和操作符,用于定义数据模型和查询语句,使前端工程师可以轻松地获取并维护特定数据。

本文将介绍 GraphQL 中的各种操作符,并提供详细的介绍、示例代码和实际应用指导。

1. 查询操作符

1.1. 字段

字段是用于查询和返回特定数据的基本操作符。 它们可以嵌套和连接,以构建完整的查询和返回数据。GraphQL 中所有的查询都由一个字段开始,作为查询的根节点。

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

在此示例中,field1field2 是两个字段。field2 又包含了两个子字段 — subfield1subfield2

1.2. 别名

别名用于重命名一个字段的返回值。当需要返回同一种类型的数据的多个版本时,别名会派上用场。

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

在此示例中,我们为 field1 字段设置别名 firstField,为 field2 字段设置别名 secondField。这样,我们可以返回两个不同名的数据字段。

1.3. 参数

参数用于向查询中传递变量或常量。 参数可以由调用方提供,也可以由服务器端解析。

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

在此示例中,我们向 field1 传递了一个名为 arg1 的常量参数,其值为 "value1"。我们还向 field2 传递了一个名为 filter 的对象参数,其中包括 categorystatus 两个键值对。

2. 变量

变量是 GraphQL 查询和变异中运行时值的占位符。本质上,它们是查询模板的参数。

2.1. 定义变量

变量必须在操作名称、查询类型的上下文中定义。 定义变量时需要使用 $ 字符引入变量名称,并定义变量类型。

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

在此示例中,我们定义了名为 var1var2 的两个变量。var1 是一个字符串变量,var2 是一个整数变量,两者都是必需的。这就是为什么在类型后面加上一个感叹号。

2.2. 传递变量

如果我们需要向查询中添加值为变量的参数,我们可以使用以下语法:

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

在此示例中,我们将名为 var1 的变量传递给 arg1 参数,以保持查询中不同部分的一致性。 这样,我们可以多次使用同一查询,只要提供不同的参数即可。

2.3. 默认值

当定义变量时,我们可以选择指定默认值。这样,我们就可以不传递变量而得到预期的结果。

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

在此示例中,如果不传递值为 var1 的变量,则使用默认值 "default"

3. 片段

片段是一种可重用的查询块,类似于变量,但它们通常用于重复的字段选择。

3.1. 定义片段

要定义片段,请使用 fragment 关键字,后跟一段片段名称和片段的查询部分。

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

在此示例中,我们定义了名为 allFields 的片段,用于选择一些常见的字段。

3.2. 引用片段

要引用片段,可以使用 ... 运算符后跟片段名称。

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

在此示例中,我们使用 ...allFields 引用 allFields 片段,它选择了多个普通字段。该片段添加到两个不同的查询中。

3.3. 嵌套片段

片段可以嵌套使用,以选择更深层次的数据字段。可以使用嵌套片段来遍历深层次的查询。

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

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

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

在此示例中,我们定义了两个片段: addressFieldspersonFieldspersonFields 片段嵌套了 addressFields 片段。 然后,我们在查询中使用 ...personFields 来引用 personFields 片段,以便返回嵌套的 Address 数据的深层次字段信息。

4. 变异操作符

变异是用于修改、删除或创建数据的操作符。它们与查询操作符不同,其名称应以关键字 mutation 开头。

4.1. 创建记录

要创建新记录,请使用 createXXX 关键字,后跟要创建的记录类型和所需的值。

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

在此示例中,我们使用 createPerson 变量创建了一个新的 Person 记录。我们还指定了一些 Person 属性,如 namebirthdategender。我们还指定了一个 Address 对象,该对象包含 street1citystatezip 属性。

4.2. 更新记录

要更新现有记录,请使用 updateXXX 关键字,后跟要更新的记录类型和所需的值。

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

在此示例中,我们使用 updatePerson 变量更新了一个现有的 Person 记录。我们还指定了一些 Person 属性,如 namebirthdategender。我们还指定了一个 Address 对象,该对象包含 street1citystatezip 属性。

4.3. 删除记录

要删除现有记录,请使用 deleteXXX 关键字,后跟要删除的记录类型和所需的条件。

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

在此示例中,我们使用 deletePerson 变量删除了一个现有的 Person 记录,其 id123

结论

本文中,我们介绍了 GraphQL 的各种操作符,包括查询、变量、片段和变异。虽然 GraphQL 具有相对较小的规范和功能集,但已经证明它在前端和后端开发中都具有简单而有效的功能。学习和掌握这些操作符可以帮助您更好地构建和维护自己的 Web 服务,让前端团队更加高效。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/6713a688ad1e889fe20ee504