在 Sequelize 中如何创建自定义方法-JavaScript中文网-JavaScript教程资源分享门户

Sequelize 是一款 Node.js 的 ORM 框架，提供了许多方便、高效的操作数据库的 API，同时也支持我们在模型中自定义方法以满足实际的业务需求。本文将详细介绍如何在 Sequelize 中创建自定义方法，并为读者提供实用的示例代码。

什么是 Sequelize？

Sequelize 是一款基于 Promise 的 Node.js ORM（Object-Relational Mapping）框架，它支持 PostgreSQL、MySQL、MariaDB、SQLite、Microsoft SQL Server 和 Oracle 等多种数据库。通过 Sequelize，我们可以使用 JavaScript 语言操作数据库，而不是编写 SQL 语句。Sequelize 提供了多种功能，包括利用模型（model）操作数据库、数据验证、查询构建、关联表关系等等。

Sequelize model

Sequelize 的核心概念是 model，model 是我们在 Sequelize 中操作数据库的主要封装。Sequelize model 代表了我们要操作的数据库表，在 model 中声明了数据表中字段的属性、默认值、限制条件等等。例如：

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

class User extends Model {}
User.init({
  // attributes
  firstName: {
    type: DataTypes.STRING,
    allowNull: false
  },
  lastName: {
    type: DataTypes.STRING
    // allowNull 默认为 true
  }
}, {
  sequelize,
  modelName: 'User'
  // options
});

上面的代码中，我们定义了一个 User model，该 model 对应了一个数据表，包含了两个字段：firstName 和 lastName。Sequelize 提供了多种数据类型，例如 STRING、INTEGER、DATE、JSONB、ENUM 等等，使用时需要根据实际情况进行选择。

在 Sequelize model 中创建自定义方法

除了使用 Sequelize 原有的 API 操作数据库，Sequelize 也支持我们在 model 中创建自定义方法。这些自定义方法可以满足实际的业务需求，让我们的代码更加简洁、高效。

在 Sequelize 中创建自定义方法可以有多种方式，下面我们将逐一进行介绍。

1. 直接在 model 上添加方法

我们可以直接在 model 实例上添加方法。例如：

// 在 User model 上添加一个自定义方法 fullName
User.prototype.fullName = function() {
  return this.firstName + ' ' + this.lastName;
}

const user = User.build({ firstName: 'Tom', lastName: 'Hanks' });
console.log(user.fullName()); // 'Tom Hanks'

在上面的代码中，我们在 User model 上添加了一个 fullName 方法，并且在 model 实例上调用该方法输出了用户的全名。

2. 使用 Sequelize 定义

在 Sequelize 中，我们也可以使用 define 方法定义模型，并使用 instanceMethods 属性定义模型的实例方法。例如：

// javascriptcn.com 代码示例
// 使用 Sequelize 定义 User model
const User = sequelize.define('User', {
  firstName: {
    type: DataTypes.STRING,
    allowNull: false
  },
  lastName: {
    type: DataTypes.STRING
    // allowNull 默认为 true
  }
}, {
  instanceMethods: {
    fullName() {
      return this.firstName + ' ' + this.lastName;
    }
  }
});

const user = User.build({ firstName: 'Tom', lastName: 'Hanks' });
console.log(user.fullName()); // 'Tom Hanks'

在上面的代码中，我们使用 Sequelize 的 define 方法定义了 User model，并使用 instanceMethods 定义了一个 fullName 方法。

3. 使用 Sequelize classMethod 和 instanceMethod

在 Sequelize 中，我们也可以使用 classMethod 和 instanceMethod 分别定义类方法和实例方法。例如：

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

class User extends Model {
  fullName() {
    return this.firstName + ' ' + this.lastName;
  }

  static async countAllUsers() {
    const users = await this.findAll();
    return users.length;
  }
}

User.init({
  // attributes
  firstName: {
    type: DataTypes.STRING,
    allowNull: false
  },
  lastName: {
    type: DataTypes.STRING
    // allowNull 默认为 true
  }
}, {
  sequelize,
  modelName: 'User'
  // options
});

(async () => {
  const user = User.build({ firstName: 'Tom', lastName: 'Hanks' });
  console.log(user.fullName()); // 'Tom Hanks'

  const count = await User.countAllUsers();
  console.log(count); // 输出用户数量
})();

在上面的代码中，我们在 User class 上分别定义了 fullName 和 countAllUsers 方法，在使用时可以通过 User.fullName 或 User.countAllUsers 来调用。

总结

通过上面的介绍，我们学习了在 Sequelize 中如何创建自定义方法，并提供了多种实用的示例代码。Sequelize 提供了多种方法来满足实际的业务需求，让我们的代码更加简洁、高效。

在实际开发中，我们应该根据实际情况选择不同的方法。有了自定义方法，我们可以更加灵活、高效地操作数据库，提高开发效率。

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