在Pothos中实现Prisma多态模型与GraphQL接口的最佳实践

前言

在现代GraphQL API设计中，经常会遇到需要处理多态数据模型的情况。本文将深入探讨如何在使用Pothos和Prisma的组合时，优雅地实现GraphQL接口(Interface)来表示多态数据关系。

多态数据模型场景

假设我们有一个媒体内容平台，数据模型包含多种媒体类型：

   +-------+
   | Media |
   +-------+
     /   \
    /     \
+-------+ +-------+
| Movie | | Show  |
+-------+ +-------+

在数据库层面，Movie和Show是独立的Prisma模型，没有共享的基表。但在API层面，我们需要将它们统一表示为Media接口类型。

基础实现方案

1. 定义GraphQL接口

首先，我们需要定义一个Media接口类型：

interface Media {
  id: number | string;
  title: string;
}

const Media = builder.interfaceRef<Media>('Media');
Media.implement({
  fields: (t) => ({
    id: t.exposeID('id', { nullable: false }),
    title: t.exposeString('title', { nullable: false }),
    // 公共字段定义
  })
});

2. 实现具体类型

然后为Movie和Show类型实现这个接口：

const Movie = builder.prismaObject('Movie', {
  interfaces: [Media],
  fields: (t) => ({
    // 特定于Movie的字段
  })
});

const Show = builder.prismaObject('Show', {
  interfaces: [Media],
  fields: (t) => ({
    // 特定于Show的字段
  })
});

处理复杂字段

当接口需要包含复杂字段（如计算字段或关联字段）时，需要特别注意：

1. 接口中定义字段占位

在接口中定义字段但不提供具体实现：

Media.implement({
  fields: (t) => ({
    isFollowed: t.boolean({ nullable: false }), // 占位定义
    poster: t.field({
      type: Poster,
      nullable: true
    })
  })
});

2. 在各类型中实现具体逻辑

const Movie = builder.prismaObject('Movie', {
  interfaces: [Media],
  fields: (t) => ({
    isFollowed: t.boolean({
      nullable: false,
      select: (_, ctx) => ({
        followers: {
          where: { userId: ctx.userId },
          select: { id: true }
        }
      }),
      resolve: (movie) => movie.followers.length > 0
    }),
    poster: t.field({
      type: Poster,
      nullable: true,
      select: { poster: true, posterThumb: true },
      resolve: (movie) => 
        movie.poster && movie.posterThumb
          ? new MediaPoster(posters.url(movie.poster), movie.posterThumb)
          : null
    })
  })
});

查询多态集合

查询返回多种类型的集合时，需要使用类型标记：

builder.prismaObject('User', {
  fields: (t) => ({
    followedMedia: t.field({
      type: [Media],
      nullable: false,
      select: {
        followedMovies: { select: { movie: true } },
        followedShows: { select: { show: true } }
      },
      resolve: (user) => [
        ...Movie.addBrand(user.followedMovies.map(f => f.movie)),
        ...Show.addBrand(user.followedShows.map(f => f.show))
      ]
    })
  })
});

关键注意事项

1. 接口类型定义：TypeScript接口只需包含实际存在于父对象上的字段，计算字段不应包含在内

2. 字段实现策略：

   • 基础字段使用expose方法
   • 计算字段在接口中定义占位，在各类型中具体实现

3. 类型安全：确保每个实现类型都提供了接口要求的所有字段

4. 性能考虑：对于关联字段，合理使用Prisma的select优化查询

总结

通过Pothos的接口功能，我们可以优雅地构建多态数据模型的GraphQL API。关键在于：

• 合理设计接口与具体类型的关系
• 正确使用字段占位和具体实现
• 利用类型标记处理多态集合
• 保持类型系统的完整性

这种模式不仅适用于媒体内容场景，也可以广泛应用于电商中的产品变体、社交网络中的内容类型等各种多态数据场景。