npm 包 graphql-schema-modules 使用教程

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


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    2 个月前

相关推荐

    暂无文章