Node+Mongo+TypeScript：如何用插件为所有Mongoose Schema统一新增字段？

一、用全局插件实现统一字段注入 #

Mongoose支持全局注册插件，可一次性给所有Schema添加公共字段，无需重复编写代码。

1. 编写全局字段插件 #

创建插件函数，通过schema.add()注入统一字段，还可搭配中间件实现自动更新逻辑：

import mongoose from 'mongoose';

function globalFieldsPlugin(schema: mongoose.Schema) {
  // 注入自定义公共字段，可按需调整
  schema.add({
    createdAt: { type: Date, default: Date.now, immutable: true },
    updatedAt: { type: Date, default: Date.now },
    isDeleted: { type: Boolean, default: false }
  });

  // 自动更新updatedAt字段（覆盖常见更新操作）
  schema.pre(['save', 'updateOne', 'findOneAndUpdate'], function(next) {
    this.set({ updatedAt: new Date() });
    next();
  });
}

2. 全局注册插件 #

在数据库初始化文件中注册插件，后续所有Schema都会自动应用这些字段：

mongoose.plugin(globalFieldsPlugin);

二、同步TypeScript类型到Document #

要让新增字段被TypeScript识别，需扩展Mongoose的Document接口，确保类型检查和智能提示正常工作。

1. 创建类型声明文件 #

在项目根目录或src/types文件夹下创建mongoose.d.ts，扩展Mongoose模块类型：

import mongoose from 'mongoose';

declare module 'mongoose' {
  interface Document {
    createdAt: Date;
    updatedAt: Date;
    isDeleted: boolean;
  }
}

2. 自定义基类接口（可选） #

若需更灵活的类型控制，可定义包含公共字段的基接口，让业务文档接口继承：

// 公共字段基接口
interface BaseDocument extends mongoose.Document {
  createdAt: Date;
  updatedAt: Date;
  isDeleted: boolean;
}

// 业务文档接口继承基接口
interface UserDocument extends BaseDocument {
  username: string;
  email: string;
}

// 创建Schema时关联类型
const userSchema = new mongoose.Schema<UserDocument>({
  username: { type: String, required: true },
  email: { type: String, required: true }
});

三、解决泛型Schema的属性访问问题 #

如果在插件或业务代码中使用泛型Schema时无法访问新增字段，可通过以下方式解决：

1. 插件中间件中使用类型断言 #

在插件中间件里，通过类型断言指定this的类型为扩展后的Document：

schema.pre('save', function(this: BaseDocument, next) {
  this.updatedAt = new Date(); // 无类型错误，正常访问字段
  next();
});

2. 查询时明确返回类型 #

查询数据时，指定返回的Document类型，确保能访问公共字段：

const user = await UserModel.findOne({ username: 'test' }).exec() as UserDocument;
console.log(user.createdAt); // 类型正常识别

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