表继承

概述

表继承是一种软件设计模式，它允许对实体之间的分层关系进行建模。在数据库层面使用表继承还可以让您在 JavaScript/TypeScript 应用程序中使用联合类型，或在多个模型之间共享一组公共属性。

本页面介绍了两种表继承方法，并解释了如何将它们与 Prisma ORM 一起使用。

表继承的一个常见用例可能是应用程序需要显示某种“内容活动”的“动态”。在这种情况下，内容活动可以是“视频”或“文章”。例如，我们假设

• 内容活动始终具有 id 和 url
• 除了 id 和 url 之外，视频还具有 duration（建模为 Int）
• 除了 id 和 url 之外，文章还具有 body（建模为 String）

用例

联合类型

联合类型是 TypeScript 中的一项便捷功能，允许开发人员更灵活地处理数据模型中的类型。

在 TypeScript 中，联合类型如下所示

type Activity = Video | Article

虽然目前无法在 Prisma 模式中建模联合类型，但您可以通过使用表继承和一些额外的类型定义来将其与 Prisma ORM 一起使用。

在多个模型之间共享属性

如果您有一个用例，其中多个模型应该共享一组特定的属性，您也可以使用表继承来建模。

例如，如果上面的 Video 和 Article 模型都应该有一个共享的 title 属性，您也可以通过表继承实现这一点。

示例

在一个简单的 Prisma 模式中，这看起来如下。请注意，我们还添加了一个 User 模型，以说明这如何与关系一起工作

schema.prisma

model Video {
  id       Int    @id
  url      String @unique
  duration Int

  user   User @relation(fields: [userId], references: [id])
  userId Int
}

model Article {
  id   Int    @id
  url  String @unique
  body String

  user   User @relation(fields: [userId], references: [id])
  userId Int
}

model User {
  id       Int       @id
  name     String
  videos   Video[]
  articles Article[]
}

让我们研究一下如何使用表继承来建模。

单表继承与多表继承

以下是对两种主要表继承方法的快速比较

• 单表继承 (STI)：使用“单个”表将“所有”不同实体的数据存储在一个位置。在我们的示例中，将有一个包含 id、url 以及 duration 和 body 列的单个 Activity 表。它还使用一个 type 列，指示“活动”是“视频”还是“文章”。
• 多表继承 (MTI)：使用“多个”表分别存储不同实体的数据，并通过外键将它们链接起来。在我们的示例中，将有一个包含 id、url 列的 Activity 表，一个包含 duration 和 Activity 外键的 Video 表，以及一个包含 body 和外键的 Article 表。还有一个 type 列作为鉴别器，指示“活动”是“视频”还是“文章”。请注意，多表继承有时也称为“委托类型”。

您可以在下面了解这两种方法的权衡。

单表继承 (STI)

数据模型

使用 STI，上述场景可以建模如下

model Activity {
  id       Int          @id // shared
  url      String       @unique // shared
  duration Int? // video-only
  body     String? // article-only
  type     ActivityType // discriminator

  owner   User @relation(fields: [ownerId], references: [id])
  ownerId Int
}

enum ActivityType {
  Video
  Article
}

model User {
  id         Int        @id @default(autoincrement())
  name       String?
  activities Activity[]
}

需要注意的几点

• 模型特定的属性 duration 和 body 必须标记为可选（即，带有 ?）。这是因为代表“视频”的 Activity 表中的记录不得具有 body 的值。相反，代表“文章”的 Activity 记录永远不能设置 duration。
• type 鉴别器列指示每条记录是表示“视频”还是“文章”项目。

Prisma 客户端 API

由于 Prisma ORM 为数据模型生成类型和 API 的方式，您将只能使用 Activity 类型以及属于它的 CRUD 查询（create、update、delete 等）。

查询视频和文章

您现在可以通过过滤 type 列来仅查询“视频”或“文章”。例如

// Query all videos
const videos = await prisma.activity.findMany({
  where: { type: 'Video' },
})

// Query all articles
const articles = await prisma.activity.findMany({
  where: { type: 'Article' },
})

定义专用类型

当像这样查询视频和文章时，TypeScript 仍然只会识别 Activity 类型。这可能很烦人，因为即使 videos 中的对象也将具有（可选的）body 字段，而 articles 中的对象将具有（可选的）duration 字段。

如果您想对这些对象进行类型安全检查，则需要为它们定义专用类型。例如，您可以通过使用生成的 Activity 类型和 TypeScript Omit 实用程序类型来删除其中的属性来完成此操作

import { Activity } from '../prisma/generated/client'

type Video = Omit<Activity, 'body' | 'type'>
type Article = Omit<Activity, 'duration' | 'type'>

此外，创建映射函数将 Activity 类型的对象转换为 Video 和 Article 类型将很有帮助

function activityToVideo(activity: Activity): Video {
  return {
    url: activity.url,
    duration: activity.duration ? activity.duration : -1,
    ownerId: activity.ownerId,
  } as Video
}

function activityToArticle(activity: Activity): Article {
  return {
    url: activity.url,
    body: activity.body ? activity.body : '',
    ownerId: activity.ownerId,
  } as Article
}

