类型安全

Prisma Client 生成的代码包含多种有用的类型和实用工具，可以帮助您使应用程序更具类型安全性。本页描述了如何利用它们。

注意：如果您对 Prisma ORM 的高级类型安全主题感兴趣，请务必查看这篇关于使用 TypeScript 新增的 satisfies 关键字改进 Prisma Client 工作流的博客文章。

导入生成的类型

您可以导入 Prisma 命名空间，并使用点表示法访问类型和实用工具。以下示例展示了如何导入 Prisma 命名空间并使用它访问和使用 Prisma.UserSelect 生成类型。

import { Prisma } from '@prisma/client'

// Build 'select' object
const userEmail: Prisma.UserSelect = {
  email: true,
}

// Use select object
const createUser = await prisma.user.create({
  data: {
    email: 'bob@prisma.io',
  },
  select: userEmail,
})

另请参阅：使用 Prisma.UserCreateInput 生成类型

什么是生成类型？

生成类型是派生自您的模型的 TypeScript 类型。您可以使用它们创建类型化对象，然后将其传递给顶级方法，如 prisma.user.create(...) 或 prisma.user.update(...)，或选项，如 select 或 include。

例如，select 接受一个 UserSelect 类型的对象。它的对象属性与模型支持的 select 语句的属性匹配。

下面的第一个选项卡显示了 UserSelect 生成类型以及对象上每个属性如何具有类型注释。第二个选项卡显示了从中生成类型的原始模式。

type Prisma.UserSelect = {
    id?: boolean | undefined;
    email?: boolean | undefined;
    name?: boolean | undefined;
    posts?: boolean | Prisma.PostFindManyArgs | undefined;
    profile?: boolean | Prisma.ProfileArgs | undefined;
}

model User {
  id      Int      @id @default(autoincrement())
  email   String   @unique
  name    String?
  posts   Post[]
  profile Profile?
}

在 TypeScript 中，类型注释 的概念是声明一个变量并添加类型注释来描述变量的类型。请参阅下面的示例。

const myAge: number = 37
const myName: string = 'Rich'

这两个变量声明都已给定类型注释，以分别指定它们的原始类型为 number 和 string。大多数情况下，不需要这种注释，因为 TypeScript 会根据变量的初始化方式推断变量的类型。在上面的示例中，myAge 用一个数字初始化，因此 TypeScript 猜测它应该被类型化为数字。

回到 UserSelect 类型，如果您要在创建的对象 userEmail 上使用点表示法，您将可以访问 User 模型上所有可以使用 select 语句进行交互的字段。

model User {
  id      Int      @id @default(autoincrement())
  email   String   @unique
  name    String?
  posts   Post[]
  profile Profile?
}

import { Prisma } from '@prisma/client'

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

// properties available on the typed object
userEmail.id
userEmail.email
userEmail.name
userEmail.posts
userEmail.profile

同样，您可以使用 include 生成类型来对对象进行类型化，然后您的对象将可以访问您可以在其上使用 include 语句的那些属性。

import { Prisma } from '@prisma/client'

const userPosts: Prisma.UserInclude = {
  posts: true,
}

// properties available on the typed object
userPosts.posts
userPosts.profile

有关可用不同类型的更多信息，请参阅模型查询选项参考。

生成的 UncheckedInput 类型

UncheckedInput 类型是一组特殊的生成类型，允许您执行 Prisma Client 认为“不安全”的一些操作，例如直接写入关系标量字段。在执行 create、update 或 upsert 等操作时，您可以选择“安全”的 Input 类型或“不安全”的 UncheckedInput 类型。

例如，此 Prisma 模式在 User 和 Post 之间具有一对多关系。

model Post {
  id       Int     @id @default(autoincrement())
  title    String  @db.VarChar(255)
  content  String?
  author   User    @relation(fields: [authorId], references: [id])
  authorId Int
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
}

第一个选项卡显示 PostUncheckedCreateInput 生成类型。它包含 authorId 属性，这是一个关系标量字段。第二个选项卡显示一个使用 PostUncheckedCreateInput 类型的示例查询。如果 id 为 1 的用户不存在，此查询将导致错误。

type PostUncheckedCreateInput = {
  id?: number
  title: string
  content?: string | null
  authorId: number
}

prisma.post.create({
  data: {
    title: 'First post',
    content: 'Welcome to the first post in my blog...',
    authorId: 1,
  },
})

可以使用“更安全”的 PostCreateInput 类型重写相同的查询。此类型不包含 authorId 字段，而是包含 author 关系字段。

type PostCreateInput = {
  title: string
  content?: string | null
  author: UserCreateNestedOneWithoutPostsInput
}

type UserCreateNestedOneWithoutPostsInput = {
  create?: XOR<
    UserCreateWithoutPostsInput,
    UserUncheckedCreateWithoutPostsInput
  >
  connectOrCreate?: UserCreateOrConnectWithoutPostsInput
  connect?: UserWhereUniqueInput
}

prisma.post.create({
  data: {
    title: 'First post',
    content: 'Welcome to the first post in my blog...',
    author: {
      connect: {
        id: 1,
      },
    },
  },
})

如果 id 为 1 的作者不存在，此查询也将导致错误。在这种情况下，Prisma Client 将提供更具描述性的错误消息。您还可以使用 connectOrCreate API 来安全地创建新用户，如果给定 id 的用户不存在的话。

我们建议尽可能使用“安全”的 Input 类型。

类型实用工具

信息

此功能从 Prisma ORM 4.9.0 版本及更高版本可用。

为了帮助您创建高度类型安全的应用程序，Prisma Client 提供了一组利用输入和输出类型的类型实用工具。这些类型是完全动态的，这意味着它们适应任何给定模型和模式。您可以使用它们来改善项目的自动完成和开发者体验。

这在验证输入和共享 Prisma Client 扩展中特别有用。

Prisma Client 中提供了以下类型实用工具：

• Exact<Input, Shape>：对 Input 强制执行严格的类型安全。Exact 确保通用类型 Input 严格符合您在 Shape 中指定的类型。它将 Input 缩小 到最精确的类型。
• Args<Type, Operation>：检索任何给定模型和操作的输入参数。这对于希望执行以下操作的扩展作者特别有用：
  • 重用现有类型以扩展或修改它们。
  • 从与现有操作相同的自动完成体验中受益。
• Result<Type, Arguments, Operation>：获取输入参数并为给定模型和操作提供结果。您通常会将其与 Args 结合使用。与 Args 一样，Result 帮助您重用现有类型以扩展或修改它们。
• Payload<Type, Operation>：检索结果的整个结构，作为给定模型和操作的标量和关系对象。例如，您可以使用它在类型级别确定哪些键是标量或对象。

例如，这里有一种快速方法可以强制函数的参数与您将传递给 post.create 的参数匹配：

type PostCreateBody = Prisma.Args<typeof prisma.post, 'create'>['data']

const addPost = async (postBody: PostCreateBody) => {
  const post = await prisma.post.create({ data: postBody })
  return post
}

await addPost(myData)
//              ^ guaranteed to match the input of `post.create`