使用 node-config 在 Node.js 中創(chuàng)建配置文件

管理跨不同環(huán)境的多個配置文件可能具有挑戰(zhàn)性，并且有多種工具正試圖用不同的方法解決這個問題。但是，在本文中，我們將學(xué)習(xí)如何使用 node-config^[1] 跨不同部署環(huán)境創(chuàng)建和管理 Node.js 配置文件。

node-config是什么？

Node-config允許你在你的Node應(yīng)用程序中為不同的部署環(huán)境創(chuàng)建配置文件。有了它，你可以定義一個你打算跨環(huán)境重復(fù)使用的默認配置文件，然后將默認配置擴展到其他環(huán)境，如開發(fā)、暫存等。

你可以使用一些臨時的命令行參數(shù)來覆蓋這些參數(shù)，比如在你的命令行參數(shù)中加入NODE_ENV=development。

Node-config使創(chuàng)建和管理一個在所有部署環(huán)境中共享的一致的配置界面變得更加容易。

為了更好地理解如何設(shè)置這個配置，讓我們使用一個Node應(yīng)用樣本。首先，在你的終端上運行下面的命令來克隆這個資源庫，或者從這里下載并解壓它。

git clone https://github.com/ezesundayeze/node-env-sample

要安裝 Node 依賴項，請運行：

npm install

設(shè)置 node-config

因為node-config是一個npm包，我們可以通過運行這些命令中的任何一個來用npm或yarn安裝它。

npm install config

或者

yarn add config

支持的 node-config 文件擴展名

Node-config 支持許多文件擴展名。在發(fā)布時，當(dāng)前版本的 node-config (3.3.6) 支持以下擴展：

- .json
- .json5
- .hjson
- .yaml or .yml
- .coffee
- .js
- .cson
- .properties
- .toml
- .ts
- .xml

這意味著你可以用任何一個支持的擴展來創(chuàng)建你的配置文件，但為你的項目選擇一個擴展并在整個構(gòu)建過程中堅持使用它是有意義的。

在本教程中，我們將使用 .json 擴展名。

創(chuàng)建默認環(huán)境變量

創(chuàng)建一個 config 目錄并向其中添加一個 config/default.json 文件。這將是默認配置文件，并將包含所有默認環(huán)境變量。

在我們的示例應(yīng)用程序中它應(yīng)該是這樣的：

config/default.json

{
  "server": {
    "host": "localhost",
    "port": 0,
  }
}

我們將在我們的應(yīng)用程序中通過導(dǎo)入 config 和使用 get 方法訪問變量來訪問它。

const config = require('config');
const port = config.get('server.port');
const host = config.get('server.host');

讓我們創(chuàng)建一個 server.js 文件并添加以下代碼。

const express = require('express');
const config = require('config');
const app = express();
const port = config.get('server.port');
const host = config.get('server.host');

app.get('/', (req, res) => {
  res.send('Hello World');
});
const server = app.listen(port, host, (err) => {
  if (err) {
    console.log(err);
    process.exit(1);
  }
  console.log(`Server is running on ${host}:${server.address().port}`);
});

你可以在你的應(yīng)用程序的其他部分以類似的方式使用node-config。

擴展默認配置文件

你可以通過創(chuàng)建其他配置文件來擴展默認的配置文件。例如，你可以為開發(fā)、生產(chǎn)、QA、暫存、本地等創(chuàng)建配置文件。讓我們來介紹一下我們將在我們的應(yīng)用程序中使用的配置文件的主要類型。

本地配置文件

創(chuàng)建本地配置文件是為了覆蓋你的配置文件的部署版本。例如，對于你的開發(fā)部署，你可以有一個 local-development.json 文件來存儲你所有的本地開發(fā)配置——它反映了你在部署的開發(fā)環(huán)境中期望的那種行為。

因此，你可以擁有這樣的東西：

local-{instance}.EXT
local-{deployment}.EXT
local-{deployment}-{instance}.EXT

短主機名和完整主機名

你也可以使用簡短和完整的主機名來定義你在特定平臺上的配置文件，以防你要在多個實例上進行部署。例如，您可以有一個 ?{short_hostname}，它將代表您的服務(wù)器名稱直到第一個點。如果您的主機名是 demo.example.com，則配置可以是 ?demo.EXT (demo.json)。

