Mongoose 中的 hook 函数使用教程-FunTeaLearn Online Web Tutorials

Mongoose 是一个 Node.js 的 ODM（Object Document Mapping）库，它提供了一种方便的方式来操作 MongoDB 数据库。其中，Hook 函数是 Mongoose 中非常重要的一个功能，它可以在执行数据库操作之前或之后执行一些自定义的代码，以满足特定的业务需求。本文将介绍 Mongoose 中 Hook 函数的使用方法，包括常用的类型、使用场景、示例代码以及相关注意事项。

Hook 函数类型

Mongoose 中的 Hook 函数分为两种类型：pre 和 post。其中，pre Hook 函数会在执行数据库操作之前被调用，而 post Hook 函数会在执行数据库操作之后被调用。这两种 Hook 函数都可以在 Model 和 Document 层面上使用。

Model 中的 Hook 函数

在 Model 中使用 Hook 函数时，它们会被应用到所有执行该 Model 的数据库操作上。下面是 Model 中常用的 Hook 函数类型：

init: 当 Model 实例被初始化时被调用。
validate: 在执行 Model 实例的 validate 方法之前被调用。
save: 在执行 Model 实例的 save 方法之前被调用。
remove: 在执行 Model 实例的 remove 方法之前被调用。

Document 中的 Hook 函数

在 Document 中使用 Hook 函数时，它们只会被应用到当前实例的数据库操作上。下面是 Document 中常用的 Hook 函数类型：

init: 当 Document 实例被初始化时被调用。
validate: 在执行 Document 实例的 validate 方法之前被调用。
save: 在执行 Document 实例的 save 方法之前被调用。
remove: 在执行 Document 实例的 remove 方法之前被调用。

Hook 函数使用场景

Hook 函数可以用于各种场景，如数据验证、自动填充、数据处理、日志记录等。下面是一些常见的使用场景：

数据验证

Hook 函数可以在执行数据库操作之前对数据进行验证，以确保数据的完整性和有效性。例如，可以使用 pre('save') Hook 函数在保存 Document 实例之前验证数据：

// www.javascriptcn.com code example
const userSchema = new mongoose.Schema({
  name: { type: String, required: true },
  email: { type: String, required: true, unique: true },
  password: { type: String, required: true },
});

userSchema.pre('save', function (next) {
  if (!this.isModified('password')) {
    return next();
  }

  bcrypt.genSalt(10, (err, salt) => {
    if (err) {
      return next(err);
    }

    bcrypt.hash(this.password, salt, (err, hash) => {
      if (err) {
        return next(err);
      }

      this.password = hash;
      next();
    });
  });
});

上述代码中，使用 pre('save') Hook 函数对用户密码进行加密，以确保密码的安全性。

自动填充

Hook 函数可以在执行数据库操作之前自动填充一些字段，以减少代码冗余和提高开发效率。例如，可以使用 pre('save') Hook 函数在保存 Document 实例之前自动填充创建时间和更新时间：

// www.javascriptcn.com code example
const userSchema = new mongoose.Schema({
  name: { type: String, required: true },
  email: { type: String, required: true, unique: true },
  password: { type: String, required: true },
  createdAt: { type: Date },
  updatedAt: { type: Date },
});

userSchema.pre('save', function (next) {
  const now = new Date();

  if (!this.createdAt) {
    this.createdAt = now;
  }

  this.updatedAt = now;
  next();
});

上述代码中，使用 pre('save') Hook 函数自动填充创建时间和更新时间。

数据处理

Hook 函数可以在执行数据库操作之前对数据进行处理，以满足特定的业务需求。例如，可以使用 pre('remove') Hook 函数在删除 Document 实例之前删除其关联的数据：

// www.javascriptcn.com code example
const userSchema = new mongoose.Schema({
  name: { type: String, required: true },
  email: { type: String, required: true, unique: true },
  password: { type: String, required: true },
});

