如何在 Sequelize 中使用 Hooks 进行自动时间戳记录？-JavaScript中文网-JavaScript教程资源分享门户

Sequelize 是一个强大的 Node.js ORM 库，它可以帮助我们更轻松地操作数据库。在实际的项目中，自动记录数据的创建时间和更新时间非常常见，因此在 Sequelize 中使用 Hooks 进行自动时间戳记录是一项非常重要的技能。

Hooks 简介

Hooks 是 Sequelize 中预定义的钩子函数，通过在不同的钩子点处添加相应的方法，可以对不同的事件进行监听和相应处理。Sequelize 钩子主要分为两种类型：实例或者模型级别的钩子。

实例级别钩子：是在单个记录初次创建或更新时调用的钩子。例如，保存记录前、保存记录后、验证单个记录时。
模型级别钩子：是在模型本身创建或更新时调用的钩子。例如，创建模型时、初始化模型时等。

自动时间戳记录的使用场景

在实际的开发中，数据在创建和更新时需要记录相应的时间信息。例如：订单的创建时间、修改时间等。手动进行时间戳的记录是比较繁琐的，而且容易出现错误。因此，引入 Sequelize Hooks 可以帮助我们自动地进行时间戳的记录。

使用 Sequelize Hooks 自动记录时间戳

Sequelize 允许我们很容易地在模型层面中定义钩子。利用实例级别钩子，可以在每次保存模型实例时自动记录创建时间和更新时间。在模型定义时，可以定义一个 beforeCreate 和 beforeUpdate 的钩子，用于在实例保存之前添加我们要实现的行为。

我们定义一个样例 User 模型：

// javascriptcn.com 代码示例
const { Sequelize, Model } = require('sequelize');
const sequelize = require('./db');

class User extends Model {}

User.init({
  username: Sequelize.STRING,
  email: Sequelize.STRING,
  password: Sequelize.STRING,
}, {
  sequelize,
  modelName: 'users',
});

User.beforeCreate(user => user.createdAt = new Date());
User.beforeUpdate(user => user.updatedAt = new Date());

module.exports = User;

在定义了 User 模型之后，我们通过 beforeCreate 和 beforeUpdate 钩子来动态地添加 createdAt 和 updatedAt 字段。

beforeCreate 钩子会在将记录插入数据库之前被调用。在这里，我们可以实现创建时间自动记录的功能，并将创建时间赋值给 createdAt 字段。

beforeUpdate 钩子在更新记录之前被调用，我们可以在这里实现更新时间自动记录的功能，并将更新时间赋值给 updatedAt 字段。

应用示例

我们以一个 GET/POST 服务器端接口为例来演示如何在 Sequelize 中使用 Hooks 进行自动时间戳记录：

定义 User.js 模型：

// javascriptcn.com 代码示例
const { Sequelize, Model } = require('sequelize');
const sequelize = require('./db');

class User extends Model {}

User.init({
  username: Sequelize.STRING,
  email: Sequelize.STRING,
  password: Sequelize.STRING,
}, {
  sequelize,
  modelName: 'users',
});

User.beforeCreate(user => user.createdAt = new Date());
User.beforeUpdate(user => user.updatedAt = new Date());

module.exports = User;

定义 GET/POST 接口：

// javascriptcn.com 代码示例
const express = require('express');
const bodyParser = require('body-parser');
const User = require('./models/User');

const app = express();

// 配置 bodyParser 中间件
app.use(bodyParser.urlencoded({ extended: false }));
app.use(bodyParser.json());

// 获取所有用户列表
app.get('/users', async (req, res) => {
  const users = await User.findAll();
  res.json(users);
});

// 创建新的用户
app.post('/users', async (req, res) => {
  const user = await User.create(req.body);
  res.json(user);
});

const port = 3000;
app.listen(port, () => console.log(`Server is running on port ${port}.`));

当我们新建一个用户时，createdAt 字段会自动填充为当前时间：

POST /users
{
  "username": "Tom",
  "email": "tom@example.com",
  "password": "password"
}

{
  "id": 1,
  "username": "Tom",
  "email": "tom@example.com",
  "password": "password",
  "createdAt": "2021-06-01T03:03:01.794Z",
  "updatedAt": "2021-06-01T03:03:01.794Z"
}

当我们更新这条用户记录时，updatedAt 字段会自动更新为当前时间：

PATCH /users/1
{
  "username": "TomUpdates",
  "email": "tom@example.com",
  "password": "newpassword"
}

{
  "id": 1,
  "username": "TomUpdates",
  "email": "tom@example.com",
  "password": "newpassword",
  "createdAt": "2021-06-01T03:03:01.794Z",
  "updatedAt": "2021-06-01T03:06:56.705Z"
}

以上就是在 Sequelize 中使用 Hooks 进行自动时间戳记录的例子。通过这种方式，我们可以轻松地自动记录数据的创建时间和更新时间，从而减少手动记录的麻烦。

总结

在本文中，我们介绍了 Sequelize Hooks 的使用方法，并且演示了如何在 Sequelize 中使用 Hooks 自动记录时间戳。通过使用 Hooks，我们可以更加方便、高效地实现自动化的行为，并且可以显著地提升开发效率。希望本文对读者有所启发，让大家更好地应用 Sequelize，提高开发效率和代码质量。

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