此外，如果您的 {full_hostname} 是您的整個服務(wù)器名稱，則您可以在 {short_hostname} 與其他機器發(fā)生沖突時使用它。因此，在您的主機名是 demo.example.com 的情況下，您的配置文件名將是 demo.example.com.json。

自定義配置文件

你可能還想創(chuàng)建一個自定義的配置文件來容納一些環(huán)境變量的覆蓋。Node-config提供了對配置文件類型的支持，你可以用 custom-environment-variables.EXT（custom-environment-variables.json）的名字來定義。

測試配置值

如果您的環(huán)境變量沒有設(shè)置，使用它們的服務(wù)就會中斷。所以，你應(yīng)該確保你的環(huán)境變量已經(jīng)過測試。Node-config 提供了多個實用程序，其中之一是 config.has() 方法，它允許您驗證是否設(shè)置了環(huán)境變量。

你可以創(chuàng)建一個測試文件或?qū)⑵涮砑拥侥愕念A(yù)提交鉤子中，以確保你的配置文件都已設(shè)置好。

以下是如何使用 config.has() 檢查配置變量是否存在的示例：

if (config.has('dbConfig')) { 
... 
}

你也可以在你的Jest測試中使用它，像這樣：

const config = require('config');
test('Server config exist', () => {
  expect(config.has("server")).toBe(true);
});
test('Default config exist', () => {
  expect(config.has("server.port")).toBe(true);
  expect(config.has("server.host")).toBe(true);
});

使用命令行重寫

使用命令行覆蓋允許你從你的終端或命令行中即時指定配置參數(shù)。你需要在啟動應(yīng)用程序時通過指定 NODE_CONFIG='{...}' 命令來設(shè)置配置，參數(shù)必須是JSON字符串的格式。

下面是一個例子：

NODE_CONFIG='{"server": {"host":"192.168.43.13", "port":"3030"}}' npm run dev

JSON 值周圍的單引號允許您安全地使用雙引號。在某些情況下，根據(jù)您的操作系統(tǒng)，您可能需要對某些字符進行轉(zhuǎn)義。您還可以使用命令行導(dǎo)出來避免一直鍵入命令。

在你的終端上運行下面的命令將覆蓋你的服務(wù)器的主機和端口或你選擇覆蓋的任何其他配置。

export NODE_CONFIG='{"server": {"host":"192.168.43.13", "port":"3030"}}'

如果您更喜歡使用 JavaScript，可以在調(diào)用配置庫之前將其添加到您的服務(wù)器文件中，如下所示：

const express = require('express');
process.env.NODE_CONFIG = '{"server": {"host":"localhost", "port":"3030"}}';
const config = require('config');

訣竅是在配置加載之前將 NODE_CONFIG 變量設(shè)置為 JSON 字符串。

發(fā)生這種情況是因為命令行覆蓋優(yōu)先于所有其他類型的覆蓋。下面是一些在使用 node-config 時不能用作環(huán)境變量的保留字，因為庫提供了它們的實現(xiàn)，可能會與您的實現(xiàn)沖突。

get
has
util
getConfigSources
makeHidden
makeImmutable
setModuleDefaults
watch 
_attachProtoDeep
_cloneDeep
_diffDeep

這不是一個詳盡的列表，所以一定要查看文檔。

有一些插件可以讓你高效地使用 node-config 和 Docker 來管理密鑰，一個插件可以讓你自動重新加載 node-config^[2]（你可能已經(jīng)知道，配置不會在文件更改時自動加載），以及允許您取消緩存您的配置（uncache your config）^[3]變量的插件。

總結(jié)

使用 node-config 時，有無數(shù)種方法可以配置您的 Node 應(yīng)用程序。有了它，您可以輕松管理您的配置文件并根據(jù)需要擴展它們，從而在您的項目中實現(xiàn)最大的靈活性、可靠性和一致性。謝謝閱讀。

原文：https://blog.logrocket.com/creating-configuration-files-node-js-using-node-config/

參考資料