GraphQL 中如何创建可重用的查询片段

阅读时长 6 分钟读完

GraphQL 是一种用于 APIs 的查询语言,它提供了一种灵活直观的方式来描述数据的形状和相关性,允许客户端准确地获取所需的数据。GraphQL 可以整合多个数据源,将多个 API 前端和后端合并成一个可统一调用的 API。

GraphQL 查询可以包含许多字段和嵌套类型,这些字段和类型可以在查询中多次使用。这就是查询片段的作用,它是一种可重用的代码块,用于封装 GraphQL 查询中重复使用的字段和类型。

在本文中,我们将探索如何在 GraphQL 中创建可重用的查询片段并将它们集成到您的应用程序中。我们还将讨论查询片段的指导意义,以及如何使用查询片段增强代码的可读性和可维护性。

创建查询片段

查询片段是一种定义了一组字段的代码块,在查询中可以通过它来引用这些字段。因此,首先我们需要定义一个查询片段。GraphQL 中的查询片段可以定义为一个 GraphQL 语言定义,如下所示:

在这个例子中,我们定义了一个叫做 MyFragment 的查询片段。这个查询片段定义了三个字段,它们是 idnameemail。这个查询片段将应用于 User 类型的查询中。

要在查询中应用这个查询片段,我们可以使用 ... 操作符,如下所示:

在这个例子中,users 查询中引用了 MyFragment 查询片段。运行这个查询会返回 User 类型的对象,其中包含了 idnameemail 这三个字段。

为何使用查询片段?

查询片段有几个优点,对于大型的 GraphQL 应用程序,这些优点非常重要。

提高可重用性

查询片段提供了将查询中的代码块定义为可重用部分的方法。这意味着我们可以将一些通用的查询片段封装在一起,并在多个查询中重复使用它们。

例如,如果我们在几个不同的查询中都需要获取 User 中的 idnameemail 字段,我们可以将它们定义为一个单独的查询片段。这样,我们可以在需要使用这些字段的任何查询中引用这个查询片段,而不必每次都手动输入这些字段。

提高可读性

假设您的查询中有大量的字段和复杂的类型嵌套,这将会使查询变得很难读懂。查询片段可以将这些大量字段和嵌套类型抽象成视觉上更简洁的部分。

例如,我们可以使用查询片段来将 GraphQL 查询从这样的写法:

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

转变成这样的写法:

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

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

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

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

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

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

这种重构让查询更易读,同时还提高了灵活性和可维护性,因为我们可以单独修改或调整查询片段。

提高代码可维护性

在 GraphQL 代码库中,一个重要的问题是代码重复。如果您想要修改一些字段的名称,或者添加或删除字段,那么您需要在每个查询中更新这些更改。使用查询片段可以避免这种重复工作,改变查询片段后,所有引用该查询片段的地方都会自动更新。

实战例子

下面是一个使用查询片段的例子。假设我们有一个 GraphQL API,它包含了一些电影的信息。其中电影具有发布时间、导演、编剧和演员。假设我们需要从 API 中获取一个电影的信息,以及该电影导演和编剧的基本信息,我们可以如下搜索。

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

在上面的查询中,directorwriter 段的内容非常相似。为了加强代码的可读性和可维护性,我们可以使用查询片段将这些相似部分合并到一起。

我们可以定义一个查询片段,如下所示:

这个查询片段定义了一个名为 PersonalDetails 的片段,它将在所有 Person 类型的查询中使用。接下来,我们可以根据这个查询片段定义一个新的查询,如下所示:

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

在上面的查询中,我们使用展开操作符 ... 来将 directorwriter 段替换为 PersonalDetails 查询片段。这个查询片段封装了共同的部分,使得我们可以重用这些部分,更容易阅读和维护代码。

总结

查询片段是 GraphQL 中的一个强大概念,允许我们将 GraphQL 查询中的重复代码块定义为可重用部分。查询片段提高了代码的可读性,可维护性和可重用性,使得我们可以更快地开发和修改 GraphQL 应用程序。

在本文中,我们讨论了如何在 GraphQL 中创建查询片段,并通过一个例子间接展示了查询片段对于一个复杂场景下查询的简化。我们希望这篇文章对您有所帮助,并让您了解了如何使用查询片段,从而提高您的 GraphQL 应用程序的效率、可读性和可维护性。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/64cb93945ad90b6d04212e9b

纠错
反馈