[RFC] 关于egg异步加载配置文件的解决方式
- Dominant language
- TypeScript
- Stars
- 19k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
## 背景
>由于egg生命周期中,加载配置文件在configWillLoad之前,并且configWillLoad只支持同步方法,导致在实践中希望从配置中心拉取配置,或者希望异步方式加载配置文件的方式无法实现。 官方在issues中提出的在agent进程中获取配置,并写入文件,在worker进程中加载该文件的方式。 经过实践测试发现,好像并不能实现需求,因为,按照官方文档,egg源码,实践发现,agent的生命周期与app的生命周期几乎一样(此处指加载方式与生命周期函数),所以配置文件的加载依然在configWillLoad之前,并且如上所述,此函数不支持异步方法。在现实应用中陷入了僵局,秉持着继续试用egg框架不更换框架的前提下,我使用了一种曲线救国的方式,放弃egg-script的启动方式。
## 思路
> 注:项目中使用了etcd获取配置
1、首先改变egg启动方式,放弃egg-script的启动,使用[egg-cluster](https://github.com/eggjs/egg-cluster)自定义启动文件index.js
2、项目目录下的index.js
```
/*
* index.js
* /
const startCluster = require('egg-cluster').startCluster;
const Etcd3 = require('etcd3');
const fs = require('fs');
const moment = require('moment');
// node env 与 egg env 映射
const env = "dev";
//egg-cluster启动配置
const serverOptions = {
baseDir: __dirname,
};
// etcd配置
const etcdConfig = {};
(async () => {
const etcd = new Etcd3.Etcd3(etcdConfig);
try {
const res = await etcd.getAll();
//获取到etcd的配置后,写入文件
fs.writeFileSync("./config/etcd.json", JSON.stringify(res), { flag: 'w' })
} catch (error) {
const errMessage = moment().format('YYYY-MM-DD HH:mm:ss')
+ 'There is an error occured for getting config from Etcd =>'
+ error.toString()
fs.writeFileSync('./logs/startError.log', errMessage, { flag: 'w' })
process.exit(1)
}
startCluster(serverOptions);
})();
```
3、写入config目录下的配置文件etcd.json
```
/*
* etcd.json
* /
{
"MYSQL_DBNAME": "test",
"MYSQL_PORT": "3306",
"MYSQL_READ_HOST": "127.0.0.1",
"MYSQL_READ_PASSWORD": "test",
"MYSQL_READ_USERNAME": "test"
}
```
4、在config中使用配置文件
```
/*
* config.env.js
* /
*
const etcd = require('./etcd.json');
const MYSQL_DBNAME = etcd.MYSQL_DBNAME
const MYSQL_HOST_READ = etcd.MYSQL_READ_HOST
const MYSQL_PORT_READ = etcd.KANKANTAOBAO_MYSQL_PORT
const MYSQL_USERNAME_READ = etcd.MYSQL_READ_USERNAME
const MYSQL_PASSWORD_READ = etcd.MYSQL_READ_PASSWORD
module.exports = appInfo => {
return {
sequelize: {
datasources: [
{
dialect: 'mysql',
delegate: 'test',
baseDir: 'model/test',
database: MYSQL_TAOBAO_DBNAME,
logQueryParameters: true,
replication: {
read: [
{
database: MYSQL_DBNAME,
host: MYSQL_HOST_READ,
port: MYSQL_PORT_READ,
username: MYSQL_USERNAME_READ,
password: MYSQL_PASSWORD_READ,
}
],
write: {
}
},
freezeTableName: false,
underscored: true,
timezone: '+08:00',
}
]
},
}
};
```
5、关于此种方式的思考
在我们项目的实际部署使用中,测试服使用pm2统一维护node项目,在正式服中,用docker部署项目,所以几乎是用不到egg-script的维护功能,如果大家有什么更好的方式,或者我的错误,欢迎指点。
## 跟进
- [ ] some task
- [ ] PR URL
Contributor guide
Assessment
This issue has not been assessed yet.