5月28日 00:07

Mongoose 虚拟字段是什么，如何使用？

Mongoose 虚拟字段是不存储在 MongoDB 中的计算属性，访问时动态求值。它适合派生数据（如全名、年龄、格式化输出）和反向关联查询，避免在数据库中冗余存储。

核心答案

虚拟字段通过 Schema.virtual() 定义，只有 getter（和可选 setter），不会写入数据库，也不能直接用于查询和排序。

javascript
const userSchema = new Schema({
  firstName: String,
  lastName: String
});

userSchema.virtual('fullName')
  .get(function() {
    return `${this.firstName} ${this.lastName}`;
  })
  .set(function(name) {
    const parts = name.split(' ');
    this.firstName = parts[0];
    this.lastName = parts.slice(1).join(' ');
  });

const user = new User({ firstName: 'Zhang', lastName: 'San' });
console.log(user.fullName); // "Zhang San"

user.fullName = 'Li Si';
console.log(user.firstName); // "Li"
console.log(user.lastName);  // "Si"

getter 用 function 而非箭头函数，因为需要通过 this 访问文档实例。

为什么虚拟字段不参与查询

虚拟字段只存在于 Mongoose 文档对象上，MongoDB 层面没有对应字段。find({ fullName: 'Zhang San' }) 会直接报错或返回空结果，因为数据库里根本没有 fullName 这个 key。

需要按虚拟字段逻辑查询时，应该把计算条件拆成实际字段的查询：

javascript
// 不支持
User.find({ fullName: 'Zhang San' });

// 替代方案
User.find({ firstName: 'Zhang', lastName: 'San' });

同理，sort()、索引、聚合管道都无法直接使用虚拟字段。

JSON 序列化默认丢失虚拟字段

toJSON() 和 toObject() 默认不输出虚拟字段。这是最常踩的坑——接口返回的数据里看不到虚拟字段，但 console.log 打印时又有。

javascript
// 方式一：Schema 级别配置
const userSchema = new Schema({
  firstName: String,
  lastName: String
}, {
  toJSON: { virtuals: true },
  toObject: { virtuals: true }
});

// 方式二：单次调用时指定
user.toJSON({ virtuals: true });

如果项目用了 lean()，虚拟字段也会丢失，因为 lean() 返回的是纯 JS 对象而非 Mongoose 文档。

虚拟字段关联（Virtual Populate）

虚拟字段最常见的实战场景是反向关联。比如 Book 引用了 Author，但 Author 模型上想直接拿到所有书籍：

javascript
const authorSchema = new Schema({
  name: String,
  email: String
});

const bookSchema = new Schema({
  title: String,
  author: { type: Schema.Types.ObjectId, ref: 'Author' }
});

// Author 上定义虚拟字段，关联到 Book
authorSchema.virtual('books', {
  ref: 'Book',
  localField: '_id',
  foreignField: 'author'
});

// 查询时 populate
const author = await Author.findById(id).populate('books');
console.log(author.books); // 该作者的所有书籍

关键配置项：

ref：目标模型名
localField：当前模型的字段
foreignField：目标模型的字段
justOne: true：返回单个文档而非数组
match：添加过滤条件

多对多关联同理，只需要在另一端定义虚拟字段指向中间集合即可。

条件虚拟字段

虚拟字段也可以做状态判断，不限于拼接字符串：

javascript
const userSchema = new Schema({
  age: Number,
  deleted: Boolean,
  banned: Boolean
});

userSchema.virtual('isAdult').get(function() {
  return this.age >= 18;
});

userSchema.virtual('status').get(function() {
  if (this.deleted) return 'deleted';
  if (this.banned) return 'banned';
  return 'active';
});

这类虚拟字段在模板渲染或接口返回时特别有用，避免在每个使用的地方重复写判断逻辑。

计算型虚拟字段

聚合或格式化场景：

javascript
// 订单总价
const orderSchema = new Schema({
  items: [{ name: String, price: Number, quantity: Number }]
});

orderSchema.virtual('totalPrice').get(function() {
  return this.items.reduce((sum, item) => sum + item.price * item.quantity, 0);
});

// 年龄计算
const personSchema = new Schema({ birthDate: Date });

personSchema.virtual('age').get(function() {
  if (!this.birthDate) return null;
  const today = new Date();
  const birth = new Date(this.birthDate);
  let age = today.getFullYear() - birth.getFullYear();
  const m = today.getMonth() - birth.getMonth();
  if (m < 0 || (m === 0 && today.getDate() < birth.getDate())) age--;
  return age;
});

注意每次访问都会重新计算，如果计算逻辑重或被频繁调用，考虑缓存或改用实例方法。

虚拟字段的限制与注意事项

不能查询：find()、aggregate() 都不支持虚拟字段作为条件
不能排序：sort() 只能作用于数据库中实际存在的字段
不能建索引：MongoDB 无法对不存在的字段建索引
lean() 丢失：lean() 返回普通对象，虚拟字段不可用
每次访问重新计算：对同一文档多次读取同一虚拟字段会多次执行 getter
populate 需显式调用：虚拟关联不会自动填充，必须手动 .populate()

什么时候该用虚拟字段 vs 实例方法

两者都能在文档上动态计算值，区别在于：

虚拟字段：像属性一样访问 doc.fullName，支持 getter/setter，能参与 toJSON 输出
实例方法：像函数一样调用 doc.getFullName()，逻辑更灵活，但不自动出现在 JSON 输出中

选择依据：如果值像属性（全名、年龄），用虚拟字段；如果逻辑像操作（计算折扣、发送通知），用实例方法。

追问

虚拟字段的 setter 在什么时机执行？setter 设置的值会影响数据库写入吗？
如何在虚拟关联中添加 match 过滤条件？比如只获取已发布的书籍。
lean() 和虚拟字段冲突时有哪些解决思路？
虚拟字段和 Mongoose 的 populate 有什么性能差异？什么情况下虚拟关联更优？
如果需要在聚合管道中实现类似虚拟字段的效果，应该怎么做？

标签：Mongoose