将 GraphQL Nexus 与数据库一起使用

⚠️ 本文已过时，因为它与现已弃用的 Prisma 1 相关。要了解有关最新版本 Prisma 的更多信息，请阅读文档。⚠️

回顾：使用 GraphQL Nexus 进行代码优先开发

在上一篇文章中，我们介绍了 GraphQL Nexus，这是一个 GraphQL 库，支持 TypeScript 和 JavaScript 的代码优先开发。借助 Nexus，GraphQL schema 是以编程方式定义和实现的。因此，它遵循其他语言中 GraphQL 服务器的成熟方法，例如 sangria-graphql (Scala)、 graphlq-ruby 或 graphene (Python)。

今天的文章是关于使用 Prisma 客户端和新的 nexus-prisma 插件，将基于 Nexus 的 GraphQL 服务器连接到数据库。稍后，我们将引导您完成从头开始构建博客应用程序 GraphQL API 的实际示例。

nexus-prisma 适用于 PostgreSQL、MySQL 和 MongoDB。 在此处查找其文档。

---

TLDR：nexus-prisma 插件的优势

• GraphQL 中 Prisma 模型的 CRUD 操作
• 自定义您的 Prisma 模型，例如隐藏某些字段或添加计算字段
• 完全类型安全：GraphQL schema 和数据库的一致类型集
• 与 GraphQL 生态系统兼容（例如 apollo-server、 graphql-yoga 等）

了解 nexus-prisma 工作流程

Prisma 客户端作为 ORM 替代品

如果您之前没有使用过 Prisma，这里简要介绍一下它的工作原理

1. 定义您的数据模型或让 Prisma 自省您的现有数据库
2. 生成您的 Prisma 客户端，即类型安全的数据库客户端
3. 在应用程序（例如 GraphQL API）中使用 Prisma 客户端访问您的数据库

nexus-prisma 插件的底层原理

将 nexus-prisma 添加到混合中时，还有另一个步骤：调用 nexus-prisma-generate 代码生成 CLI。它为您的 Prisma 模型生成完整 GraphQL CRUD API 的构建块，例如对于 User 模型，它包括

• 查询
  • user(...): User!：获取单个记录
  • users(...): [User!]!：获取记录列表
  • usersConnection(...): UserConnection!：Relay 连接和聚合
• Mutation
  • createUser(...): User!：创建新记录
  • updateUser(...): User：更新记录
  • deleteUser(...): User：删除记录
  • updatesManyUsers(...): BatchPayload!：批量更新多个记录
  • deleteManyUsers(...): BatchPayload!：批量删除多个记录
• GraphQL 输入类型
  • UserCreateInput：包装记录的所有字段
  • UserUpdateInput：包装记录的所有字段
  • UserWhereInput：为记录的所有字段提供过滤器
  • UserWhereUniqueInput：为记录的唯一字段提供过滤器
  • UserUpdateManyMutationInput：包装可以在批量更新的字段
  • UserOrderByInput：指定按字段升序或降序排列

UserCreateInput 和 UserUpdateInput 在关系字段的处理方式上有所不同。

当使用 nexus 和 nexus-prisma 编写 GraphQL 服务器代码时，您可以通过公开和自定义这些操作来满足您自己的 API 需求

生成 CRUD 构建块后，您可以使用 nexus-prisma 中的 prismaObjectType 开始公开（和自定义）它们。以下代码片段描述了一个基于 Prisma 和 nexus-prisma 为 TODO 列表应用程序提供 GraphQL API 的实现

我们将 prismaObjectType 应用于 Query 和 Mutation。对于 Query，我们保留所有字段（即 todo、 todoes 和 todoesConnection）。对于 Mutation，我们使用 prismaFields 自定义公开的操作。

prismaFields 让我们选择要公开的操作。在这种情况下，我们只想保留创建模型（createTodo）的操作。从生成的 CRUD 构建块中，我们既不包括 updateTodo 也不包括 deleteTodo，而是实现我们自己的 markAsDone(id: ID!) mutation，用于选中特定的 Todo。

---

示例：从标准 CRUD 到自定义 GraphQL API

现在让我们快速浏览一个标准的 Prisma 用例，看看如何在几个简单的步骤中快速构建博客应用程序的 GraphQL API。以下是我们要做的事情

1. 设置一个使用 TypeScript 的 Prisma 项目（使用免费演示数据库）
2. 定义模型，迁移数据库并生成 Prisma 客户端
3. 通过 nexus-prisma 公开完整的 CRUD GraphQL API
4. 通过 nexus-prisma 自定义 GraphQL API

如果您想跟着操作，您需要安装 Prisma CLI

1) 使用 TypeScript、 nexus 和 nexus-prisma 设置 Prisma 项目

本节主要介绍您的项目设置。如果您不想一起编写代码，可以随意跳过它，否则展开下面的部分。

2) 定义模型，迁移数据库并生成 Prisma 客户端

prisma init 命令在 datamodel.prisma 中创建了一个默认的 User 模型。由于我们正在构建博客应用程序，让我们根据我们的应用程序域调整模型

接下来，您需要通过将数据模型应用于数据库来迁移数据库。使用以下命令，datamodel.prisma 中定义的每个模型都将映射到底层数据库中的一个表

由于您之前在 prisma.yml 中配置了 post-deploy 钩子，因此您的 Prisma 客户端和 CRUD 构建块会自动更新。

3) 通过 nexus-prisma 公开完整的 CRUD GraphQL API

在项目的早期阶段，通常有益于 API 公开完整的 CRUD 功能——更受约束的 API 需求通常会随着时间的推移而出现。nexus-prisma 通过提供从完整 CRUD 到自定义 API 操作的直接路径，完美地解决了这个问题。