userSchema.pre('remove', function (next) {
  const userId = this._id;

  Post.deleteMany({ author: userId }, (err) => {
    if (err) {
      return next(err);
    }

    next();
  });
});

上述代码中，使用 pre('remove') Hook 函数删除用户关联的文章。

日志记录

Hook 函数可以在执行数据库操作之前或之后记录日志，以便于排查问题和分析数据。例如，可以使用 post('save') Hook 函数在保存 Document 实例之后记录日志：

// www.javascriptcn.com code example
const userSchema = new mongoose.Schema({
  name: { type: String, required: true },
  email: { type: String, required: true, unique: true },
  password: { type: String, required: true },
});

userSchema.post('save', function (doc) {
  console.log(`User "${doc.name}" saved.`);
});

上述代码中，使用 post('save') Hook 函数记录用户保存操作的日志。

Hook 函数示例代码

下面是一些常见的 Hook 函数示例代码：

`pre('validate')`

// www.javascriptcn.com code example
const userSchema = new mongoose.Schema({
  name: { type: String, required: true },
  email: { type: String, required: true, unique: true },
  password: { type: String, required: true },
});

userSchema.pre('validate', function (next) {
  if (!this.name) {
    this.name = 'Anonymous';
  }

  next();
});

上述代码中，使用 pre('validate') Hook 函数自动填充用户名称为 'Anonymous'。

`pre('save')`

// www.javascriptcn.com code example
const userSchema = new mongoose.Schema({
  name: { type: String, required: true },
  email: { type: String, required: true, unique: true },
  password: { type: String, required: true },
});

userSchema.pre('save', function (next) {
  if (!this.isModified('password')) {
    return next();
  }

  bcrypt.genSalt(10, (err, salt) => {
    if (err) {
      return next(err);
    }

    bcrypt.hash(this.password, salt, (err, hash) => {
      if (err) {
        return next(err);
      }

      this.password = hash;
      next();
    });
  });
});

上述代码中，使用 pre('save') Hook 函数对用户密码进行加密。

`pre('remove')`

// www.javascriptcn.com code example
const userSchema = new mongoose.Schema({
  name: { type: String, required: true },
  email: { type: String, required: true, unique: true },
  password: { type: String, required: true },
});

userSchema.pre('remove', function (next) {
  const userId = this._id;

  Post.deleteMany({ author: userId }, (err) => {
    if (err) {
      return next(err);
    }

    next();
  });
});

上述代码中，使用 pre('remove') Hook 函数删除用户关联的文章。

`post('save')`

// www.javascriptcn.com code example
const userSchema = new mongoose.Schema({
  name: { type: String, required: true },
  email: { type: String, required: true, unique: true },
  password: { type: String, required: true },
});

userSchema.post('save', function (doc) {
  console.log(`User "${doc.name}" saved.`);
});

上述代码中，使用 post('save') Hook 函数记录用户保存操作的日志。

注意事项

在使用 Hook 函数时，需要注意以下几点：

Hook 函数必须使用 function 关键字定义，不能使用箭头函数。
Hook 函数中的 this 关键字指向当前 Model 或 Document 实例。
Hook 函数必须调用 next() 方法才能继续执行后续的数据库操作。
Hook 函数中的错误必须通过 next(err) 方法传递给下一个中间件或错误处理函数。

结论

Hook 函数是 Mongoose 中非常重要的一个功能，它可以在执行数据库操作之前或之后执行一些自定义的代码，以满足特定的业务需求。本文介绍了 Mongoose 中 Hook 函数的使用方法和常见的使用场景，并提供了示例代码和注意事项。希望本文能够对读者在开发 Node.js 应用时使用 Mongoose 有所帮助。

Source: FunTeaLearn,Please indicate the source for reprints https://funteas.com/post/677a5f0a5c5a933a3414d520

Mongoose 中的 hook 函数使用教程