自訂驗證

您可以透過以下其中一種方式，為 Prisma Client 查詢的使用者輸入新增執行階段驗證

• Prisma Client 擴充功能
• 自訂函數

您可以使用任何您喜歡的驗證函式庫。Node.js 生態系統提供了許多高品質、易於使用的驗證函式庫可供選擇，包括：joi、validator.js、Yup、Zod 和 Superstruct。

使用 Prisma Client 擴充功能進行輸入驗證

此範例在使用 Zod Schema 建立和更新值時新增執行階段驗證，以檢查傳遞至 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 Schema 來驗證和解析在執行階段查詢中提供的資料，然後再將記錄寫入資料庫。

使用自訂驗證函數進行輸入驗證

以下範例使用 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 中。如果您希望看到這種情況發生，請務必為該問題投贊成票並分享您的使用案例！