详解nodejs 配置文件处理方案


Posted in NodeJs onJanuary 02, 2019

前言

一般来说:一个好的项目配置应该满足以下条件:

  1. 依赖环境:配置根据具体运行环境从相应的文件读取
  2. 代码分离:配置项不仅可以从配置文件读取, 也可以从环境变量读取,使得安全隐秘的配置项与代码分离
  3. 易于使用:配置项应该是分层配置的,有助于查找条目和维护庞大的配置文件的,应该是容易组织和容易获取的,比如json结构

在多人开发 nodejs 项目的时候,没有规划好配置方案,配置文件的问题就很容易暴露出来。

痛点

在开发 nodejs 的工程中,遇到过三个痛点

  1. 部署环境不同: 开发、测试、生产环境的不同,导致配置的不同
  2. 开发环境不同: 开发者的开发环境配置不同,会存在同一个配置文件配置项不同,同一文件不同内容提交,容易引起 git 冲突,影响 git 提交更新
  3. 安全地配置: 一些配置不应该明文保存在项目代码里面,比如数据库密码

解决方案

部署环境不同

对于部署环境不同,相对容易解决,建立相应环境的配置文件,比如:

  1. 开发环境配置:developmentConfig.js
  2. 测试环境配置:testConfig.js
  3. 生产环境配置:productionConfig.js

再建一个config.js配置文件作为入口获取配置,如下:

module.exports = require(`./${process.env.NODE_ENV}Config.js`)

引用配置的时候,只要引用 config.js 即可。

运行命令如下:

NODE_ENV=development node index.js

开发环境不同

对于开发环境不同,导致每个人的developmentConfig.js不同,这个不能要求别人的配置和你的一样,这样项目就太硬了。
我们可以把developmentConfig.js添加到.gitignore,从而从项目分离出来,再在readme.md说明如何配置developmentConfig.js。

最好是建立一个developmentConfig.example.js,并在文档说明复制成developmentConfig.js后修改配置项符合自己的开发配置。

安全地配置
对于项目一些安全性要求高的配置项,我们应该从配置文件脱离出来,只能在当前的运行进程可以获取, 配置文件的配置项再读取进程的配置项值,比如数据库密码, 一般做法如下:
productionConfig.js

module.exports = {
  database: {
    user: process.env.user || 'root',
    password: process.env.password || 'yfwzx2019'
  }
}

而更隐秘的办法是,你根本不知道我用环境变量覆盖了配置项值,比如:

productionConfig.js

module.exports = {
  database: {
    user: 'root',
    password: 'yfwzx2019'
  }
}

一般人拿到了这个配置,就会以为数据库的账号密码就是root、yfwzx2019,其实最后会被环境变量的值覆盖,运行如下:

node index.js --database.user=combine --database.password=tencent2019

当然,是要做了一些处理才可以这样配置。

实操

方案有了,我们先来介绍以下 nodejs 的配置模块 rc模块

rc 模块

使用rc模块需要定义一个appname,选择rc模块是因为它会尽可能多的从appname命名相关的地方读取配置。
使用也很简单,先实例一个 rc 配置:

var conf = require('rc')(appname, defaultConfigObject)

然后它会从下面列表合并配置,优先级按顺序合并:

  1. 命令行参数:--user=root 或者对象形式赋值 --database.user=root
  2. 环境变量: 环境变量前缀为${appname}_的变量 appname_user=root 对象形式 appname_database__user=root
  3. 指定文件: node index.js --config file
  4. 默认配置文件: 从 ./ ../ ../../ ../../../等目录查找.${appname}rc文件
  5. $HOME/.${appname}rc
  6. $HOME/.${appname}/config
  7. $HOME/.config/${appname}
  8. $HOME/.config/${appname}/config
  9. /etc/${appname}rc
  10. /etc/${appname}/config

做了个 demo, 直观一点

var conf = require('rc')('development', {
 port: 3000,
})
console.log(JSON.stringify(conf))

// 1、直接运行
// node index.js
// { port: 3000, _: [] }

// 2、加上命令行参数
// node index.js --port=4000 --database.user=root
// { port: 4000, _: [], database: { user: 'root' } }

// 3、加上环境变量
// development_port=5000 development_database__password=yfwzx2019 node index.js 
// {"port":"5000","database":{"password":"yfwzx2019"},"_":[]}

// 4、指定配置文件:根目录建一个配置文件 config.json, 内容如下
// {
//  "port": "6000"
// }
// node index.js --config=config.json
// {"port":"6000","_":[],"config":"config.json","configs":["config.json"]}

// 5、默认读取 ${appname}rc 文件:根目录见一个配置文件 .developmentrc 内容如下:
// {
//  "port": 7000 
// }
// node index.js
// {"port":7000,"_":[],"configs":[".developmentrc"],"config":".developmentrc"}

// 6、 5 和4 一起运行
// node index.js --config=config.json
// {"port":"6000","_":[],"config":"config.json","configs":[".developmentrc","config.json"]}

具体操作

看了 rc 模块,可以满足我们的需求,我们可以配置公共的配置项,也可以隐秘的覆盖我们的配置项。

创建配置文件目录,添加配置文件

├── config
│  ├── .developmentrc.example
│  ├── .productionrc
│  ├── .testrc
│  └── index.js

