背景
基于将Node应用纳入Spring Cloud微服务架构,我们将Node应用的配置交由配置中心统一管理,该组件为配置中心NodeJs客户端。
使用方式
1. 添加依赖
npm set registry http://npm.xxxx.com
npm install xxxx-node-config@1.1.0
2. 配置方式
在项目根目录添加启动配置:bootstrap.yml
node:
application:
name: vayh5
config:
uri: ${CONFIG_URL:http://bank-configserver-bank-sit-8888.zkj.test}
profile: ${NODE_PROFILE:dev1} #非必填项,可直接由环境变量 NODE_PROFILE中指定
auth:
username: ${CONFIG_USER:xxxx}
password: ${CONFIG_PASS:xxxx}
上面配置中,配置方式与spring cloud config的配置方式相同,可通过环境变量 + 默认值的方式来进行配置,其中:profile为非必填项,可直接由环境变量 NODE_PROFILE中指定(如果没有在配置文件中指定,则必须在环境变量中设值)。
在配置中心添加项目相关的配置:
使用方式与规范与JAVA项目相同,在根路径建立应用目录,配置加载顺序为:application.yml => application-{profile}.properties => appName/appName.yml => appName/appName-{profile}.properties
注意的是,Eureka等相关中间件,用和JAVA项目一样的公共配置。详见:组件介绍Eureka Client For Nodejs
node:
server:
port: ${NODE_PORT:8036}
application:
name: ${APP_NAME:h5}
my: #自定义
value: ${xxxx.config.test}
value2: ${MY_ENV:${xxxx.config.test2:123}}
上面配置为在配置中心里的NODE应用配置,其中node.server.port, node.application.name为必配项,下面为 my. 应用自己定义的各种配置。
示例:如果应用运行的profile为dev1,且加载配置文件appName-dev1.properties如下:
xxxx.config.test=111
xxxx.config.test2=456
则node.my.value = 111,
而node.my.value2优先会从环境变量中读取,如果没有设值,则从相应的profile配置中寻找:msxf.config.test2,如果没有该配置则读取默认值123,上面例子中node.my.value2=456
3. 使用方式
在Node应用中,使用配置的方式如下:
const configCenter = require('msxf-node-config');
configCenter.load().then((cfg) => {
const value = cfg.get('node.my.value');
const value2 = cfg.get('node', 'my', 'value2');
console.info(value);
console.info(value2);
}).catch((err) => {
console.error(err);
});
转换成Object的使用方式如下:
const configCenter = require('xxxx-node-config');
configCenter.load().then((cfg) => {
const value = cfg.toObject().node.my.value;
const value2 = cfg.toObject().node.my.value2;
console.info(value);
console.info(value2);
}).catch((err) => {
console.error(err);
});
在实际应用中,只需要在入口JS中从配置中心获取cfg,将cfg放入全局变量,或通过中间件方式传递(express),或放入全局context(koa以及其他)等方式使用。