在传统的后端 API 开发中，开发者需要自行编写数据库查询、定义数据类型及其关系以及 API 接口。而 GraphQL 和 Prisma 的出现，则可简化这 一过程。GraphQL 是一种用于 API 的查询语言，而 Prisma 可以帮助我们管理数据模型。
因此，这篇文章主要介绍如何使用 GraphQL 和 Prisma 实现后端 API。我们将通过以下步骤逐一实现：
- 创建 Prisma 数据模型
- 创建 GraphQL schema 和 resolver
- 将 GraphQL API 与 Prisma 数据库集成
- 使用 Prisma 客户端进行数据库操作
前置条件：
- 已经安装 Node.js 和 npm。
- 具备基础的 JavaScript 和 GraphQL 知识。
1. 创建 Prisma 数据模型
首先我们需要安装 Prisma。在命令行中输入：
npm install prisma --save-dev
接下来，在项目根目录下运行以下命令生成 Prisma 配置文件和数据模型文件：
npx prisma init
这个命令会自动生成一个 prisma 目录和相应的文件，如图所示：
现在，我们需要打开 prisma/schema.prisma 文件，并定义我们的数据模型。假设我们需要管理学生和教师信息，我们可以这样来定义：
// javascriptcn.com 代码示例
plasma:
datasource db {
provider = "postgresql"
url = "postgresql://user:password@localhost:5432/mydatabase?schema=public"
}
model Student {
id Int @id @default(autoincrement())
name String
age Int
gpa Float
major String?
}
model Teacher {
id Int @id @default(autoincrement())
name String
age Int
title String?
}这里，我们定义了一个 db 数据源，可以指向我们的 PostgreSQL 数据库。在本例中，假设我们使用的是本地的 PostgreSQL 数据库，端口为 5432，数据库名字为 mydatabase。
我们还定义了两个模型：Student 和 Teacher。其中，Student 模型有 id、name、age、gpa 和 major 字段，Teacher 模型有 id、name、age 和 title 字段。
现在，我们需要在命令行中运行以下命令来同步 Prisma 数据模型到数据库中：
npx prisma db push
这个命令将自动创建数据库表和字段，并将 Prisma 数据模型同步到数据库中。
2. 创建 GraphQL schema 和 resolver
接下来，我们需要定义一个 GraphQL schema 和 resolver 来实现我们的业务逻辑。我们需要先安装 graphql 和 apollo-server。
npm install graphql apollo-server --save-dev
然后在项目根目录中创建以下三个文件：
. ├── src/ │ ├── schema.graphql │ ├── resolvers.js │ └── index.js └── package.json
schema.graphql：定义 GraphQL schema。resolvers.js：定义 resolver 函数。index.js：开启 Apollo Server。
我们需要在 schema.graphql 中定义我们的 GraphQL schema。对于我们的学生和教师信息管理业务，我们可以这样定义：
// javascriptcn.com 代码示例
type Student {
id: Int!
name: String!
age: Int!
gpa: Float!
major: String
}
type Teacher {
id: Int!
name: String!
age: Int!
title: String
}
type Query {
students: [Student]!
student(id: Int!): Student
teachers: [Teacher]!
teacher(id: Int!): Teacher
}
type Mutation {
createStudent(name: String!, age: Int!, gpa: Float!, major: String): Student!
updateStudent(id: Int!, name: String, age: Int, gpa: Float, major: String): Student!
deleteStudent(id: Int!): Student!
createTeacher(name: String!, age: Int!, title: String): Teacher!
updateTeacher(id: Int!, name: String, age: Int, title: String): Teacher!
deleteTeacher(id: Int!): Teacher!
}这里，我们定义了两个类型：Student 和 Teacher，分别对应我们的数据模型。对于查询，我们定义了 Query 类型，其中包括 students、student、teachers 和 teacher 四个字段。对于 CRUD 操作，我们定义了 Mutation 类型，其中包括 createStudent、updateStudent、deleteStudent、createTeacher、updateTeacher 和 deleteTeacher 六个字段。
接下来，我们需要在 resolvers.js 文件中定义 resolver 函数。我们可以按照以下方式定义：
// javascriptcn.com 代码示例
const { PrismaClient } = require('@prisma/client')
const prisma = new PrismaClient()
const resolvers = {
Query: {
students: () => {
return prisma.student.findMany()
},
student: (root, { id }) => {
return prisma.student.findUnique({ where: { id: id } })
},
teachers: () => {
return prisma.teacher.findMany()
},
teacher: (root, { id }) => {
return prisma.teacher.findUnique({ where: { id: id } })
},
},
Mutation: {
createStudent: (root, args) => {
const { name, age, gpa, major } = args
return prisma.student.create({ data: { name, age, gpa, major } })
},
updateStudent: (root, args) => {
const { id, name, age, gpa, major } = args
return prisma.student.update({ where: { id }, data: { name, age, gpa, major } })
},
deleteStudent: (root, { id }) => {
return prisma.student.delete({ where: { id } })
},
createTeacher: (root, args) => {
const { name, age, title } = args
return prisma.teacher.create({ data: { name, age, title } })
},
updateTeacher: (root, args) => {
const { id, name, age, title } = args
return prisma.teacher.update({ where: { id }, data: { name, age, title } })
},
deleteTeacher: (root, { id }) => {
return prisma.teacher.delete({ where: { id } })
},
},
}
module.exports = resolvers这里，我们通过 PrismaClient 类来实例化一个 Prisma 客户端，用于与数据库交互。在 resolvers 中，我们定义了 Query 和 Mutation 的各个字段，通过 Prisma 客户端实现相应的查询、更新、删除操作。
最后，我们需要在 index.js 文件中开启 Apollo Server，将 GraphQL schema 和 resolver 作为参数传入。
// javascriptcn.com 代码示例
const { ApolloServer } = require('apollo-server')
const resolvers = require('./resolvers')
const { readFileSync } = require('fs')
const server = new ApolloServer({
typeDefs: readFileSync('./src/schema.graphql', 'utf8'),
resolvers,
})
server.listen().then(({ url }) => {
console.log(`🚀 Server ready at ${url}`)
})现在，我们可以在命令行中执行：
node index.js
来启动 Apollo Server。
3. 将 GraphQL API 与 Prisma 数据库集成
目前，我们已经实现了 GraphQL API 和后端 Prisma 数据库操作的功能。但是，我们的 GraphQL API 并没有与 Prisma 数据库进行集成。因此，我们需要在 prisma/schema.prisma 中定义我们的 Query 和 Mutation 类型：
// javascriptcn.com 代码示例
type Query {
students: [Student!]!
student(id: Int!): Student
teachers: [Teacher!]!
teacher(id: Int!): Teacher
}
type Mutation {
createStudent(data: StudentCreateInput!): Student!
updateStudent(data: StudentUpdateInput!, where: StudentWhereUniqueInput!): Student
deleteStudent(where: StudentWhereUniqueInput!): Student
createTeacher(data: TeacherCreateInput!): Teacher!
updateTeacher(data: TeacherUpdateInput!, where: TeacherWhereUniqueInput!): Teacher
deleteTeacher(where: TeacherWhereUniqueInput!): Teacher
}不难看出，这里的 Query 和 Mutation 类型与我们在 schema.graphql 文件中的定义一致，只是加了一些类型和参数。
接下来，我们需要在命令行中执行以下命令来同步 Prisma 数据模型和 GraphQL schema：
npx prisma generate npx graphql-codegen init
这样，Prisma 会自动生成与 GraphQL schema、TypeScript 类型和 CRUD resolver 相关的代码。
4. 使用 Prisma 客户端进行数据库操作
现在，我们已经完成了 GraphQL API 和 Prisma 数据库的集成，可以使用 Prisma 客户端来操作数据库了。以下是一些示例代码：
// javascriptcn.com 代码示例
const { PrismaClient } = require('@prisma/client')
const prisma = new PrismaClient()
const createStudent = async ({ name, age, gpa, major }) => {
const student = await prisma.student.create({ data: { name, age, gpa, major } })
return student
}
const updateStudent = async ({ id, name, age, gpa, major }) => {
const student = await prisma.student.update({ where: { id }, data: { name, age, gpa, major } })
return student
}
const deleteStudent = async ({ id }) => {
const student = await prisma.student.delete({ where: { id } })
return student
}
const studentById = async ({ id }) => {
const student = await prisma.student.findUnique({ where: { id } })
return student
}
const students = async () => {
const students = await prisma.student.findMany()
return students
}
module.exports = {
createStudent,
updateStudent,
deleteStudent,
studentById,
students,
}以上代码定义了一些函数，用于实现学生信息的增、删、改、查等操作。使用 Prisma 客户端时，我们只需要调用相应的方法（如 prisma.student.create()、prisma.student.update()、prisma.student.delete()、prisma.student.findUnique()、prisma.student.findMany() 等）即可。
总结
本文介绍了如何使用 GraphQL 和 Prisma 实现后端 API。我们首先定义了 Prisma 数据模型，然后创建了 GraphQL schema 和 resolver，进而将 GraphQL API 与 Prisma 数据库集成。最后，我们展示了如何使用 Prisma 客户端来操作数据库。这些内容都可以作为借鉴和学习的参考资料。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/65484c287d4982a6eb2931f7