Mongoose虚拟属性(Virtuals)深度解析与应用指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00498/article/details/148360881

Mongoose虚拟属性(Virtuals)深度解析与应用指南

mongoose Automattic/mongoose: Mongoose 是一个流行的Node.js对象数据映射（ODM）库，专为MongoDB设计，能够简化在Node.js中使用MongoDB数据库的操作，提供了丰富的查询构建、模型定义、数据验证等特性。项目地址: https://gitcode.com/gh_mirrors/mo/mongoose

什么是Mongoose虚拟属性？

虚拟属性(Virtuals)是Mongoose中一个非常有用的特性，它允许你在文档上定义不实际存储在MongoDB中的属性。这些属性在运行时通过计算或其他方式生成，为数据模型提供了额外的灵活性。

虚拟属性的核心特性

不持久化存储：虚拟属性不会写入数据库
计算属性：常用于基于已有字段的派生属性
灵活访问：可以像普通属性一样访问

创建第一个虚拟属性

让我们从一个典型示例开始：用户模型中基于email提取域名。

const userSchema = new mongoose.Schema({
  email: String
});

// 创建虚拟属性
userSchema.virtual('domain').get(function() {
  return this.email.slice(this.email.indexOf('@') + 1);
});

const User = mongoose.model('User', userSchema);
const doc = new User({ email: 'test@gmail.com' });

doc.domain; // 'gmail.com'

在这个例子中，我们定义了一个domain虚拟属性，它会自动从email字段中提取域名部分。

虚拟属性的Getter和Setter

虚拟属性不仅支持getter，还支持setter，这使得它们可以用于双向数据转换。

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

const user = new User();
user.fullName = 'John Doe'; // 自动设置firstName和lastName
console.log(user.firstName); // 'John'
console.log(user.lastName); // 'Doe'

虚拟属性与JSON输出

默认情况下，虚拟属性不会包含在JSON输出中。要包含它们，需要配置schema选项：

const userSchema = new mongoose.Schema({
  // 字段定义
}, {
  toJSON: { virtuals: true },
  toObject: { virtuals: true }
});

虚拟属性与Lean查询

当使用lean()进行查询优化时，返回的是普通JavaScript对象而非Mongoose文档，因此虚拟属性不可用。解决方案是使用mongoose-lean-virtuals插件：

const mongooseLeanVirtuals = require('mongoose-lean-virtuals');
userSchema.plugin(mongooseLeanVirtuals);

const users = await User.find().lean();
users[0].domain; // 现在可以访问虚拟属性

虚拟属性的局限性

不可查询：不能基于虚拟属性进行数据库查询
不参与验证：虚拟属性不受schema验证规则约束
不持久化：只在文档实例中存在

虚拟填充(Populate)

Mongoose支持虚拟填充，这是一种强大的关联数据加载机制：

const userSchema = new mongoose.Schema({
  _id: Number,
  name: String
});

const postSchema = new mongoose.Schema({
  title: String,
  author: { type: Number, ref: 'User' }
});

postSchema.virtual('authorInfo', {
  ref: 'User',
  localField: 'author',
  foreignField: '_id',
  justOne: true
});

const Post = mongoose.model('Post', postSchema);
const post = await Post.findOne().populate('authorInfo');