使用Sequelize框架轻松实现ORM映射 - 完整教程

一、什么是ORM映射

ORM(Object-Relational Mapping，即对象关系映射)将关系数据库的表结构映射到对象上，通过操作对象来操作数据库，避免了直接对数据库进行操作造成的复杂度，提高了程序的可维护性和可读性。

二、为什么要使用Sequelize框架

Sequelize是一个基于Node.js的ORM框架，支持MySQL、MariaDB、PostgreSQL、SQLite和Microsoft SQL Server等多种关系型数据库，并且还支持事务、关联查询、预加载等高级查询功能。

具体来说，使用Sequelize框架可以：

1、提高开发效率：使用ORM可以减少代码量、提高开发效率；

2、提高可维护性：ORM相对于直接操作数据库，代码可读性与可维护性更高；

3、降低出错率：ORM自带的SQL注入检测和防范等机制可以降低出错率；

4、支持多数据库：Sequelize支持多种数据库，使用起来更灵活方便。

三、如何使用Sequelize框架实现ORM映射

1. 安装Sequelize

首先需要安装Sequelize：

npm install --save sequelize

2. 连接数据库

使用Sequelize连接数据库需要先定义一个sequelize实例：

const { Sequelize } = require('sequelize');

const sequelize = new Sequelize('database', 'username', 'password', {
  host: 'localhost',
  dialect: 'mysql'
});

其中，第一个参数是数据库名，第二个参数是数据库用户名，第三个参数是数据库密码，第四个参数是数据库服务器的地址。

最后一个参数是数据库使用的方言，Sequelize支持MySQL、MariaDB、PostgreSQL、SQLite和Microsoft SQL Server等多种关系型数据库。如果使用MySQL，那么使用mysql作为方言；

3. 定义模型

接下来需要定义模型，模型相当于是实体，Sequelize可以将模型和数据库中的表进行映射，操作模型就相当于对数据库进行操作。

定义一个User模型，对应数据库中的users表：

const { DataTypes } = require('sequelize');

const User = sequelize.define('User', {
  // 在此定义模型属性
  id: {
    type: DataTypes.INTEGER,
    allowNull: false,
    primaryKey: true,
    autoIncrement: true
  },
  username: {
    type: DataTypes.STRING,
    allowNull: false
  },
  password: {
    type: DataTypes.STRING,
    allowNull: false
  },
  email: {
    type: DataTypes.STRING(100),
    allowNull: false,
    unique: true
  }
}, {
  // 模型选项
});

其中，sequelize.define()方法用于定义模型，第一个参数是模型名，第二个参数是模型属性，对应到数据库中的字段。

在定义模型属性时，需要指定数据类型，允许为空、是否是主键、是否自增等选项。

4. 同步模型到数据库

定义完模型之后，需要将模型同步到数据库，创建对应的表：

async function syncTable() {
  try {
    await sequelize.authenticate();
    await User.sync({ force: true });
    console.log('The table for the User model was just (re)created!');
  } catch (error) {
    console.error('Unable to connect to the database:', error);
  }
}

syncTable();

sequelize.authenticate()用于测试数据库连接是否成功，User.sync()用于同步模型到数据库中创建表。force:true选项用于每次同步都重新创建表，如果不需要每次都重新创建则可以省略该选项，但需要注意不要对表结构进行更新。

5. 对数据库进行操作

使用Sequelize框架进行数据库操作时，可以直接操作模型进行CRUD操作。

5.1 新增数据

async function addUser() {
  try {
    const user = await User.create({
      username: 'admin',
      password: '123456',
      email: 'admin@example.com'
    });
    console.log(user.toJSON());
  } catch (error) {
    console.error(error);
  }
}

addUser();

新增数据使用模型的create()方法，传入要新增的数据。

5.2 查询数据

查询数据使用模型的findAll()方法：

async function getUsers() {
  try {
    const users = await User.findAll();
    console.log(users.map(u => u.toJSON()));
  } catch (error) {
    console.error(error);
  }
}

getUsers();

findAll()方法可以接受一些查询条件，如where、order等。

5.3 更新数据

更新数据使用模型的update()方法：

async function updateUser() {
  try {
    const user = await User.findOne({ where: { email: 'admin@example.com' } });
    user.username = 'administrator';
    await user.save();
    console.log(user.toJSON());
  } catch (error) {
    console.error(error);
  }
}

updateUser();

需要先查询到要更新的数据，然后修改数据属性，并使用save()方法保存修改。

5.4 删除数据

删除数据使用模型的destroy()方法：

async function deleteUser() {
  try {
    const user = await User.findOne({ where: { email: 'admin@example.com' } });
    await user.destroy();
  } catch (error) {
    console.error(error);
  }
}

deleteUser();

使用findOne()方法查询到要删除的数据，然后使用destroy()方法将数据删除。

四、总结

使用Sequelize框架可以方便地进行ORM映射操作，使开发效率更高，代码可维护性更好，出错率更低。Sequelize支持多种数据库，并且提供了高级查询功能，能满足大部分需求。