现在，您可以在查询后将 Activity 转换为更具体的类型（即 Article 或 Video）

const videoActivities = await prisma.activity.findMany({
  where: { type: 'Video' },
})
const videos: Video[] = videoActivities.map(activityToVideo)

使用 Prisma 客户端扩展实现更便捷的 API

您可以使用 Prisma 客户端扩展 为数据库中的表结构创建更便捷的 API。

多表继承 (MTI)

数据模型

使用 MTI，上述场景可以建模如下

model Activity {
  id   Int          @id @default(autoincrement())
  url  String // shared
  type ActivityType // discriminator

  video   Video? // model-specific 1-1 relation
  article Article? // model-specific 1-1 relation

  owner   User @relation(fields: [ownerId], references: [id])
  ownerId Int
}

model Video {
  id         Int      @id @default(autoincrement())
  duration   Int // video-only
  activityId Int      @unique
  activity   Activity @relation(fields: [activityId], references: [id])
}

model Article {
  id         Int      @id @default(autoincrement())
  body       String // article-only 
  activityId Int      @unique
  activity   Activity @relation(fields: [activityId], references: [id])
}

enum ActivityType {
  Video
  Article
}

model User {
  id         Int        @id @default(autoincrement())
  name       String?
  activities Activity[]
}

需要注意的几点

• Activity 和 Video 之间以及 Activity 和 Article 之间需要一个 1-1 关系。此关系用于在需要时获取有关记录的特定信息。
• 使用这种方法，模型特定的属性 duration 和 body 可以设置为“必需”。
• type 鉴别器列指示每条记录是表示“视频”还是“文章”项目。

Prisma 客户端 API

这次，您可以直接通过 PrismaClient 实例上的 video 和 article 属性查询视频和文章。

查询视频和文章

如果要访问共享属性，需要使用 include 来获取与 Activity 的关系。

// Query all videos
const videos = await prisma.video.findMany({
  include: { activity: true },
})

// Query all articles
const articles = await prisma.article.findMany({
  include: { activity: true },
})

根据您的需要，您也可以通过过滤 type 鉴别器列来反向查询

// Query all videos
const videoActivities = await prisma.activity.findMany({
  where: { type: 'Video' }
  include: { video: true }
})

定义专用类型

虽然在类型方面比 STI 方便一些，但生成的类型可能仍然无法满足您的所有需求。

以下是如何通过将 Prisma ORM 生成的 Video 和 Article 类型与 Activity 类型组合来定义 Video 和 Article 类型。这些组合创建了一个具有所需属性的新类型。请注意，我们还省略了 type 鉴别器列，因为特定类型上不再需要它

import {
  Video as VideoDB,
  Article as ArticleDB,
  Activity,
} from '../prisma/generated/client'

type Video = Omit<VideoDB & Activity, 'type'>
type Article = Omit<ArticleDB & Activity, 'type'>

定义这些类型后，您可以定义映射函数，将从上述查询中接收到的类型转换为所需的 Video 和 Article 类型。这是 Video 类型的示例

import { Prisma, Video as VideoDB, Activity } from '../prisma/generated/client'

type Video = Omit<VideoDB & Activity, 'type'>

// Create `VideoWithActivity` typings for the objects returned above
const videoWithActivity = Prisma.validator<Prisma.VideoDefaultArgs>()({
  include: { activity: true },
})
type VideoWithActivity = Prisma.VideoGetPayload<typeof videoWithActivity>

// Map to `Video` type
function toVideo(a: VideoWithActivity): Video {
  return {
    id: a.id,
    url: a.activity.url,
    ownerId: a.activity.ownerId,
    duration: a.duration,
    activityId: a.activity.id,
  }
}

现在，您可以获取上述查询返回的对象，并使用 toVideo 对它们进行转换

const videoWithActivities = await prisma.video.findMany({
  include: { activity: true },
})
const videos: Video[] = videoWithActivities.map(toVideo)

使用 Prisma 客户端扩展实现更便捷的 API

您可以使用 Prisma 客户端扩展 为数据库中的表结构创建更便捷的 API。

STI 与 MTI 之间的权衡

• 数据模型：使用 MTI，数据模型可能感觉更清晰。使用 STI，您最终可能会得到非常宽的行和许多包含 NULL 值的列。
• 性能：MTI 可能会带来性能成本，因为您需要连接父表和子表才能访问模型的所有相关属性。
• 类型：使用 Prisma ORM，MTI 已经为您提供了特定模型（即，上述示例中的 Article 和 Video）的正确类型，而使用 STI 则需要从头开始创建这些类型。
• ID / 主键：使用 MTI，记录具有两个 ID（一个在父表上，另一个在子表上），它们可能不匹配。您需要在应用程序的业务逻辑中考虑这一点。

第三方解决方案

虽然 Prisma ORM 目前不原生支持联合类型或多态性，但您可以查看 Zenstack，它正在为 Prisma 模式添加额外一层功能。阅读他们的关于 Prisma ORM 中多态性的博客文章以了解更多信息。