类型安全

为 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: '[email protected]',
  },
  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 使用点表示法，您将可以访问可以使用 select 语句与之交互的 User 模型上的所有字段。

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`

导入生成的类型​

什么是生成的类型？​

生成的 UncheckedInput 类型​

类型实用程序​

导入生成的类型

什么是生成的类型？

生成的 `UncheckedInput` 类型

类型实用程序