使用 Sequelize CLI(命令行界面)可以快速生成一个新的 Sequelize 项目结构和模型。以下是具体步骤:
1. 创建一个新的项目目录
首先,创建一个新的项目目录并进入该目录:
mkdir my-sequelize-app
cd my-sequelize-app
2. 初始化 npm 项目
初始化一个新的 npm 项目:
npm init -y
3. 安装 Sequelize 和 Sequelize CLI
安装 Sequelize 和 Sequelize CLI:
npm install sequelize sequelize-cli
4. 初始化 Sequelize
使用 Sequelize CLI 初始化 Sequelize:
npx sequelize-cli init
这将在项目目录中创建以下文件和文件夹:
my-sequelize-app/
├── config/
│ ├── config.json
│ └── config.json.example
├── models/
│ └── index.js
├── migrations/
├── seeders/
└── .sequelizerc
5. 配置数据库连接
编辑 config/config.json
文件,配置你的数据库连接信息。例如,如果你使用的是 PostgreSQL:
{
"development": {
"username": "your_username",
"password": "your_password",
"database": "my_database",
"host": "127.0.0.1",
"dialect": "postgres"
},
"test": {
"username": "your_username",
"password": "your_password",
"database": "my_database_test",
"host": "127.0.0.1",
"dialect": "postgres"
},
"production": {
"username": "your_username",
"password": "your_password",
"database": "my_database_production",
"host": "127.0.0.1",
"dialect": "postgres"
}
}
6. 创建一个模型
使用 Sequelize CLI 创建一个新的模型。例如,创建一个 User
模型:
npx sequelize-cli model:generate --name User --attributes username:string,email:string
这将在 models
目录中生成一个 user.js
文件,并在 migrations
目录中生成一个迁移文件。
7. 运行迁移
运行迁移以创建数据库表:
npx sequelize-cli db:migrate
8. 同步模型到数据库
如果你希望在开发过程中自动同步模型到数据库,可以在 config/config.json
文件中设置 "sync": { "force": true }
,然后在 models/index.js
文件中添加以下代码:
const Sequelize = require('sequelize');
const config = require('../config/config.json')[process.env.NODE_ENV || 'development'];
const sequelize = new Sequelize(config.database, config.username, config.password, config);
module.exports = sequelize;
然后运行:
npx sequelize-cli db:seed:all
9. 使用模型
你可以在你的应用程序中使用生成的模型进行 CRUD 操作。例如,在 app.js
中:
const express = require('express');
const app = express();
const sequelize = require('./models');
const User = require('./models/user');
app.use(express.json());
app.get('/users', async (req, res) => {
const users = await User.findAll();
res.json(users);
});
app.listen(3000, () => {
console.log('Server is running on http://localhost:3000');
});
10. 运行应用
现在你可以运行你的应用程序:
node app.js
访问 http://localhost:3000/users
,你应该会看到一个空数组(如果没有用户数据)。
通过以上步骤,你已经成功使用 Sequelize CLI 生成了一个新的 Sequelize 项目,并创建了一个简单的模型。你可以根据需要进一步扩展和完善它。