GraphQL 是一种数据查询语言,它可以让前端程序员方便地查询后端服务器上的数据。Sequelize 是一个流行的 Node.js ORM(Object-Relational Mapping)用于将关系型数据库映射为对象,用于实现数据存储的抽象层。@johnydays/graphql-sequelize 包是一个将 Sequelize 模型转换为 GraphQL 类型的工具包,可以帮助开发者快速的将 Sequelize 模型导入到 GraphQL 服务器中,这样就不需要编写冗长的 GraphQL 类型定义。在此篇文章中,我将重点介绍该 npm 包的使用,帮助读者了解如何使用并掌握相关技术。
1. 安装
要使用 @johnydays/graphql-sequelize,必须在项目中安装它。可以使用 npm 进行安装:
npm install @johnydays/graphql-sequelize
2. 使用
- 首先,需要将 Sequelize 模型导入到 GraphQL 服务器中。可以通过创建 GraphQL 填充函数(resolver)来实现此项操作,如下所示:
-- -------------------- ---- ------- ------ --------- ---- ------------ ------ - -------------------- - ---- ---------------- ------ - ------------- ----------------- - ---- --------------------------- ------ - --------------- - ---- ------------------------------- ----- --------- - --- ----------------- ----- --------- - ------------------------ ------- ----- -------- - - ---- ----- - -------- ------ ----- ----------- --------- -------- - ---- ---- - ----------------------------- - -- ----- -------------- - - ----- ----- --- - -- -- -- ----------------------- ------ ------------------------ -- ----- ------ - ---------------------- --------- ---------- - ------ --------------- -- ---
attributeFields
是一个函数,它可以将 Sequelize 模型的字段映射为 GraphQL 类型定义的字符串片段。在这个示例中,我们将 UserModel
的字段映射到了 GraphQL 的 User
类型中。
createLoader
是一个函数,它读取所有的 User
,做出进一步处理并将其转换为 GraphQL 能够处理的结果。例如,在此示例中我们将用户 ID 转换为数字,并将创建时间和更新时间转换为 Date
类型的 JavaScript 对象。
- 接着,我们需要创建一个 GraphQL 查询来获取
User
对象。这可以通过QueryResolver
完成,如下所示:
const queryResolvers = { user: async (_, { id }) => UserModel.findByPk(id), users: createLoader(UserModel), };
我们创建了两种查询,分别是获取单个用户(user)和获取所有用户(users)。我们使用了 findByPk
方法来查询指定 ID 的用户。对于获取所有用户的查询,我们使用了 GraphQL-sequelize-loader 的 createLoader
函数。
3. 分页
当应用程序处理大量数据时,我们通常需要使用分页。Fortunately, @johnydays/graphql-sequelize
具有内置的分页机制,可以为我们提供这种支持。要使用这个功能,我们需要做以下更改:
- 修改
typeDefs
(类型定义),如下所示:
-- -------------------- ---- ------- ----- -------- - - ---- ----- - -------- ------ ----- ----------- --------- -------- ---------------------- ---- ------ ---------------- ------- ----------------- --------------- - ---- ---- - ----------------------------- - ---- ------- - --------- --------- ------ ----------- - ---- -------- - ------------ -------- ---------------- -------- ------------ -------------- ---------- -------------- - ---- -------- - ------- --------------- ----- ----- - ------ -------------- --
在 Query
类型中添加了一个新查询 usersConnection
,它是用来获取用户分页数据。我们还创建了 UserCon
类型和 PageInfo
类型,用于封装该数据。UserEdge
类型包含带有与 user
相关的数据的节点,以及唯一的 cursor
。
- 重新定义
createLoader
函数,如下所示:
-- -------------------- ---- ------- ------ - -------------------- ------------- ------------------- - ---- ------------------------------- ----- ------------------- - ------------- -------- ------ ----- -------------- - -- ---- -- -- ----------------------- -- ------------- - ------ - --- - -------- --- - -- -- - ---- ---- -- -- -- ----- -------------- - - ----- ----- --- - -- -- -- ----------------------- ------ ------------------------ ---------------- ----- --------- ----- - ----------- -- -- - ----- - ----- - - ------------ ----- - ------ ----- - - ----- ----- ------------ - --------------------------------- ------ ----- ------ - ---------------- ----- ----- --- ----- - ------ -------- - - ----- -------------------------------- ----- ------ -- --------- ------ - ------ ---------------- -- -- ------- --------------------------------- ----- ---------- ---- --------- -- -- --
我们使用了 createBatchLoader
函数,用于批量加载数据。 applyConnectionArgs
函数包装了我们的查询选项,以便将查询限制为要返回的记录数。 在本例中,由于我们是在 user
模型上执行查询,因此我们从 users
数据源中获取了一个用户的列表。我们还将 cursor
序列化为字符串。
4. 结论
经过上文的介绍,我们了解到了如何使用 npm 包 @johnydays/graphql-sequelize。我们可以将 Sequelize 模型导入到 GraphQL 服务器中,以实现数据存储的抽象层,并创建分页查询以获取数据。希望这篇文章为大家提供了指导帮助,对相关技术有所掌握。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066bc4967216659e2442c4