Sequelize 中 Model 配合 Sequelize 作 ORM 时的一些注意事项

前言

在 Node.js 的开发中，ORM 是一个非常重要的概念。ORM 的全称是 Object Relational Mapping，即对象关系映射。ORM 把数据库中的表映射成对象，使得开发者可以像操作对象一样操作数据库，简化了开发流程，提高了开发效率。

Sequelize 是 Node.js 中比较常用的 ORM 工具之一，它支持多种数据库，如 MySQL、PostgreSQL、SQLite 等。本文将介绍在使用 Sequelize 时 Model 的一些注意事项。

Model 是什么？

在 Sequelize 中，Model 是指对应数据库中某个表的映射对象。Model 中定义了表的字段、数据类型、索引、关联关系等信息，可以通过 Model 对象进行增删改查等操作。

Model 的定义

定义 Model 需要使用 Sequelize.define 方法，该方法的参数包括 Model 名称、字段定义、表选项等。以下是一个示例：

// www.javascriptcn.com code example
const { Sequelize, DataTypes } = require('sequelize');
const sequelize = new Sequelize('mysql://user:password@localhost:3306/database');
const User = sequelize.define('User', {
  id: {
    type: DataTypes.INTEGER,
    primaryKey: true,
    autoIncrement: true
  },
  name: {
    type: DataTypes.STRING(20),
    allowNull: false
  },
  age: {
    type: DataTypes.INTEGER,
    allowNull: false,
    defaultValue: 0
  }
}, {
  tableName: 'user',
  timestamps: false
});

上述代码中，定义了一个名为 User 的 Model，对应数据库中的 user 表。该表有三个字段：id、name、age。其中，id 是主键，自增；name 和 age 都是必填项，age 的默认值是 0。表选项中关闭了 Sequelize 自动生成的 createdAt 和 updatedAt 字段。

Model 的关联

在 Sequelize 中，Model 之间可以建立关联关系。常见的关联关系有一对一、一对多、多对多等。以下是一个示例：

// www.javascriptcn.com code example
const { Sequelize, DataTypes } = require('sequelize');
const sequelize = new Sequelize('mysql://user:password@localhost:3306/database');
const User = sequelize.define('User', {
  id: {
    type: DataTypes.INTEGER,
    primaryKey: true,
    autoIncrement: true
  },
  name: {
    type: DataTypes.STRING(20),
    allowNull: false
  },
  age: {
    type: DataTypes.INTEGER,
    allowNull: false,
    defaultValue: 0
  }
}, {
  tableName: 'user',
  timestamps: false
});

const Post = sequelize.define('Post', {
  id: {
    type: DataTypes.INTEGER,
    primaryKey: true,
    autoIncrement: true
  },
  title: {
    type: DataTypes.STRING(50),
    allowNull: false
  },
  content: {
    type: DataTypes.TEXT,
    allowNull: false
  }
}, {
  tableName: 'post',
  timestamps: false
});

User.hasMany(Post, { foreignKey: 'userId' });
Post.belongsTo(User, { foreignKey: 'userId' });

上述代码中，定义了两个 Model：User 和 Post，分别对应数据库中的 user 表和 post 表。其中，User 和 Post 之间建立了一对多的关联关系，即一个用户可以写多篇文章。User.hasMany(Post) 表示 User 拥有多个 Post，Post.belongsTo(User) 表示 Post 属于一个 User。在建立关联关系时，需要指定外键，这里指定的是 post 表中的 userId 字段。

Model 的查询

在 Sequelize 中，可以使用 Model 的一些方法进行查询。常见的方法有 findAll、findOne、findById 等。以下是一些示例：

// www.javascriptcn.com code example
// 查询所有用户
const users = await User.findAll();

// 查询名称为张三的用户
const user = await User.findOne({ where: { name: '张三' } });

// 根据 id 查询用户
const user = await User.findByPk(id);

// 查询一个用户及其所有文章
const user = await User.findOne({
  where: { id },
  include: [ Post ]
});

// 查询所有用户及其所有文章
const users = await User.findAll({
  include: [ Post ]
});

上述代码中，使用了 Sequelize 提供的一些方法进行查询。其中，include 参数可以用来指定要查询的关联 Model。

注意事项

在使用 Sequelize 时，需要注意以下几点：

1. Sequelize 中的 Model 名称默认为复数形式，如 User 对应数据库中的 users 表。可以通过表选项中的 tableName 参数来指定表名。

2. Sequelize 中的 Model 的字段名默认为驼峰式，如 userName 对应数据库中的 user_name 字段。可以通过字段选项中的 field 参数来指定字段名。

3. 在定义 Model 时，需要注意字段类型和选项的设置，特别是 allowNull 和 defaultValue 等。

4. 在建立关联关系时，需要指定外键，同时需要注意外键的类型和选项的设置。

5. 在查询时，需要注意 include 参数的使用，以便查询关联 Model。

结语

Sequelize 是一个非常强大的 ORM 工具，可以大大简化 Node.js 中的数据库操作。本文介绍了在使用 Sequelize 时 Model 的一些注意事项，希望对大家有所帮助。

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