GraphQL 和 Express 的集成方法

阅读时长 7 分钟读完

GraphQL 是一种用于 API 的查询语言,它可以提高前端开发人员的工作效率和体验。而 Express 是一种流行的 Node.js 框架,用于搭建 Web 应用程序。将这两个工具结合起来,可以创建高效且易于扩展的 Web 应用程序。本文将讨论 GraphQL 和 Express 的集成方法,并提供一些示例代码和实践建议。

设置 GraphQL

在开始使用 GraphQL 前,需要从 NPM 安装 graphqlexpress-graphql,如下:

安装完成后,我们可以设置一个 GraphQL 端点并创建一个测试查询。下面是一个简单的 Express 应用程序,可以通过将 GraphQL 中间件连接到路由上来启用 GraphQL 端点:

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

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

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

在这个例子中,我们定义了名为 HelloWorld 的 GraphQL 查询类型。查询类型是 GraphQL 中的一个基本组成部分,它定义了我们可以向服务器查询的字段和数据类型。在这里,我们定义了一个 message 字段,返回一个字符串"Hello World"。

GraphQLSchema 类型接受一个对象,该对象包含名为 query 的字段,用于指定我们可用于查询的数据集合。我们将 HelloWorld 类型分配给查询字段,这使我们可以在 /graphql 端点上根据我们定义的架构执行 GraphQL 查询。

使用 Express 的 graphqlHTTP 中间件,并将我们定义的架构传递给它,我们可以将 GraphQL 设置为我们的 Express 应用程序的一部分。将 graphiql 选项设置为 true 将启用 GraphQL 的 GraphiQL 界面,我们将在该界面上进行GraphQL查询操作。

查询数据

现在我们已经设置了 GraphQL,下一步是向服务器发送查询以获取数据。输入 /graphql 端点的 URL 可以在 GraphiQL 中打开,并且可以使用完整的 GraphQL 语法构造查询,如下:

在这个例子中,我们正在查询 message 字段。发送此查询后,服务器会返回以下响应:

在这个简单的例子中,我们只有一个 message 字段,但实际上,我们可以根据架构中定义的任何字段进行查询。

数据解析

上面的例子中,GraphQL 查询返回的数据是一个简单的字符串。但是,在实际应用程序中,我们可能需要从数据库或其他数据源检索数据并返回多个值。在这种情况下,我们需要指定一个解析器函数,该解析器函数可以向 GraphQL 查询提供所需的数据。

让我们模拟这种情况,我们将创建一个 books 字段,并返回一个由书籍名称组成的数组:

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

在这里,我们定义了一个数据类型为列表,其中列表元素的类型是 GraphQL 字符串 GraphQLString。我们还定义了一个 books 字段,该字段的解析器返回一个字符串类型的数组。

现在,我们可以通过执行以下 GraphQL 查询来检索数据:

这会返回以下响应:

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

这是一个简单的例子,但我们可以通过类似的方式查询复杂的对象,例如从数据库中检索数据。

添加数据变异

在应用程序中,我们不仅需要检索数据,还需要对数据进行更新、删除和插入。我们可以使用 GraphQL 的“变异”操作来实现这些目标。

在 GraphQL 中,变异是更改数据的操作。例如,在书籍库应用中,我们可能需要创建一个 addBook 变异,以允许用户添加新书。

让我们添加一个 addBook 变异,它可以将书籍名称添加到书籍列表中:

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

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

在这里,我们使用 GraphQLObjectType 类型定义一个新的 mutation 字段。在 AddBook 变异中,我们定义了一个 addBook 字段,并指定 GraphQLString 类型。我们使用 args 属性指定我们想要添加到书籍列表中的名称。然后,我们在解析器中使用 books.push() 将名称添加到列表中。

现在,我们可以使用以下 GraphQL 查询来添加新书:

查询将返回以下响应:

执行查询后,books 数组已更新,现在包含新添加的书。

结论

在本文中,我们探讨了如何在 Express 应用程序中使用 GraphQL。我们演示了如何设置 GraphQL 端点,查询数据,解析数据以及添加变异。在实践中,GraphQL 和 Express 可以轻松地构建灵活的、可扩展的 API,以便我们的应用程序可读性更高,可维护性更高。希望本文能够帮助您更好地理解 GraphQL 和 Express 的一些基本概念并且为您的开发工作提供帮助。

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

纠错
反馈