如何在 Node.js 中使用 GraphQL 查询语言

阅读时长 10 分钟读完

GraphQL 是一种由 Facebook 开源的查询语言和运行时环境。它允许客户端指定要返回的数据,并且只返回客户端请求的数据,这可以提高性能并减少数据传输量。GraphQL 还是一种类型化的查询语言,这意味着它可以确保返回的数据与查询的数据一致,减少了开发人员在后端和前端之间进行数据交换时的错误。

在本文中,我们将探讨如何在 Node.js 中使用 GraphQL。我们将首先介绍 GraphQL 的基本概念和语法,然后将介绍如何在 Node.js 环境中实现 GraphQL 的服务器端。最后,我们将通过一些示例代码来演示如何使用 GraphQL 查询和修改数据。

GraphQL 基础知识

查询和字段

GraphQL 查询由字段和参数组成。每个字段都代表一个特定的数据项,并可以在查询过程中嵌套。

下面是一个简单的 GraphQL 查询示例:

这个查询请求 user 的 id 为 123 的用户的 firstName、lastName 和 email 字段。查询结果将返回 JSON 对象,包含 user 的这三个字段。

变量

变量允许我们在查询中动态传入值。变量由 $ 符号开头,并包含变量名称和类型,例如 $id: Int

下面是一个带变量的 GraphQL 查询示例:

这个查询定义了一个名为 GetUser 的查询,并将变量 $id 类型定义为整数。在查询中,我们将 user 的 id 参数设为 $id,因此我们可以通过将不同的值传递给变量 $id,来查询不同的用户。

操作类型

GraphQL 有三种操作类型:查询(Query)、变更(Mutation)和订阅(Subscription)。查询用于获取数据,变更用于修改数据,而订阅用于实时获取数据更新。

下面是一个简单的 GraphQL 查询示例:

这里我们使用了查询操作类型,并请求 user 的 id 为 123 的用户的 firstName、lastName 和 email 字段。

在 Node.js 中实现 GraphQL 服务器

要在 Node.js 中实现 GraphQL 服务器,我们需要使用 graphqlexpress-graphql 这两个包。

首先,我们需要创建一个 GraphQL schema,它描述了我们可以查询和修改的数据项,以及它们的类型。

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

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

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

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

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

这个 schema 定义了一个名为 User 的对象类型,包含 id、firstName、lastName 和 email 字段。它还定义了一个名为 Query 的对象类型,包含 user 和 users 两个字段。其中,user 字段接受一个 id 参数,并返回一个用户。users 字段返回所有用户的列表。

接下来,我们需要创建一个 express 应用,并使用 express-graphql 中间件将 GraphQL schema 添加到应用中。

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

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

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

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

这个应用将 GraphQL schema 添加到了 /graphql 路由上,当我们访问这个路由时,将使用 graphqlHTTP 中间件处理我们的请求。

使用 GraphQL 查询数据

在 Node.js 中使用 GraphQL 查询数据非常简单。我们可以使用任何 HTTP 客户端发送一个 POST 请求到我们的 express 应用,并将 GraphQL 查询语句作为请求的正文。我们的 express-graphql 中间件将解析这个查询,并返回查询结果。

以下是一个使用 node-fetch 发送 GraphQL 查询的示例代码:

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

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

这个代码将查询 user 的 id 为 1 的用户的 firstName、lastName 和 email 字段,并将查询结果输出到控制台。

使用 GraphQL 修改数据

除了查询数据外,我们也可以使用 GraphQL 修改数据。在 Node.js 中,我们可以通过定义一个 Mutation 对象类型来实现这一点。

下面是一个例子,使用 graphql-compose 库定义一个名为 updateUserMutation 的 Mutation 对象类型,用于更新用户信息:

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

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

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

这个 Mutation 对象类型定义了一个名为 updateUser 的字段,接受一个 id 参数和可选的 firstName、lastName 和 email 参数,并返回更新后的用户。

接下来,我们需要将这个 Mutation 对象类型添加到我们的 schema 中。

现在我们的 schema 就包含了一个 Mutation 对象类型和一个 updateUser 字段,我们可以通过发送一个包含我们的更新用户请求的 POST 请求来修改用户信息。

以下是使用 node-fetch 修改用户信息的样例代码:

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

这个代码将更新 id 为 1 的用户的 firstName 字段,并将更新后的用户信息输出到控制台。

总结

GraphQL 是一种强大的查询语言和运行时环境,可以提高性能并减少数据传输量。在 Node.js 环境中,我们可以使用 graphqlexpress-graphql 包来创建 GraphQL 服务器。使用 GraphQL 查询和修改数据也非常简单,只需要使用任何 HTTP 客户端发送包含 GraphQL 查询语句的 POST 请求即可。

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

纠错
反馈