如何在Prisma中允许添加任意字段？（MongoDB环境）

因为MongoDB是文档型数据库，天生支持灵活的字段结构，结合Prisma可以轻松实现类似TypeScript中[key: string]: string的任意字段功能，具体步骤如下：

1. 在Prisma Schema中配置Json字段 #

Prisma为MongoDB提供了Json类型，用来存储任意JSON结构的数据。我们可以专门定义一个字段来存放这些任意键值对：

model User {
  id    String @id @default(auto()) @map("_id") @db.ObjectId
  name  String
  // 用于存储任意string键值对的字段，允许为null
  meta  Json?
}

执行npx prisma generate更新Prisma客户端后，这个meta字段会被生成为Prisma.JsonValue类型。

2. 添加TypeScript类型约束 #

为了实现严格的[key: string]: string类型检查，我们需要在TypeScript层面自定义类型并覆盖Prisma生成的模型类型：

// 自定义索引签名类型，限制所有值为string
type StringKeyIndex = {
  [key: string]: string;
};

// 重载Prisma的User类型，将meta字段约束为我们定义的类型
type TypedUser = Omit<Prisma.UserGetPayload<{}>, 'meta'> & {
  meta?: StringKeyIndex;
};

这样在业务代码中使用TypedUser类型时，TypeScript会自动校验meta中的所有键值对必须符合string: string的格式。

3. 数据库操作示例 #

创建带任意字段的文档 #

const newUser = await prisma.user.create({
  data: {
    name: "Alice",
    meta: {
      occupation: "Engineer",
      location: "Berlin"
      // 如果尝试写入非string值（比如age: 30），TypeScript会直接报错
    }
  }
});

查询并访问任意字段 #

const user = await prisma.user.findUnique({
  where: { id: "your-user-id" }
}) as TypedUser;

// TypeScript会自动提示字段类型为string
console.log(user.meta?.occupation);

4. 数据库层面的强制约束（可选） #

如果需要在MongoDB层面强制meta字段的所有值都是string，可以通过Prisma的@@mongodb.collectionValidationRule添加集合验证规则：

model User {
  id    String @id @default(auto()) @map("_id") @db.ObjectId
  name  String
  meta  Json?

  // 集合级验证规则，强制meta的额外属性必须是string
  @@mongodb.collectionValidationRule({
    $jsonSchema: {
      properties: {
        meta: {
          type: "object",
          additionalProperties: { type: "string" }
        }
      }
    }
  })
}

这样即使绕过TypeScript校验，MongoDB也会拒绝不符合规则的数据写入。

内容的提问来源于stack exchange，提问作者Maciej Bledkowski