其中 .developmentrc.example 是开发环境的例子,然后开发人员参考建 .developmentrc 文件, index.js 是配置入口文件,内容如下:

let rc = require('rc')

// 因为 rc 是从 process.cwd() 向上查找 .appnamerc 文件的,我们在根目录 config 文件夹里面的是找不到的,要改变工作路径到当前,再改回去
var originCwd = process.cwd()
process.chdir(__dirname)
var conf = rc(process.env.NODE_ENV || 'production', {
 // 默认的共同配置
 origin: 'default',
 baseUrl: 'http://google.com/api',
 enableProxy: true,
 port: 3000,
 database: {
  user: 'root',
  password: 'yfwzx2019'
 }
})

process.chdir(originCwd)

module.exports = conf
  • 关于部署环境的不同,获取配置通过设置环境变量NODE_ENV来适配
  • 关于开发环境的不同,在.gitignore添加config/.developmentrc,项目代码去掉开发环境配置.developmentrc,开发人员根据.developmentrc.example建直接的开发配置.developmentrc
  • 关于安全地配置,通过添加环境变量覆盖默认值,可以安全隐秘地覆盖配置项,比如:
NODE_ENV=production node index.js --database.password=tencent2019

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

NodeJs 相关文章推荐
用nodejs访问ActiveX对象,以操作Access数据库为例。
Dec 15 NodeJs
NodeJS学习笔记之FS文件模块
Jan 13 NodeJs
nodejs通过phantomjs实现下载网页
May 04 NodeJs
详解NodeJs支付宝移动支付签名及验签
Jan 06 NodeJs
基于nodejs+express4.X实现文件下载的实例代码
Jul 13 NodeJs
Nodejs进阶之服务端字符编解码和乱码处理
Sep 04 NodeJs
nodejs简单实现TCP服务器端和客户端的聊天功能示例
Jan 04 NodeJs
Nodejs模块的调用操作实例分析
Dec 25 NodeJs
nodejs实现百度舆情接口应用示例
Feb 07 NodeJs
nodejs中内置模块fs,path常见的用法说明
Nov 07 NodeJs
windows如何把已安装的nodejs高版本降级为低版本(图文教程)
Dec 14 NodeJs
Nodejs 数组的队列以及forEach的应用详解
Feb 25 NodeJs
nodejs基础之多进程实例详解
Dec 27 #NodeJs
nodejs基础之常用工具模块util用法分析
Dec 26 #NodeJs
nodejs基础之buffer缓冲区用法分析
Dec 26 #NodeJs
nodejs异步编程基础之回调函数用法分析
Dec 26 #NodeJs
Nodejs处理异常操作示例
Dec 25 #NodeJs
Nodejs模块的调用操作实例分析
Dec 25 #NodeJs
nodejs中方法和模块用法示例
Dec 24 #NodeJs
You might like
php等比例缩放图片及剪切图片代码分享
2016/02/13 PHP
javascript 客户端验证上传图片的大小(兼容IE和火狐)
2009/08/15 Javascript
jquery下利用jsonp跨域访问实现方法
2010/07/29 Javascript
Jquery下:nth-child(an+b)的使用注意
2011/05/28 Javascript
本人自用的global.js库源码分享
2015/02/28 Javascript
JavaScript中的函数声明和函数表达式区别浅析
2015/03/27 Javascript
javascript实现3D切换焦点图
2015/10/16 Javascript
javaScript事件学习小结(四)event的公共成员(属性和方法)
2016/06/09 Javascript
学好js,这些js函数概念一定要知道【推荐】
2017/01/19 Javascript
vscode配置vue下的es6规范自动格式化详解
2019/03/20 Javascript
基于vue如何发布一个npm包的方法步骤
2019/05/15 Javascript
在Vue中使用antv的示例代码
2020/06/29 Javascript
python WindowsError的错误代码详解
2017/07/23 Python
python判断字符串是否是json格式方法分享
2017/11/07 Python
python基于ID3思想的决策树
2018/01/03 Python
Python设计模式之工厂模式简单示例
2018/01/09 Python
详解Python 正则表达式模块
2018/11/05 Python
Python自定义一个类实现字典dict功能的方法
2019/01/19 Python
Python实现蒙特卡洛算法小实验过程详解
2019/07/12 Python
django url到views参数传递的实例
2019/07/19 Python
python实现串口通信的示例代码
2020/02/10 Python
用python制作个音乐下载器
2021/01/30 Python
Pyecharts 中Geo函数常用参数的用法说明
2021/02/01 Python
pytorch 把图片数据转化成tensor的操作
2021/03/04 Python
奥地利网上书店:Weltbild
2017/07/14 全球购物
车间班长岗位职责
2013/11/30 职场文书
生物科学专业个人求职信范文
2013/12/05 职场文书
计算机专业毕业生自荐信
2013/12/31 职场文书
大课间体育活动方案
2014/03/12 职场文书
学校端午节活动方案
2014/08/23 职场文书
党的群众路线教育实践活动组织生活会发言材料
2014/10/17 职场文书
法定授权委托证明书
2015/06/18 职场文书
2016年公司新年寄语
2015/08/17 职场文书
护士年终工作总结不会写?各科护士模板总结
2020/01/02 职场文书
Python中request的基本使用解决乱码问题
2022/04/12 Python
Apache自带的ab压力测试工具的实现
2022/07/23 Servers