封装Mongoose文档实现业务逻辑：Intellisense与类型方案是否可行？

我正尝试寻找一种优雅的方式，让封装在类中以实现业务逻辑的Mongoose文档能够获得Intellisense（智能提示）和类型支持。我想出了如下解决方案，感觉有点取巧，但似乎能正常运行。请问该方案是否可行，或者有没有更好的方法？

其中关键且让我觉得取巧的部分是这行代码：type UserDocument = IUser & Document<IUser>;

import mongoose, {Document, model, Schema} from "mongoose";

interface IUser {
  firstName: string
}

const userSchema = new Schema<IUser>({
  firstName: {type: String, required: true}
});

const DbUser = mongoose.models.User || model<IUser>('User', userSchema);
type UserDocument = IUser & Document<IUser>;

export class User {
  private userData: UserDocument = new DbUser();

  public set firstName(value: string) {
    this.userData.firstName = value;
  }

  public get firstName() {
    return this.userData.firstName;
  }

  public static async createFromDocument(document: UserDocument): Promise<User> {
    const user = new User();
    user.userData = document;
    return user;
  }

  public async save(): Promise<void> {
    await this.userData.save();
  }
}

方案可行性分析与优化建议 #

你的方案完全可行，通过IUser & Document<IUser>合并接口确实能让你同时获得业务字段和Mongoose文档内置方法的类型提示，但Mongoose本身提供了更规范的官方方案来定义文档类型，无需手动合并。

官方推荐优化：使用HydratedDocument #

从Mongoose 6.0版本开始，官方推荐用HydratedDocument来表示从数据库取出、带有全部Mongoose操作方法的文档类型，它会自动合并你的业务接口与Mongoose文档的内置属性/方法，代码更简洁规范：

import mongoose, { HydratedDocument, model, Schema } from "mongoose";

interface IUser {
  firstName: string;
}

const userSchema = new Schema<IUser>({
  firstName: { type: String, required: true }
});

// 用HydratedDocument替代手动合并，语义更清晰
type UserDocument = HydratedDocument<IUser>;

const DbUser = mongoose.models.User || model<IUser>('User', userSchema);

export class User {
  private userData: UserDocument;

  // 新增构造函数，支持直接传入初始化数据
  constructor(data?: Partial<IUser>) {
    this.userData = data ? new DbUser(data) : new DbUser();
  }

  public set firstName(value: string) {
    this.userData.firstName = value;
  }

  public get firstName() {
    return this.userData.firstName;
  }

  public static async createFromDocument(document: UserDocument): Promise<User> {
    const user = new User();
    user.userData = document;
    return user;
  }

  public async save(): Promise<void> {
    await this.userData.save();
  }
}

为什么推荐HydratedDocument？ #

• 官方维护的类型，会随Mongoose版本更新自动适配新的文档属性和方法，避免手动合并可能出现的类型遗漏或版本兼容问题
• 语义更明确，直接表明这是经过Mongoose“水合”处理的完整文档，包含所有内置操作方法

额外优化方向 #

1. 给User类添加构造函数，支持直接传入初始化数据，减少重复代码
2. 可以将业务逻辑直接封装到类的方法中（比如添加updateFullName这类方法），让业务逻辑更内聚，避免零散的操作

内容的提问来源于stack exchange，提问作者Will Calderwood