Sequelize中文文档解读：快速入门指南

Sequelize中文文档解读：快速入门指南

sequelize-docs-Zh-CN 项目地址: https://gitcode.com/gh_mirrors/se/sequelize-docs-Zh-CN

前言

Sequelize是一个基于Node.js的优秀ORM框架，它支持多种关系型数据库，提供了强大的数据模型定义、查询构建和事务管理功能。本文将从技术专家的角度，带你全面了解Sequelize的安装和基础使用方法。

环境准备

安装Sequelize

Sequelize提供了两个主要版本：

• v6版本：稳定版，包名为sequelize
• v7版本：新特性版本，包名为@sequelize/core

安装命令如下：

# 使用npm安装v6
npm install sequelize

# 使用npm安装v7
npm install @sequelize/core

# 使用yarn安装v6
yarn add sequelize

# 使用yarn安装v7
yarn add @sequelize/core

数据库驱动安装

Sequelize需要配合特定数据库的驱动使用，以下是常见数据库的驱动安装命令：

# PostgreSQL
npm install pg pg-hstore

# MySQL
npm install mysql2

# MariaDB
npm install mariadb

# SQLite
npm install sqlite3

# SQL Server
npm install tedious

# DB2
npm install ibm_db

# IBM i
npm install odbc

建立数据库连接

连接方式

Sequelize提供了两种主要的连接方式：

1. URI连接字符串方式：

const sequelize = new Sequelize('postgres://user:pass@example.com:5432/dbname');

2. 配置对象方式：

const sequelize = new Sequelize({
  dialect: 'postgres',
  host: 'localhost',
  username: 'dbuser',
  password: 'dbpassword',
  database: 'dbname'
});

对于SQLite这种文件型数据库，可以使用特殊配置：

const sequelize = new Sequelize({
  dialect: 'sqlite',
  storage: 'path/to/database.sqlite' // 数据文件路径
});

连接测试

建立连接后，建议进行连接测试：

try {
  await sequelize.authenticate();
  console.log('数据库连接成功');
} catch (error) {
  console.error('连接数据库失败:', error);
}

连接关闭

当不再需要连接时，应该显式关闭：

await sequelize.close();

注意：关闭后需要新建实例才能再次连接。

核心概念解析

Sequelize命名约定

• Sequelize（首字母大写）：指Sequelize库本身
• sequelize（首字母小写）：指Sequelize实例，代表一个数据库连接

异步处理机制

Sequelize几乎所有操作都是异步的，支持两种处理方式：

1. Promise方式：

sequelize.authenticate()
  .then(() => console.log('连接成功'))
  .catch(err => console.error('连接失败', err));

2. async/await方式：

async function testConnection() {
  try {
    await sequelize.authenticate();
    console.log('连接成功');
  } catch (error) {
    console.error('连接失败', error);
  }
}

开发建议

学习环境搭建

对于初学者，建议使用SQLite作为学习环境，因为它无需额外服务，只需内存模式即可：

const sequelize = new Sequelize('sqlite::memory:');

日志配置

Sequelize默认会输出执行的SQL语句，可以通过logging参数自定义：

const sequelize = new Sequelize({
  // ...其他配置
  logging: false, // 禁用日志
  // 或者使用自定义日志函数
  logging: msg => console.log(`[SQL] ${msg}`)
});

适用场景

Sequelize适用于：

1. 全新项目：可以从零开始设计数据模型
2. 已有数据库：可以映射现有表结构
3. 多数据库支持：同一套API操作不同数据库

总结

本文介绍了Sequelize的核心入门知识，包括安装配置、连接建立和基本使用。作为Node.js生态中最成熟的ORM之一，Sequelize提供了强大的数据操作能力和跨数据库支持。建议初学者从SQLite开始实践，逐步掌握模型定义和复杂查询等高级功能。

sequelize-docs-Zh-CN 项目地址: https://gitcode.com/gh_mirrors/se/sequelize-docs-Zh-CN