Mongoose Date 类型时间戳陷阱与解决方式

在使用 Mongoose 开发 Node.js 项目时，我们经常会使用 Date 类型来存储时间戳。但是，在使用过程中，我们可能会遇到一些令人困惑的问题。本文将介绍 Date 类型时间戳的陷阱以及解决方式，并提供相关的示例代码，以帮助读者更好地理解和应用。

问题描述

当我们使用 Mongoose 的 Date 类型来存储时间戳时，我们会发现存储的时间会被转化为格林威治时间（GMT）而不是我们所在时区的时间。例如，当我们在北京时间 2022 年 8 月 11 日下午 2 点 30 分插入一个时间戳时，所插入的时间却显示为 2022 年 8 月 11 日上午 6 点 30 分。这是因为格林威治时间比北京时间早了八个小时。

这种情况会给我们带来一些麻烦。比如，当我们在前端或客户端展示时间时，时间会显示错误。这会降低用户体验，影响我们的应用质量。

解决方式

为了解决这个问题，我们需要更改默认时区，并把存储的时间转换为本地时间。下面是两种实现方式。

方式一：使用 Moment.js 库

Moment.js 是一个非常流行的 JavaScript 时间处理库，它可以帮助我们轻松地解决 Date 类型时间戳陷阱的问题。我们可以使用 Moment.js 将时间转换为本地时间并进行格式化。

首先，我们需要安装 Moment.js：

npm install moment

然后，在代码中引入 Moment.js：

const moment = require('moment');

接下来，在创建 Mongoose 模型时，我们可以使用 pre 中间件来实现时间转换：

const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const moment = require('moment');

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

UserSchema.pre('save', function (next) {
  if (this.birthday) {
    this.birthday = moment(this.birthday).format('YYYY-MM-DD HH:mm:ss');
  }
  next();
});

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

在上面的例子中，我们定义了一个 pre 中间件，当保存用户信息前，它会将 birthday 时间转换成本地时间并以格式化后的字符串形式保存。这样，当我们在前端或客户端展示时间时，就可以直接使用获取到的本地时间了。

方式二：使用 Intl.DateTimeFormat

我们还可以使用 Intl.DateTimeFormat 标准库根据浏览器或系统默认的时区（locale）来格式化日期和时间。

const mongoose = require('mongoose');
const Schema = mongoose.Schema;

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

UserSchema.virtual('birthdayFormatted').get(function () {
  return new Intl.DateTimeFormat().format(this.birthday);
});

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

在上面的例子中，我们定义了一个 virtual 属性 birthdayFormatted，当我们需要展示 birthday 时间时，只需要调用这个虚拟属性即可。

示例代码

下面是一个完整的例子，展示了两种方式的实现方法：

const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const moment = require('moment');

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

// 方式一
UserSchema.pre('save', function (next) {
  if (this.birthday) {
    this.birthday = moment(this.birthday).format('YYYY-MM-DD HH:mm:ss');
  }
  next();
});

// 方式二
UserSchema.virtual('birthdayFormatted').get(function () {
  return new Intl.DateTimeFormat().format(this.birthday);
});

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

(async () => {
  mongoose.connect('mongodb://localhost/test', {
    useNewUrlParser: true,
    useUnifiedTopology: true,
  });

  await UserModel.deleteMany();

  await UserModel.create({
    name: 'Alice',
    birthday: new Date('2022-08-11T14:30:00Z'),
  });

  const users = await UserModel.find();

  console.log(users[0].birthday); // 2022-08-11T06:30:00.000Z
  console.log(users[0].birthdayFormatted); // "8/11/2022"
})();

在上面的例子中，我们定义了一个 User 模型，其中包含 name 和 birthday 两个属性，分别用于存储用户姓名和生日。我们创建了两种方式的实现方法，方便读者选择自己喜欢的方式进行实现。最后，我们使用 Mongoose 来创建和查询用户信息，并输出结果。

总结

使用 Mongoose Date 类型存储时间戳时，要注意的 GMT 时间差异问题。为了解决这个问题，我们可以使用 Moment.js 库或者 Intl.DateTimeFormat 标准库中的方法。这样，我们就可以在本地时区中正确格式化日期和时间，避免出现时间显示错误的情况。

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