npm包graphql-express-nodejs使用教程

阅读时长 7 分钟读完

前言

GraphQL 是一种用于 API 的查询语言。GraphQL 通过定义类型和对类型的查询、操作和订阅的结构来描述 API,使用 GraphQL 客户端可以精确地进行数据查询,任意粒度的执行查询操作,只需发送一个请求即可获取到所需数据,而不是像传统RESTful API一样获取所有数据甚至是不必要的数据。GraphQL 在前端领域得到了广泛的应用和追捧,而 graphql-express-nodejs 则是一个相对易用的 GraphQL 的 Node.js 实现,其构建在 graphql、express 和 node.js 之上,并得到了众多Node.js开发者的喜爱。

安装graphql-express-nodejs

在开始使用 graphql-express-nodejs 前,我们需要首先安装这个包,可以通过 npm 安装,命令如下:

搭建GraphQL服务器

  1. 安装依赖

在你的项目目录下,使用 npm 安装必要的依赖:

  1. 初始化GraphQL中间件

在你的应用程序的入口文件中使用 graphql-express-nodejs 为应用程序创建 GraphQL 中间件。只需要在 Express 应用程序中调用 graphqlExpress() 函数:

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

其中的 schema 是一个包含数据模型和查询的对象,在 GraphQL 中描述了 API 的类型系统。schema 可以使用类似 graphql-tools 之类的模块定义,其内容超出了本篇文章的范围,我们只做简单介绍。

  1. 创建示例 schema

在本教程中,我们将创建一个简单的 GraphQL schema,用于演示 graphql-express-nodejs 的工作原理。

先安装 graphql 和 graphql-tools:

创建一个名为 schema.js 的文件。

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

在此例子中,我们使用了 typeDefs 定义了三个类型(Book, Query, Mutation),并在 resolvers 中实现了它们的功能,使用 GraphQLClient 发送相应的请求即可调用这些函数,得到对应的结果。

  1. 初始化Express

创建我们的入口文件(index.js),并导入必要的库。在这个示例中,我们使用了 express 和 body-parser 库。

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

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

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

在这个示例中,我们创建了一个 Express 应用程序,并使用 body-parser 来解析 GraphQL 请求体。我们还调用了 graphqlExpress() 方法,来将创建好的中间件挂载到 /graphql 路径上。

  1. 启动服务器

使用 node index.js 命令启动我们的服务器,在控制台中交互式的运行我们的请求,获取对应的数据。

GraphQL 请求方法

我们在示例代码中使用了方法名为 graphqlExpress() 的 GraphQL 中间件,它是基于 Express 的静态方法;此中间件由 GraphQL 所提供,用于执行 GraphQL 查询语句。让我们看一下这个中间件可接受的一些参数:

  • schema: 必选,GraphQL schema 对象。
  • context: 上下文对象,GraphQL 查询的内部使用,用于存储全局变量,例如数据库连接等。
  • rootValue: 请求处理程序从 schema 中读取的可选根值。如果未指定,默认根值设置为 request 对象。
  • graphiql: 可选的,Boolean 类型,如果为 true, 中间件将安装 GraphiQL 用户界面,用户界面可通过浏览器打开,它支持测试和 IDE 的功能。

GraphQL 请求示例

使用 GraphQL 客户端发送查询请求来获取数据,就像这样:

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

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

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

在上述请求中,我们使用了两种类型的请求,一种是查询请求,另一种是变更请求,通过这样的方式我们往往可以更为准确的获取我们需求的数据。

结语

本文向您展示了如何使用 graphql-express-nodejs 构建 GraphQL服务器,并针对示例进行了讲解,供各位前端开发者参考。GraphQL 的 API查询语言消除了RESTful的不足之处,并且还是未来的一种发展趋势,希望通过本文向大家传达了 GraphQL 的初步使用,帮助大家更快的掌握这个技术并提高项目的开发效率。

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

纠错
反馈