Mongoose 最佳实践

Mongoose 最佳实践

Mongoose 是 Node.js 中最流行的 MongoDB ODM（对象文档映射）库之一，尤其在 Koa2 项目中广泛使用。它提供了强大的数据建模、验证和查询功能，帮助开发者更高效地与 MongoDB 交互。以下是一些 Mongoose 的最佳实践，涵盖从模型定义到查询优化的各个方面。

模型定义与 Schema 设计

定义模型时，Schema 的设计是关键。合理的 Schema 设计不仅能提高查询效率，还能减少数据冗余。以下是一个用户模型的示例：

const mongoose = require('mongoose');
const { Schema } = mongoose;

const userSchema = new Schema({
  username: {
    type: String,
    required: true,
    unique: true,
    trim: true,
    minlength: 3,
    maxlength: 30
  },
  email: {
    type: String,
    required: true,
    unique: true,
    match: /^\S+@\S+\.\S+$/
  },
  password: {
    type: String,
    required: true,
    minlength: 6
  },
  role: {
    type: String,
    enum: ['user', 'admin'],
    default: 'user'
  },
  createdAt: {
    type: Date,
    default: Date.now
  },
  updatedAt: {
    type: Date,
    default: Date.now
  }
});

// 添加更新时间戳的中间件
userSchema.pre('save', function(next) {
  this.updatedAt = Date.now();
  next();
});

const User = mongoose.model('User', userSchema);
module.exports = User;

在这个例子中，我们为 username 和 email 添加了唯一性约束，并使用正则表达式验证邮箱格式。role 字段使用了枚举值限制，确保只有预定义的角色可以被赋值。createdAt 和 updatedAt 字段则用于记录文档的创建和更新时间。

中间件的使用

Mongoose 中间件（也称为钩子）可以在执行某些操作前后插入自定义逻辑。常见的中间件包括 pre 和 post 钩子。以下是一个密码加密的中间件示例：

const bcrypt = require('bcryptjs');

userSchema.pre('save', async function(next) {
  if (!this.isModified('password')) return next();
  
  try {
    const salt = await bcrypt.genSalt(10);
    this.password = await bcrypt.hash(this.password, salt);
    next();
  } catch (err) {
    next(err);
  }
});

这个中间件会在保存用户文档前检查密码是否被修改。如果密码被修改，则使用 bcrypt 对其进行加密。这样可以确保密码始终以加密形式存储。

查询优化

Mongoose 提供了多种查询优化手段，以下是一些常见的技巧：

1. 使用 select 限制返回字段：避免返回不必要的字段可以减少网络传输和内存占用。

   User.findById(userId).select('username email role');
   

2. 使用 lean 提高性能：lean 返回普通的 JavaScript 对象而非 Mongoose 文档，可以减少内存占用和提高性能。

   User.find().lean();
   

3. 合理使用索引：为经常查询的字段添加索引可以显著提高查询速度。

   userSchema.index({ username: 1, email: 1 });
   

4. 批量操作：使用 insertMany、updateMany 或 bulkWrite 进行批量操作比单条操作更高效。

   User.insertMany([user1, user2, user3]);
   

错误处理

Mongoose 的错误处理是开发中不可忽视的部分。以下是一个常见的错误处理模式：

app.use(async (ctx, next) => {
  try {
    await next();
  } catch (err) {
    if (err.name === 'ValidationError') {
      ctx.status = 400;
      ctx.body = { error: err.message };
    } else if (err.code === 11000) {
      ctx.status = 409;
      ctx.body = { error: 'Duplicate key error' };
    } else {
      ctx.status = 500;
      ctx.body = { error: 'Internal server error' };
    }
  }
});

在这个例子中，我们捕获了 Mongoose 的验证错误和唯一键冲突错误，并返回适当的 HTTP 状态码和错误信息。其他错误则统一返回 500 状态码。

事务支持

MongoDB 4.0 及以上版本支持事务，Mongoose 也提供了相应的 API。以下是一个事务的示例：

const session = await mongoose.startSession();
session.startTransaction();

try {
  const user = await User.create([{ username: 'john', email: 'john@example.com' }], { session });
  await Profile.create([{ userId: user[0]._id, bio: 'Hello world' }], { session });
  await session.commitTransaction();
} catch (err) {
  await session.abortTransaction();
  throw err;
} finally {
  session.endSession();
}

事务可以确保多个操作要么全部成功，要么全部失败。这在需要保证数据一致性的场景中非常有用。

虚拟字段与实例方法

虚拟字段和实例方法可以扩展模型的功能。以下是一个虚拟字段和实例方法的示例：

userSchema.virtual('fullName').get(function() {
  return `${this.firstName} ${this.lastName}`;
});

userSchema.methods.comparePassword = async function(candidatePassword) {
  return await bcrypt.compare(candidatePassword, this.password);
};

虚拟字段 fullName 不会存储到数据库中，但可以通过 user.fullName 访问。实例方法 comparePassword 则用于比较用户输入的密码和数据库中存储的加密密码。

聚合管道

Mongoose 支持 MongoDB 的聚合管道，可以用于复杂的数据分析和转换。以下是一个聚合管道的示例：

const result = await User.aggregate([
  { $match: { role: 'user' } },
  { $group: { _id: '$role', count: { $sum: 1 } } }
]);

这个聚合管道会统计所有角色为 user 的文档数量。聚合管道非常灵活，可以用于实现复杂的数据处理逻辑。

性能监控与调试

Mongoose 提供了调试和性能监控的功能。可以通过以下方式启用调试日志：

mongoose.set('debug', true);

此外，可以使用 mongoose.set('debug', (collectionName, method, query, doc) => { ... }) 自定义调试输出。这对于性能调优和问题排查非常有帮助。

连接管理与配置

合理的连接管理可以提高应用的稳定性和性能。以下是一个推荐的连接配置：

const options = {
  useNewUrlParser: true,
  useUnifiedTopology: true,
  poolSize: 10,
  connectTimeoutMS: 5000,
  socketTimeoutMS: 45000
};

mongoose.connect(process.env.MONGODB_URI, options)
  .then(() => console.log('MongoDB connected'))
  .catch(err => console.error('MongoDB connection error:', err));

在这个配置中，我们设置了连接池大小、连接超时和套接字超时等参数。这些参数可以根据实际需求进行调整。

插件系统

Mongoose 的插件系统允许我们复用通用的功能。以下是一个自动生成 slug 的插件示例：

function slugPlugin(schema, options) {
  schema.add({ slug: String });
  
  schema.pre('save', function(next) {
    if (this.isModified('title')) {
      this.slug = this.title.toLowerCase().replace(/\s+/g, '-');
    }
    next();
  });
}

const articleSchema = new Schema({ title: String });
articleSchema.plugin(slugPlugin);

这个插件会自动根据 title 字段生成 slug 字段。插件可以显著减少重复代码，提高开发效率。