TypeScript+Mongoose中toObject后id属性不存在的类型错误问题

核心思路 #

遵循整洁架构要求，隔离领域模型与数据库细节，通过类型断言或独立转换函数，将Mongoose返回的对象映射到自定义的领域User类型，避免依赖mongoose.Document。

具体方案 #

方案1：类型断言+确保transform生效 #

在调用toObject()后，直接将结果断言为你的领域User类型，前提是Schema的transform逻辑已正确配置：

async findByEmail(email: string): Promise<User | null> {
  const doc = await UserModel.findOne({ email });
  if (!doc) return null;
  // 断言为领域User类型，依赖transform已将_id转为id
  const userObj = doc.toObject() as User;
  return userObj;
}

验证Schema的transform配置是否生效：

const userSchema = new Schema({
  email: { type: String, required: true },
  // 其他字段
}, {
  toObject: {
    transform: (doc, ret) => {
      ret.id = ret._id;
      delete ret._id;
      delete ret.__v;
    }
  },
  toJSON: {
    transform: (doc, ret) => {
      ret.id = ret._id;
      delete ret._id;
      delete ret.__v;
    }
  }
});

方案2：独立转换函数（更贴合整洁架构） #

创建仓储层内部的转换函数，明确完成数据库对象到领域模型的映射，彻底隔离两层细节：

// 仅仓储层使用的转换逻辑，领域层无感知
function mapDocToUser(doc: any): User {
  const obj = doc.toObject();
  return {
    id: obj.id || obj._id.toString(), // 兼容transform是否生效的情况
    email: obj.email,
    // 映射其他领域User字段
  };
}

async findByEmail(email: string): Promise<User | null> {
  const doc = await UserModel.findOne({ email });
  if (!doc) return null;
  return mapDocToUser(doc);
}

方案3：Typegoose辅助（可选） #

若使用Typegoose，可通过装饰器定义字段并配置transform，无需领域模型继承Document：

class User {
  @prop()
  id!: string;

  @prop({ required: true })
  email!: string;
}

const UserModel = getModelForClass(User, {
  schemaOptions: {
    toObject: {
      transform: (doc, ret) => {
        ret.id = ret._id;
        delete ret._id;
        delete ret.__v;
      }
    }
  }
});

async findByEmail(email: string): Promise<User | null> {
  const user = await UserModel.findOne({ email });
  if (!user) return null;
  return user.toObject() as User;
}

关键注意事项 #

• 确保领域User类型明确包含id字段：

  type User = {
    id: string;
    email: string;
    // 其他领域字段
  };
  

• 严格禁止领域模型引入任何Mongoose相关类型，保持领域层纯净性。

内容的提问来源于stack exchange，提问作者Guilherme Kauã