npm 包 graphql-schema-modules 使用教程

阅读时长 8 分钟读完

GraphQL 是一种基于类型系统的查询语言和规范,用于API的设计和客户端和服务器之间的数据交互。而其中的 schema 是 GraphQL 定义的数据结构的精华所在,它描述了所有可查询的数据的类型和其关系,即为 API 的指南。

在 GraphQL 中,有很多用于构建 schema 的工具,例如 graphql-tools。而本文将介绍一个使用 npm 包 graphql-schema-modules 来构建 schema 的方法。首先,我们需要了解一下 graphql-schema-modules 的基本概念。

graphql-schema-modules 的基本概念

graphql-schema-modules 中提供的基本概念包括:

1. Module

Module 是通过 graphql-schema-modules 创建的一个模块,用于组织 Type 和其它的能力,同时可以提供其它模块所需的 field 和 resolver。一个模块既充当了导出 Type 和 export 的 resolver 的容器,又充当了要导入其它 Type 和 resolver 的用户的容器。每个模块都可以定义自己的 Type 和 resolver,且不需要在代码中定义。

2. Type

Type 代表一种领域模型中的实体或值,如 User、Order、Product。Type 由 Field 组成,Field 又有自己的 arguments 和 resolver。Type 提供了在 schema 中查询的关键字,例如查询(query)、修改(mutation)、订阅(subscription)。

3. Field

Field 是 Type 中的属性或域。每个 field 都有它自己的 resolver,resolver 是一个用于控制如何获取 field 值的函数。

4. Resolver

Resolver 是一个字段的值从哪里获取的策略,它接收 Input、Context 和 Output 类型三个参数,以及 GraphQL 的查询上下文信息。Resolver 就是在 GraphQL 的 schema 中对 field 进行数据查询和变更的最后一步,它是依靠具体的数据源来访问服务数据的方法。

上述是 graphql-schema-modules 的几个基本概念。接下来,我们将通过实例代码的方式来教学,希望读者可以跟着本文的教程走一遍,了解 graphql-schema-modules 的使用方法。

实例:一个简单的模块

接下来,我们将以一个简单的模块为例,展示 graphql-schema-modules 的基本使用方法。

1. 创建 package.json

首先,在你的项目文件夹下,使用 npm init 命令来创建 package.json 文件。

2. 安装 graphql、graphql-iso-date、graphql-schema-modules

接着,在终端运行以下指令,安装 graphql、graphql-iso-date、graphql-schema-modules 三个包。

3. 创建一个普通的 schema

然后,在某个地址新建一个 schema.js 文件,并输入以下代码:

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

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

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

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

在此处,我们使用了 graphql 中提供的 gql 函数来定义 schema 中的 Query,其中 hello 表示该 Query 可以查询一个字符串,并返回 'Hello world!'。

4. 创建一个使用 graphql-schema-modules 的 schema

接下来,我们要操作的是使用 graphql-schema-modules 来写一个新的 schema。新建一个文件夹,命名为 modules,并在该文件夹下新建一个名为 user.js 的文件,内容如下:

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

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

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

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

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

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

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

在此处,我们使用了 graphql-schema-modules 来定义了两个 Type:User 和 Timestampable,以及一个在 User 中查询 users 的 Query。

其中 implements: 'Timestampable' 表示 User 类型实现了 Timestampable 接口。该接口的含义是,在 User 类型中,我们必须提供 createdAt 和 updatedAt 字段。并且,定义了 scalar Date。

我们可以看到,使用 graphql-schema-modules 定义 Type、Field 和 Resolver 的方式与用 graphql 工具一致。唯一的区别在于我们将 schema 分解成多个模块,调用 export() 将其合并。

5. 合并新老两个 schema

在完成 user.js 文件的编写后,我们需要将刚刚创建的模块合并到我们之前创建的 schema 中。对于此处的合并操作,可以在原 schema 的地址下新建一个新的文件为 merge.js,其内容如下:

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

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

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

该文件将我们之前新建的两个 schema 合并了起来,然后可以直接导出该 schema,以便对其进行测试或服务端应用程序的修改。

总结

在本文中,我们简单介绍了 graphql-schema-modules 的基本概念,并通过一个实例代码来阐述了其使用方法。graphql-schema-modules 致力于通过 module 和 relative imports 这些思想,带给前端开发者们更加方便快捷的一种 schema 构建方式。值得一提的是,它可以轻松地与 Apollo 平台集成,无论是编写服务端还是客户端,都可以带来更加强大而合理化的代码组织。

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

纠错
反馈