让我们从一个 GraphQL API 开始，该 API 公开定义模型的完整 CRUD（请注意，这包括过滤器、分页和排序）。创建一个名为 index.ts 的新文件，并将以下代码添加到其中

在这个简短的教程中，我们没有过多关注文件结构。有关正确的设置和模块化 schema，请查看我们的 graphql-auth 示例。

运行 npm run start 后，您可以在 https://127.0.0.1:4000 上打开 GraphQL 服务器的 GraphQL Playground。通过您上面编写的少量代码，您已经拥有一个成熟的 GraphQL CRUD API 可供使用。

它是如何工作的？ nexus-prisma-generate 生成了一个 GraphQL schema，该 schema 为 Prisma 模型（您的CRUD 构建块）提供了一个 CRUD API。此 GraphQL schema 遵循 OpenCRUD 规范。使用 prismaObjectType 函数，您现在可以公开和自定义该 schema 的操作。

prismaObjectType 和 prismaFields 使用白名单方法，这意味着您需要显式列出要公开的字段。通配符 * 包括所有字段。

4) 通过 nexus-prisma 自定义 GraphQL API

在本节中，我们将学习如何自定义 nexus-prisma 的 CRUD GraphQL API。具体来说，我们将

1. 从 User 模型中隐藏一个字段
2. 向 Post 模型添加一个计算字段
3. 隐藏 createPost 和 updatePost mutation
4. 添加两个自定义 createDraft 和 publish mutation

4.1) 从 User 模型中隐藏一个字段

在本节中，我们将从 User 模型中隐藏 email 字段。

要自定义模型，我们需要将 prismaObjectType 函数应用于它，并将 definition(t) 函数作为选项传递

通过在模型 t 上调用 prismaFields，我们可以自定义公开的字段（及其参数）。由于 email 未包含在列表中，因此它将从我们的 GraphQL API 中删除。

要应用更改，您需要显式将 User 传递到 makePrismaSchema 内的 types 数组中

请注意，您的编辑器能够根据生成的 CRUD 构建块建议将什么传递到 prismaObjectType 和 prismaFields 中。这意味着当您键入 prismaObjectType('') 并按 ctrl+space 时，它会建议所有生成的 CRUD 构建块的名称。当调用 t.prismaFields(['']) 时，它会建议 t 的字段

4.2) 向 Post 模型添加一个计算字段

使用 nexus-prisma 的新代码优先方法还可以轻松地向 Prisma 模型添加计算字段。假设您要向 Post 添加一个字段，该字段始终返回完全大写的 title。以下是如何实现它

我们使用来自 graphql-nexus 的 t.string(...) API 向我们的模型添加一个新字段。因为它是一个计算字段（因此不能由 nexus-prisma 自动解析），所以我们还需要为其附加一个解析器。

和以前一样，您需要显式将自定义的 Post 模型添加到 types 数组中

4.3) 隐藏 createPost 和 updatePost mutation

就像我们从 User 模型中隐藏 email 字段一样，我们也可以从作为生成的 nexus-prisma CRUD 构建块一部分的 Query/Mutation 类型中隐藏操作。

要隐藏 createPost 和 updatePost，我们再次需要将 definition(t) 作为选项传递给 prismaObjectType。请注意，一旦我们在类型上调用 prismaFields，我们就需要显式列出我们要保留的所有字段（空数组将被解释为“不保留任何操作”）

生成的 CRUD GraphQL API 还包括批处理和 upsert 操作，为简洁起见，我们在此处将其排除在外。

4. 添加两个自定义 createDraft 和 publish mutation

最后，我们向 GraphQL API 添加了两个自定义 mutation。以下是它们的 SDL 定义应该是什么样子

要实现这些 mutation，您需要向 Mutation 类型添加两个字段（通过从 nexus API 调用 t.field( ... )）

请务必从 nexus 包中导入 stringArg 和 idArg 以使其工作。

GraphQL Nexus 还会生成 GraphQL schema 的 SDL 版本，您可以在 ./generated/schema.graphql 中找到它。我们的 GraphQL API 的最终版本如下所示

---

我们的代码优先 GraphQL 文章的 3 个主要收获

这是我们关于代码优先 GraphQL 服务器开发系列文章的最后一部分。

GraphQL Nexus 和 nexus-prisma 插件实现了我们从两年多来作为 GraphQL 生态系统的积极贡献者所收集的学习成果。在发现 SDL 优先方法存在太多问题后，我们对当前正在兴起的新代码优先工具感到非常兴奋。

我们坚信 GraphQL Nexus（以及其他代码优先方法，如 TypeGraphQL）将极大地改变未来构建 GraphQL schema 的方式。

以下是我们从本系列文章中获得的主要收获

1. 代码优先方法让您以语言惯用的方式构建 GraphQL 服务器，而无需额外的工具（“您需要的唯一工具是您的编程语言”），同时保留 SDL 作为通信工具的优势。
2. GraphQL Nexus 使开发人员可以使用灵活且类型安全的 API 构建他们的 schema。由于自动完成和构建时错误检查，开发人员获得了惊人的体验。
3. nexus-prisma 插件构建在 Prisma 模型之上，让开发人员可以通过公开和自定义自动生成的 CRUD 构建块来构建 GraphQL API。

立即试用 nexus-prisma 🙌

您可以通过多种方式试用 nexus-prisma。您可以按照文档中的 入门 部分，或探索我们的 TypeScript GraphQL 示例。

请通过打开 GitHub issue 或在我们的 Slack 中联系我们来分享您的反馈。

---

向我们的开源工程师 Flavian Desverne 致以崇高的敬意，感谢他在 nexus-prisma 插件上的出色工作 💪✨