Egg.js，是阿里开源的企业级 Node.js 框架。相比Express、Koa，Egg.js更为轻量，是Koa的增强，开发成本和效率也更为高效。
Sequelize，是一个广泛使用的 ORM 框架，它支持 MySQL、PostgreSQL、SQLite 和 MSSQL 等多个数据源。
一、安装配置插件
打开vscode终端安装egg-mysql，mysql2
npm install --save egg-sequelize mysql2
在 config/plugin.js 中引入 egg-sequelize 插件
exports.sequelize = {
enable: true,
package: 'egg-sequelize',
}
在 config/config.default.js 中编写 sequelize 配置
config.sequelize = {
dialect: 'mysql',
host: '123.45.67.890',
port: 3306,
database: 'test',
username: 'root',
password: '123456',
// 配置数据库时间为东八区北京时间
timezone: '+08:00',
define: { // model的全局配置
timestamps: true, // 添加create,update,delete时间戳
paranoid: true, // 添加软删除
freezeTableName: true, // 防止修改表名为复数
underscored: false // 防止驼峰式字段被默认转为下划线
},
// 打印日志
logging: true,
// 时间格式化
dialectOptions: {
dateStrings: true,
typeCast: true
}
};
注意点
1、日期显示格式异常
默认情况下查询的日期是这种样子2022-01-02T09:14:03.102Z，我们需要对它自动格式化才行。
dialectOptions: {
dateStrings: true,
typeCast: true
}
这样就会格式化成酱紫：2022-01-04 10:39:56
二、模型配置
模型是 Sequelize 的本质. 模型是代表数据库中表的抽象. 在 Sequelize 中，它是一个 Model 的扩展类。
Sequelize 中的模型有一个名称，此名称不必与它在数据库中表示的表的名称相同。 通常，模型具有单数名称(例如，User)，而表具有复数名称(例如，Users)，这是完全可配置的。
我们先在model文件夹中创建一个parents.js文件定义parents模型:
'use strict';
/**
* 家长表
*/
module.exports = app => {
const { STRING, INTEGER, UUID, NOW, DATE, UUIDV4 } = app.Sequelize;
const Parents = app.model.define('Parents', {
id: {
type: UUID,
primaryKey: true,
allowNull: false,
defaultValue: UUIDV4,
comment: '家长id'
},
name: {
type: STRING(36),
allowNull: false,
comment: '家长姓名'
},
age: {
type: INTEGER,
allowNull: false,
comment: '家长年龄'
},
createDate: {
type: DATE,
defaultValue: NOW,
field: 'create_date',
comment: '创建时间'
},
updateDate: {
type: DATE,
defaultValue: NOW,
field: 'update_date',
comment: '更新时间'
}
}, {
// 去除createAt，updateAt
timestamps: false,
// 实例对应的表名
tableName: 'parents'
});
return Parents;
};
是否修改表名为复数配置
Squelize会将Parents默认转变为复数，也就是直接加s变为Parentss，很多时候这并不是我们想要的，可以对其进行修改。
1、在config.json文件中，添加如下配置
这是全局的，避免在每个模型中修设置。
"define": {
"freezeTableName": true
}
2、对app.model.define的第三个参数进行配置
项目已经在config.json配置了，模型中已被注释掉。此外，我们可以在第三个参数中配置我们想要的表名tableName
添加默认值
在更新或添加数据的时候，默认值是有必要的。一般对id，创建时间(create_date)，更新时间(updated_date)设置默认值。
id: {
defaultValue: UUIDV4
},
create_date: {
defaultValue: NOW
},
update_date: {
defaultValue: NOW
}
三、模型字段的数据类型
这里只展示部分数据类型，详细的请查阅文档。
1、字符串(String)
DataTypes.STRING // VARCHAR(255)
DataTypes.STRING(36) // VARCHAR(36)
DataTypes.TEXT // TEXT
2、布尔(Boolean)
DataTypes.BOOLEAN // TINYINT(1)
3、数字(Number)
DataTypes.INTEGER // INTEGER
DataTypes.BIGINT(11) // BIGINT(11)
DataTypes.FLOAT // FLOAT
DataTypes.FLOAT(11) // FLOAT(11)
4、日期
DataTypes.DATE // DATETIME 适用于 mysql/sqlite
5、UUID
Sequelize 使用 Sequelize.UUIDV1 或 Sequelize.UUIDV4 生成UUID作为主键。
{
type: DataTypes.UUID,
defaultValue: Sequelize.UUIDV4 // 或 Sequelize.UUIDV1
}
四、数据查询
1、新增
单个新增
const parents = await Parents.create({
name: '王大锤'
});
parents实体的其他字段设置了默认值，会返回新增数据的实体。
批量新增
const parents = await Parents.bulkCreate({
name: '王大锤'
}, {
name: '山呱呱'
});
2、查询
const result = await this.ctx.model.Parents.findAll({
limit: 10, // 当页条数
offset: 0, // 开始下标
order: [['create_date', 'desc']], // 排序规则
where: {
age: {
[Op.gt]: 36
},
name: {
[Op.like]: '王%'
}
},
attributes: [ // 指定返回的属性
'id',
'name',
// 第一个参数为属性，第二个参数为别名，返回数据以别名返回
['create_date', 'createDate']
]
});
操作符
Sequelize提供了多种运算符，常见的都写在例子里了，其他的请查阅文档。
const result = await this.ctx.model.Parents.findAll({
where: {
age: {
// [Op.gt]: 36,
// [Op.eq]: 39, // = 39
// [Op.ne]: 39 // != 39
// [Op.gt]: 32 // > 32
// [Op.gte]: 32 // >= 32
// [Op.lt]: 32 // < 32
// [Op.lte]: 32 // <= 32
// [Op.between]: [32, 35], // BETWEEN 32 AND 35
// [Op.notBetween]: [32, 35], // NOT BETWEEN 32 AND 35
// [Op.in]: [36, 38], // IN [36, 38]
// [Op.notIn]: [36, 38], // NOT IN [36, 38]
// 组合
// [Op.or]: {
// [Op.lt]: 36,
// [Op.eq]: 60
// }
},
// Op.in简写
// age: [32, 39], 同使用 `age: { [Op.in]: [32, 39] }`
name: {
// [Op.like]: '王%',
// [Op.like]: '%hat', // LIKE '%hat'
// [Op.notLike]: '%hat', // NOT LIKE '%hat'
// [Op.startsWith]: 'hat', // LIKE 'hat%'
// [Op.endsWith]: 'hat', // LIKE '%hat'
},
// Op.not实例
// [Op.not]: [{
// age: [36,37,38]
// }, {
// name: {
// [Op.like]: '王%'
// }
// }],
create_date: {
[Op.lt]: new Date(),
[Op.gt]: new Date(new Date() - 24 * 60 * 60 * 1000)
}
}
});
3、更新
const effectedNum = await this.ctx.model.Parents.update({
name: '王小锤'
}, {
where: {
id: '123456789'
}
})
4、删除
const effectedNum = await this.ctx.model.Parents.destroy({
where: '123456789'
})
5、count
count 方法仅计算数据库中元素出现的次数。
const effectedNum = await this.ctx.model.Parents.count({
where: {
age: {
[Op.gt]: 25
}
}
})
6、max, min 和 sum
await this.ctx.model.Parents.max('age'); // 63
await this.ctx.model.Parents.max('age', {
where: {
age: {[Op.lt]: 40}
}
}); // 39
await this.ctx.model.Parents.sum('age'); // 1027
7、模型查找
这种查询方式效率会高很多。
findByPk
findByPk 方法使用提供的主键从表中仅获得一个条目。
await this.ctx.model.Parents.findByPk('12');
findOne
findOne 方法获得它找到的第一个条目(它可以满足提供的可选查询参数)。
await Project.findOne({ where: { age: 40 } });
findAndCountAll
在处理与分页有关的查询时非常有用。
const { count, rows } = await this.ctx.model.Parents.findAndCountAll({
where: {
name: {
[Op.like]: '王%'
}
},
offset: 10,
limit: 0
});
console.log(count);
console.log(rows);
最后
欢迎关注我的公众号【前端技术驿站】，多多交流，共同进步！
回复 100获取100本图灵图书
回复react，vue,node获取最新实战视频
