Mongoose 中使用 mongoose-timestamp 插件自动添加创建和更新时间戳

介绍

Mongoose 是一个 Node.js 上的 MongoDB ODM（对象文档映射）库，它提供了许多便于操作 MongoDB 数据库的功能，使得开发者可以更加方便地进行 CRUD 操作。

mongoose-timestamp 是一个 Mongoose 插件，它可以自动为模型添加创建和更新时间戳。在模型保存时，插件会自动更新创建和更新时间戳字段的值。这个插件非常适合需要记录创建和更新时间的应用程序。

安装

在使用 mongoose-timestamp 插件之前，需要先安装 Mongoose：

npm install mongoose

然后，再安装 mongoose-timestamp 插件：

npm install mongoose-timestamp

使用

要使用 mongoose-timestamp 插件，只需要在定义 Mongoose 模型时引入该插件即可：

// javascriptcn.com 代码示例
const mongoose = require('mongoose');
const timestamp = require('mongoose-timestamp');

const Schema = mongoose.Schema;

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

UserSchema.plugin(timestamp);

const User = mongoose.model('User', UserSchema);

module.exports = User;

在上面的例子中，我们定义了一个 User 模型，并引入了 mongoose-timestamp 插件。这个插件会自动为 User 模型添加 createdAt 和 updatedAt 字段，并在保存时自动更新这两个字段的值。

现在，我们可以创建一个 User 实例并保存到数据库中：

// javascriptcn.com 代码示例
const User = require('./user');

const user = new User({
  name: 'John Doe',
  email: 'john@example.com',
});

user.save((err) => {
  if (err) {
    console.error(err);
  } else {
    console.log('User saved successfully');
  }
});

当我们保存这个 user 实例时，mongoose-timestamp 插件会自动为其添加 createdAt 和 updatedAt 字段，并更新它们的值。如果我们再次保存这个 user 实例，updatedAt 字段的值也会被更新。

配置

mongoose-timestamp 插件提供了一些配置选项，可以用来定制时间戳字段的名称和类型。例如：

// javascriptcn.com 代码示例
const timestamp = require('mongoose-timestamp');

const options = {
  createdAt: 'created_at',
  updatedAt: 'updated_at',
  currentTime: () => Math.floor(Date.now() / 1000),
};

UserSchema.plugin(timestamp, options);

在上面的例子中，我们将 createdAt 和 updatedAt 字段的名称分别修改为 created_at 和 updated_at，并将 currentTime 函数修改为返回以秒为单位的时间戳。

总结

使用 mongoose-timestamp 插件可以轻松地为 Mongoose 模型添加创建和更新时间戳。在实际开发中，这个插件非常有用，可以帮助我们更好地追踪数据的变化。同时，该插件的配置选项也可以根据实际需求进行自定义，使得时间戳字段更加符合业务逻辑。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/6566aa2ad2f5e1655dfa7280