Prisma 验证器

The Prisma.validator 是一个实用程序函数，它接受一个生成的类型并返回一个类型安全的对象，该对象符合生成的类型模型字段。

本页介绍了 Prisma.validator 并提供了一些你可能选择使用它的动机。

注意：如果你有 Prisma.validator 的用例，请务必查看这篇文章 博客文章 关于使用新的 TypeScript satisfies 关键字改进你的 Prisma 客户端工作流程。你很可能可以使用 satisfies 来解决你的用例，而不是使用 Prisma.validator。

创建类型化的查询语句

假设你创建了一个新的 userEmail 对象，你希望在应用程序中的不同查询中重用它。它被类型化并且可以在查询中安全使用。

下面的示例要求 Prisma 返回 id 为 3 的用户的 email，如果不存在用户，它将返回 null。

import { Prisma } from '@prisma/client'

const userEmail: Prisma.UserSelect = {
  email: true,
}

// Run inside async function
const user = await prisma.user.findUnique({
  where: {
    id: 3,
  },
  select: userEmail,
})

这很有效，但这种方法提取查询语句有一个注意事项。

你会注意到，如果你将鼠标悬停在 userEmail 上，TypeScript 不会推断对象的键或值（即，email: true）。

同样适用于你使用 userEmail 中的点表示法在 prisma.user.findUnique(...) 查询中，你将能够访问 select 对象可用的所有属性。

如果你在一个文件中使用它，这可能没问题，但如果你要导出此对象并在其他查询中使用它，或者如果你正在编译一个外部库，在那里你想控制用户在他们的查询中如何使用此对象，那么这将是不安全的。

对象 userEmail 已被创建为仅选择用户的 email，但它仍然可以访问所有其他可用的属性。它被类型化，但不是类型安全的。

Prisma 有一种方法可以验证生成的类型以确保它们是类型安全的，它是在命名空间上可用的一个实用程序函数，称为 validator。

使用 Prisma.validator

以下示例将生成的 UserSelect 类型传递给 Prisma.validator 实用程序函数，并以与先前示例非常类似的方式定义预期的返回类型。

import { Prisma } from '@prisma/client'

const userEmail: Prisma.UserSelect = {
  email: true,
}

const userEmail = Prisma.validator<Prisma.UserSelect>()({
  email: true,
})

// Run inside async function
const user = await prisma.user.findUnique({
  where: {
    id: 3,
  },
  select: userEmail,
})

或者，你可以使用以下语法，它使用“选择器”模式使用 Prisma 客户端的现有实例

import { Prisma } from '@prisma/client'
import prisma from './lib/prisma'

const userEmail = Prisma.validator(
  prisma,
  'user',
  'findUnique',
  'select'
)({
  email: true,
})

最大的区别是 userEmail 对象现在是类型安全的。如果你将鼠标悬停在它上面，TypeScript 会告诉你对象的键/值对。如果你使用点表示法访问对象的属性，你将只能访问对象的 email 属性。

当与用户定义的输入（如表单数据）结合使用时，此功能非常方便。

将 Prisma.validator 与表单输入结合使用

以下示例使用 Prisma.validator 创建了一个类型安全的函数，可以在与用户创建的数据（如表单输入）交互时使用。

注意：表单输入是在运行时确定的，因此不能仅使用 TypeScript 进行验证。请务必通过其他方式（如外部验证库）验证你的表单输入，然后再将该数据传递到你的数据库中。

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

const prisma = new PrismaClient()

// Create a new function and pass the parameters onto the validator
const createUserAndPost = (
  name: string,
  email: string,
  postTitle: string,
  profileBio: string
) => {
  return Prisma.validator<Prisma.UserCreateInput>()({
    name,
    email,
    posts: {
      create: {
        title: postTitle,
      },
    },
    profile: {
      create: {
        bio: profileBio,
      },
    },
  })
}

const findSpecificUser = (email: string) => {
  return Prisma.validator<Prisma.UserWhereInput>()({
    email,
  })
}

// Create the user in the database based on form input
// Run inside async function
await prisma.user.create({
  data: createUserAndPost(
    'Rich',
    '[email protected]',
    'Life of Pie',
    'Learning each day'
  ),
})

// Find the specific user based on form input
// Run inside async function
const oneUser = await prisma.user.findUnique({
  where: findSpecificUser('[email protected]'),
})

createUserAndPost 自定义函数使用 Prisma.validator 创建，并传递一个生成的类型 UserCreateInput。Prisma.validator 验证函数的输入，因为分配给参数的类型必须与生成的类型期望的类型匹配。