Mongoose虚拟填充问题：已填充字段无法直接显示

问题场景 #

在TypeScript项目中使用Mongoose时，给Domain集合的schema添加了名为subdomains的虚拟字段，用于关联填充DomainMonitor集合的数据。填充过程无报错，但打印整个文档对象时看不到subdomains字段，只能通过console.log((r as any).subdomains)单独访问该字段的值。

相关代码 #

Domain接口与Schema定义

export interface IDomain{
    domain:string
    owner:Schema.Types.ObjectId,
}

const domainSchema = new Schema<IDomain>({
    domain:{type:String,required:true},
    owner:{type:Schema.Types.ObjectId,required:true},

})
domainSchema.virtual("subdomains",{
    ref:"DomainMonitor",
    localField: '_id',
    foreignField: 'owner'})

查询示例1（打印整个文档）

Domain.findOne({owner:"633ebe32d0733c0a8eb4f8d6"}).populate("subdomains").then(r=>{
        console.log(r)
})

输出结果

{
  _id: new ObjectId("6342fa2d4b730f004704eb45"),
  domain: 'dummy.com',
  __v: 0,
  owner: new ObjectId("633ebe32d0733c0a8eb4f8d6")
}

查询示例2（单独访问虚拟字段）

Domain.findOne({owner:"633ebe32d0733c0a8eb4f8d6"}).populate("subdomains").then(r=>{
        const domains= (r as any).subdomains
        console.log(domains)
    })

输出结果

[{
  _id: new ObjectId("6342fa314b730f004704eb47"),
  owner: new ObjectId("6342fa2d4b730f004704eb45"),
  subdomain: [
    'dummy',
  ],
  wildcard: [ '*.dummy.com', '*.dummy.com' ],
  __v: 1
}]

问题原因 #

Mongoose的虚拟字段默认不会被包含在文档的toJSON()或toObject()方法的输出中，而console.log打印文档对象时，会默认调用toJSON()方法序列化文档，因此虚拟字段不会显示出来。但虚拟字段实际上已经被填充，只是序列化时被排除了，所以可以直接访问。

解决方法 #

方法1：修改Schema配置，默认包含虚拟字段 #

在定义Schema时，设置toJSON和toObject选项的virtuals为true，这样序列化文档时会自动包含虚拟字段：

const domainSchema = new Schema<IDomain>({
    domain:{type:String,required:true},
    owner:{type:Schema.Types.ObjectId,required:true},
}, {
  toJSON: { virtuals: true },
  toObject: { virtuals: true }
})

方法2：打印时手动转换并包含虚拟字段 #

如果不想修改全局Schema配置，可以在打印时手动调用toObject()并指定包含虚拟字段：

Domain.findOne({owner:"633ebe32d0733c0a8eb4f8d6"}).populate("subdomains").then(r=>{
        console.log(r?.toObject({ virtuals: true }))
})

方法3：完善TypeScript接口定义 #

为了避免使用as any类型断言，在IDomain接口中添加虚拟字段的定义：

import { Document, Schema } from 'mongoose';

export interface IDomain extends Document {
    domain:string;
    owner:Schema.Types.ObjectId;
    subdomains: any[]; // 根据DomainMonitor的实际类型调整这里的定义
}

这样后续访问r.subdomains时就不需要类型断言，同时TypeScript会提供类型提示。

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