不继承mongoose.Document时如何使用markModified方法

问题背景 #

在TypeScript中用Mongoose实现队列类型时，Mongoose无法感知数组的直接修改（如push/pop操作而非重新赋值），需要调用markModified标记数组为脏数据才能保存。但Mongoose 7+已不推荐且不再支持继承mongoose.Document，想在类内部统一管理数组修改的标记逻辑（避免外部每次操作都手动加标记），但类不继承Document就无法访问markModified方法。

解决方案 #

方案1：类型断言快速调用markModified

利用Mongoose的loadClass特性，类的实例本质仍是Mongoose文档对象，只是类型未显式声明。通过类型断言将this转为mongoose.Document即可调用markModified，同时保持类的简洁：

import mongoose from 'mongoose';
import { itemSchema, Item } from "./items";

const schemaKey = "player_item_queue";
const schema = new mongoose.Schema({
  user_id: { type: String, required: true },
  items: { type: [itemSchema], default: [] },
});

// 定义数据结构接口做类型约束
interface PlayerItemQueueData {
  user_id: string;
  items: Item[];
}

export class PlayerItemQueue implements PlayerItemQueueData {
  user_id: string;
  items: Item[];

  public add(item: Item): void {
    this.items.push(item);
    // 类型断言后调用markModified标记数组修改
    (this as mongoose.Document).markModified('items');
  }

  public pop(): Item | undefined {
    const poppedItem = this.items.pop();
    (this as mongoose.Document).markModified('items');
    return poppedItem;
  }
}

schema.loadClass(PlayerItemQueue);
// 结合文档类型与自定义接口做泛型约束
export const PlayerItemQueueModel = mongoose.model<mongoose.Document<unknown, {}, PlayerItemQueueData> & PlayerItemQueueData>(schemaKey, schema);
export { schema as PlayerItemQueueSchema };

方案2：指定方法的this类型获得完整提示

如果想要更完善的类型提示，可以定义文档类型并在方法中指定this的类型，避免重复写类型断言：

import mongoose, { Document } from 'mongoose';
import { itemSchema, Item } from "./items";

const schemaKey = "player_item_queue";
const schema = new mongoose.Schema({
  user_id: { type: String, required: true },
  items: { type: [itemSchema], default: [] },
});

// 合并文档类型与自定义数据结构
type PlayerItemQueueDocument = Document & {
  user_id: string;
  items: Item[];
};

export class PlayerItemQueue {
  // 用!跳过初始化检查，Mongoose会自动赋值
  user_id!: string;
  items!: Item[];

  // 指定方法的this类型为文档类型，直接调用markModified
  public add(this: PlayerItemQueueDocument, item: Item): void {
    this.items.push(item);
    this.markModified('items');
  }

  public pop(this: PlayerItemQueueDocument): Item | undefined {
    const poppedItem = this.items.pop();
    this.markModified('items');
    return poppedItem;
  }
}

schema.loadClass(PlayerItemQueue);
export const PlayerItemQueueModel = mongoose.model<PlayerItemQueueDocument>(schemaKey, schema);
export { schema as PlayerItemQueueSchema };

额外提示 #

Mongoose的MongooseArray类型本身会自动追踪push、pop、splice这类方法的修改并标记脏数据，只有直接修改数组元素（如this.items[0] = newItem）或修改数组长度时，才需要手动调用markModified。如果队列操作逻辑复杂，建议在类内部统一处理标记，确保数据一致性。

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