nodejs設定檔處理的方法介紹

這篇文章帶給大家的內容是關於nodejs設定檔處理的方法介紹，有一定的參考價值，有需要的朋友可以參考一下，希望對你有幫助。

#一般來說：一個好的專案配置應該滿足以下條件：

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

##指定檔案： node index.js --config file
預設設定檔： 從
4. ./ ../ ../../ ../../../

   等目錄尋找. ${appname}rc檔案

5. $HOME/.${appname}rc

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

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

$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 模块，可以满足我们的需求，我们可以配置公共的配置项，也可以隐秘的覆盖我们的配置项。

1. 创建配置文件目录，添加配置文件

├── 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

1. 关于部署环境的不同，获取配置通过设置环境变量NODE_ENV来适配

2. 关于开发环境的不同，在.gitignore添加config/.developmentrc，项目代码去掉开发环境配置.developmentrc，开发人员根据.developmentrc.example建直接的开发配置.developmentrc

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

NODE_ENV=production node index.js --database.password=tencent2019

以上是nodejs設定檔處理的方法介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！