Typegoose中基类使用_id属性的注意事项

背景介绍

在使用Typegoose进行MongoDB数据建模时，开发者经常会遇到需要在基类中定义通用字段的情况。其中，_id作为MongoDB文档的标准标识符字段，经常会被包含在基类中。然而，在实际使用过程中，如果不注意一些细节，就可能导致"Virtual path '_id' conflicts with a real path in the schema"这样的错误。

问题分析

在Typegoose中，当我们在基类中定义_id属性时，常见的问题场景包括：

1. 类型定义不当：使用联合类型Types.ObjectId | string | number会导致Typegoose无法准确推断类型，从而默认使用Mixed类型。

2. 模型重复构建：错误地从已构建的模型再次调用getModelForClass，而不是直接使用类定义。

3. 继承关系处理：基类中的_id属性与Mongoose默认添加的虚拟_id属性产生冲突。

解决方案

正确的类型定义

对于_id属性，建议明确指定类型。虽然MongoDB支持多种ID类型，但在Typegoose中最好保持一致性：

@prop()
_id?: Types.ObjectId;

如果确实需要支持多种类型，可以添加allowMixed选项来避免警告：

@prop({ allowMixed: Severity.ALLOW })
_id?: Types.ObjectId | string | number;

避免模型重复构建

一个常见的错误模式是：

// 错误做法：从模型再次构建模型
const model = getModelForClass(PermissionPojoModel);

正确的做法应该是：

// 正确做法1：直接从类构建模型
const model = getModelForClass(PermissionPojo);

// 正确做法2：直接使用已构建的模型
const entity = await PermissionPojoModel.create({});

基类设计最佳实践

在设计包含_id的基类时，建议：

1. 明确文档接口：

export interface ITrackable {
    _id?: Types.ObjectId;
    createdBy?: string;
    createdAt?: Date;
    updatedAt?: Date;
}

2. 实现基类：

export abstract class AbstractPojo<T> implements ITrackable {
    @prop()
    _id?: Types.ObjectId;
    
    @prop()
    createdAt?: Date;
    
    // 其他公共字段和方法...
}

实际应用示例

以下是一个完整的使用示例：

// 定义接口
export interface IPermissionDTO {
    name: string;
    displayName?: string;
}

// 实现类
export class PermissionPojo extends AbstractPojo<PermissionPojo> implements IPermissionDTO {
    @prop({ required: true })
    name!: string;
    
    @prop()
    displayName?: string;
}

// 正确获取模型
export const PermissionModel = getModelForClass(PermissionPojo);

// 使用示例
async function createPermission() {
    const permission = await PermissionModel.create({
        name: "admin",
        displayName: "Administrator"
    });
    console.log(permission._id); // 自动生成的ObjectId
}

总结

在Typegoose中使用基类包含_id属性时，需要注意以下几点：

1. 明确指定_id的类型，避免使用过于宽泛的联合类型
2. 不要从已构建的模型再次创建模型
3. 合理设计基类接口和实现
4. 必要时使用allowMixed选项来处理复杂类型

遵循这些原则，可以避免大部分与_id属性相关的冲突问题，构建出更加健壮的Typegoose数据模型。