中间件
已弃用:中间件在 4.16.0 版本中已弃用。
我们建议使用 Prisma Client 扩展 query
组件类型 作为中间件的替代方案。Prisma Client 扩展在 4.7.0 版本中首次引入预览版,并在 4.16.0 版本中正式发布。
Prisma Client 扩展允许您创建独立的 Prisma Client 实例,并将每个客户端绑定到特定的过滤器或用户。例如,您可以将客户端绑定到特定用户以提供用户隔离。Prisma Client 扩展还提供端到端类型安全。
中间件充当查询级生命周期钩子,允许您在查询运行之前或之后执行操作。使用 prisma.$use
方法添加中间件,如下所示
const prisma = new PrismaClient()
// Middleware 1
prisma.$use(async (params, next) => {
// Manipulate params here
const result = await next(params)
// See results here
return result
})
// Middleware 2
prisma.$use(async (params, next) => {
// Manipulate params here
const result = await next(params)
// See results here
return result
})
// Queries here
当使用 批量事务 时,请勿在中间件中多次调用 next
。这将导致您跳出事务并导致意外结果。
params
表示中间件中可用的参数,例如查询的名称,而 next
表示 堆栈中的下一个中间件或原始 Prisma Client 查询。
中间件的可能用例包括
- 设置或覆盖字段值 - 例如,设置博客文章评论的上下文语言
- 验证输入数据 - 例如,通过外部服务检查用户输入中是否包含不当语言
- 拦截
delete
查询并将其更改为update
,以便执行 软删除 - 记录执行查询所花费的时间
中间件还有更多用例 - 此列表旨在为中间件旨在解决的问题类型提供灵感。
示例
以下示例场景展示了如何在实践中使用中间件
中间件示例:软删除
以下示例使用中间件执行软删除。软删除意味着通过更改字段(例如将 deleted 更改为 true)来标记记录为已删除,而不是实际从数据库中删除。使用软删除的原因包括
中间件示例:日志记录
以下示例记录了 Prisma Client 查询运行所花费的时间
中间件示例:会话数据
以下示例将每个 Post 的 language 字段设置为上下文语言(例如,从会话状态获取)
在哪里添加中间件
在请求处理程序上下文之外添加 Prisma Client 中间件,否则每个请求都会向堆栈添加一个新的中间件实例。以下示例演示了在 Express 应用程序的上下文中在哪里添加 Prisma Client 中间件
import express from 'express'
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
prisma.$use(async (params, next) => {
// Manipulate params here
const result = await next(params)
// See results here
return result
})
const app = express()
app.get('/feed', async (req, res) => {
// NO MIDDLEWARE HERE
const posts = await prisma.post.findMany({
where: { published: true },
include: { author: true },
})
res.json(posts)
})
运行顺序和中间件堆栈
如果您有多个中间件,则每个单独查询的运行顺序为
- 每个中间件中
await next(params)
之前的所有逻辑,按降序排列 - 每个中间件中
await next(params)
之后的所有逻辑,按升序排列
根据您在堆栈中的位置,await next(params)
要么
- 运行下一个中间件(示例中的中间件 #1 和 #2)或
- 运行原始 Prisma Client 查询(在中间件 #3 中)
const prisma = new PrismaClient()
// Middleware 1
prisma.$use(async (params, next) => {
console.log(params.args.data.title)
console.log('1')
const result = await next(params)
console.log('6')
return result
})
// Middleware 2
prisma.$use(async (params, next) => {
console.log('2')
const result = await next(params)
console.log('5')
return result
})
// Middleware 3
prisma.$use(async (params, next) => {
console.log('3')
const result = await next(params)
console.log('4')
return result
})
const create = await prisma.post.create({
data: {
title: 'Welcome to Prisma Day 2020',
},
})
const create2 = await prisma.post.create({
data: {
title: 'How to Prisma!',
},
})
输出
Welcome to Prisma Day 2020
1
2
3
4
5
6
How to Prisma!
1
2
3
4
5
6
性能和适当的用例
中间件为每个查询执行,这意味着过度使用可能会对性能产生负面影响。为避免增加性能开销
-
尽早在您的中间件中检查
params.model
和params.action
属性,以避免不必要地运行逻辑prisma.$use(async (params, next) => {
if (params.model == 'Post' && params.action == 'delete') {
// Logic only runs for delete action and Post model
}
return next(params)
}) -
考虑中间件是否适合您的场景。例如
- 如果您需要填充字段,您可以使用
@default
属性吗? - 如果您需要设置
DateTime
字段的值,您可以使用now()
函数或@updatedAt
属性吗? - 如果您需要执行更复杂的验证,您可以在数据库本身中使用
CHECK
约束吗?
- 如果您需要填充字段,您可以使用