Node.js配置文件管理方法详解与最佳实践

易于使用：配置项应该是分层配置的，有助于查找条目和维护庞大的配置文件的，应该是容易组织和容易获取的，比如json结构

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

痛点

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

部署环境不同： 开发、测试、生产环境的不同，导致配置的不同

开发环境不同： 开发者的开发环境配置不同，会存在同一个配置文件配置项不同，同一文件不同内容提交，容易引起 git 冲突，影响 git 提交更新

安全地配置： 一些配置不应该明文保存在项目代码里面，比如数据库密码

解决方案

部署环境不同

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

开发环境配置：developmentConfig.js

测试环境配置：testConfig.js

生产环境配置：productionConfig.js

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

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

引用配置的时候，只要引用 config.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，其实最后会被环境变量的值覆盖，运行如下：

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

实操

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

rc 模块

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

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

命令行参数：–user=root 或者对象形式赋值 –database.user=root

环境变量： 环境变量前缀为${appname}_的变量 appname_user=root 对象形式 appname_database__user=root

指定文件： node index.js –config file

默认配置文件： 从 ./ ../ ../../ ../../../等目录查找.${appname}rc文件

$HOME/.${appname}rc

$HOME/.${appname}/config

$HOME/.config/${appname}

$HOME/.config/${appname}/config

/etc/${appname}rc

/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

关于安全地配置，通过添加环境变量覆盖默认值，可以安全隐秘地覆盖配置项，比如：