跳至主要内容

中间件

警告

已弃用：中间件在 4.16.0 版本中已弃用。

我们建议使用 Prisma 客户端扩展 query 组件类型 作为中间件的替代方案。Prisma 客户端扩展首次在 4.7.0 版本的预览版中引入，并在 4.16.0 版本中正式发布。

Prisma 客户端扩展允许你创建独立的 Prisma 客户端实例，并将每个客户端绑定到特定过滤器或用户。例如，你可以将客户端绑定到特定用户，以提供用户隔离。Prisma 客户端扩展还提供端到端的类型安全性。

中间件充当查询级生命周期钩子，允许你在查询运行之前或之后执行操作。使用 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 客户端查询.

中间件的可能用例包括

中间件还有很多其他的用例 - 此列表是针对中间件旨在解决的各种问题的灵感。

示例​

以下示例场景展示了如何在实践中使用中间件

在何处添加中间件​

在请求处理程序的上下文之外添加 Prisma 客户端中间件，否则每个请求都会在堆栈中添加一个新的中间件实例。以下示例演示了如何在 Express 应用程序的上下文中添加 Prisma 客户端中间件

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)
})

运行顺序和中间件堆栈​

如果你有多个中间件，每个单独查询的运行顺序如下

  1. 每个中间件中在 await next(params) 之前的所有逻辑，按降序排列
  2. 每个中间件中在 await next(params) 之后的所有逻辑，按升序排列

根据你在堆栈中的位置，await next(params) 将会

  • 运行下一个中间件（在示例中的中间件 #1 和 #2 中）或
  • 运行原始 Prisma 客户端查询（在中间件 #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 约束吗？