Sequelize 开源项目使用教程

1. 项目目录结构及介绍

Sequelize 是一个功能丰富的 Promise-based ORM（对象关系映射）库，适用于 Node.js 环境。以下是 Sequelize 项目的目录结构及其简单介绍：

• docs: 存放项目文档。
• examples: 包含使用 Sequelize 的示例项目。
• lib: Sequelize 的核心代码库。
• node_modules: 项目依赖的模块。
• test: 测试代码。
• src: 源代码目录。
• dist: 打包后的代码。
• MIT-LICENSE.txt: 许可证文件。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

在 Sequelize 项目中，并没有一个传统意义上的启动文件。通常情况下，开发者会根据需要在项目根目录下的 examples 或其他自定义项目目录中创建一个启动文件。以下是一个简单的启动文件示例：

const { Sequelize } = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password', {
  host: 'localhost',
  dialect: 'mysql' // 或其他支持的数据库名
});

// 定义模型
const User = sequelize.define('User', {
  username: Sequelize.STRING,
  birthday: Sequelize.DATE
});

// 同步数据库结构
sequelize.sync();

// 创建一个用户实例并保存
User.create({
  username: 'janedoe',
  birthday: new Date(1980, 6, 20)
}).then(jane => {
  console.log(jane.toJSON());
});

3. 项目的配置文件介绍

Sequelize 的配置通常通过在启动文件中传递参数给 Sequelize 实例来实现。然而，在复杂项目中，可能需要一个专门的配置文件。以下是一个简单的配置文件示例，通常命名为 config.js 或 config.json：

// config.js
module.exports = {
  development: {
    dialect: 'mysql',
    database: 'sequelize_development',
    username: 'root',
    password: 'password',
    host: '127.0.0.1',
    port: 3306,
  },
  // 其他环境的配置...
};

在启动文件中，您可以按如下方式使用这个配置文件：

const config = require('./config');
const sequelize = new Sequelize(config.development.database, config.development.username, config.development.password, {
  host: config.development.host,
  dialect: config.development.dialect,
  // 其他配置...
});

这样，您就可以根据不同的环境切换不同的数据库配置。