自定义验证

您可以为 Prisma Client 查询的用户输入添加运行时验证，通过以下方式之一

• Prisma Client 扩展
• 自定义函数

您可以使用任何您喜欢的验证库。Node.js 生态系统提供了许多高质量、易于使用的验证库可供选择，包括： joi、 validator.js、 Yup、 Zod 和 Superstruct。

使用 Prisma Client 扩展进行输入验证

此示例在使用 Zod 模式创建和更新值时添加运行时验证，以检查传递给 Prisma Client 的数据是否有效。

警告

查询扩展目前不适用于嵌套操作。在此示例中，验证仅在传递给诸如 prisma.product.create() 等方法的顶层数据对象上运行。以这种方式实现的验证不会自动为嵌套写入运行。

Prisma Client 扩展

import { PrismaClient, Prisma } from '@prisma/client'
import { z } from 'zod'

/**
 * Zod schema
 */
export const ProductCreateInput = z.object({
  slug: z
    .string()
    .max(100)
    .regex(/^[a-z0-9]+(?:-[a-z0-9]+)*$/),
  name: z.string().max(100),
  description: z.string().max(1000),
  price: z
    .instanceof(Prisma.Decimal)
    .refine((price) => price.gte('0.01') && price.lt('1000000.00')),
}) satisfies z.Schema<Prisma.ProductUncheckedCreateInput>

/**
 * Prisma Client Extension
 */
const prisma = new PrismaClient().$extends({
  query: {
    product: {
      create({ args, query }) {
        args.data = ProductCreateInput.parse(args.data)
        return query(args)
      },
      update({ args, query }) {
        args.data = ProductCreateInput.partial().parse(args.data)
        return query(args)
      },
      updateMany({ args, query }) {
        args.data = ProductCreateInput.partial().parse(args.data)
        return query(args)
      },
      upsert({ args, query }) {
        args.create = ProductCreateInput.parse(args.create)
        args.update = ProductCreateInput.partial().parse(args.update)
        return query(args)
      },
    },
  },
})

async function main() {
  /**
   * Example usage
   */
  // Valid product
  const product = await prisma.product.create({
    data: {
      slug: 'example-product',
      name: 'Example Product',
      description: 'Lorem ipsum dolor sit amet',
      price: new Prisma.Decimal('10.95'),
    },
  })

  // Invalid product
  try {
    await prisma.product.create({
      data: {
        slug: 'invalid-product',
        name: 'Invalid Product',
        description: 'Lorem ipsum dolor sit amet',
        price: new Prisma.Decimal('-1.00'),
      },
    })
  } catch (err: any) {
    console.log(err?.cause?.issues)
  }
}

main()

Prisma schema

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

model Product {
  id          String   @id @default(cuid())
  slug        String
  name        String
  description String
  price       Decimal
  reviews     Review[]
}

model Review {
  id        String  @id @default(cuid())
  body      String
  stars     Int
  product   Product @relation(fields: [productId], references: [id], onDelete: Cascade)
  productId String
}

上面的示例使用 Zod 模式来验证和解析在运行时查询中提供的数据，然后再将记录写入数据库。

使用自定义验证函数进行输入验证

这是一个使用 Superstruct 的示例，用于验证注册新用户所需的数据是否正确

import { PrismaClient, Prisma, User } from '@prisma/client'
import { assert, object, string, size, refine } from 'superstruct'
import isEmail from 'isemail'

const prisma = new PrismaClient()

// Runtime validation
const Signup = object({
  // string and a valid email address
  email: refine(string(), 'email', (v) => isEmail.validate(v)),
  // password is between 7 and 30 characters long
  password: size(string(), 7, 30),
  // first name is between 2 and 50 characters long
  firstName: size(string(), 2, 50),
  // last name is between 2 and 50 characters long
  lastName: size(string(), 2, 50),
})

type Signup = Omit<Prisma.UserCreateArgs['data'], 'id'>

// Signup function
async function signup(input: Signup): Promise<User> {
  // Assert that input conforms to Signup, throwing with a helpful
  // error message if input is invalid.
  assert(input, Signup)
  return prisma.user.create({
    data: input.user,
  })
}

上面的示例展示了如何创建一个自定义的类型安全 signup 函数，该函数确保输入在创建用户之前是有效的。

更进一步

• 了解如何使用 Prisma Client 扩展为您的查询添加输入验证 — 示例。
• 了解如何通过将 signup 函数移动到自定义模型中来更好地组织您的代码。
• 有一个未完成的功能请求将用户验证烘焙到 Prisma Client 中。如果您希望看到这种情况发生，请务必支持该问题并分享您的用例！