npm 包 enfig 使用教程

阅读时长 5 分钟读完

简介

enfig 是一个可以对 Node.js 应用程序进行环境配置的 npm 包,可以帮助开发人员快速构建和管理应用程序的配置信息。

安装

在使用 enfig 之前,需要先安装它:

基本用法

使用 enfig 很简单,只需要在项目根目录下创建一个名为 .env 的文件,然后在文件中添加键值对即可,例如:

然后在代码中使用如下代码即可获取环境变量:

-- -------------------- ---- -------
----- ----- - -----------------

----- ------ - -------
  ---------- ------------
  ---------- -------
  ---------- ------
---

---------------------------- -- -----------
展开代码

通过上面的代码,我们可以得到一个名为 config 的对象,它包含了从 .env 文件中读取到的所有环境变量。

配置文件

enfig 还支持使用配置文件来管理环境变量,只需要在项目根目录下创建一个名为 config.json 的文件,然后将环境变量以 JSON 格式添加到文件中即可,例如:

然后在代码中使用如下代码即可获取环境变量:

通过上面的代码,我们同样可以得到一个名为 config 的对象,它包含了从 config.json 文件中读取到的所有环境变量。

默认值

为了保证代码的健壮性和可读性,我们通常需要在代码中设置环境变量的默认值,在 enfig 中,我们可以直接在调用 enfig() 函数时提供一个对象作为默认值,例如:

-- -------------------- ---- -------
----- ----- - -----------------

----- ------ - -------
  ---------- ------------
  ---------- -------
  ---------- ------
---

---------------------------- -- -----------
展开代码

通过上面的代码,即使在没有 .env 文件或 config.json 文件时,我们仍可以获取到环境变量的默认值。

深度配置

在实际开发中,很多环境变量可能是有一定层级关系的,例如:

对于这种情况,我们可以使用 enfig 的 getDeep() 方法来获取深度配置的值,例如:

-- -------------------- ---- -------
----- ----- - -----------------

----- ------ - -------
  ----- -
    ------- ------------
    ------- -------
    ------- ------
  -
---

--------------------------------------- -- -----------
展开代码

通过上面的代码,我们可以通过 config.getDeep('DB.HOST') 方法获取到配置文件中的 DB.HOST 值。

结论

enfig 是一个非常实用的 Node.js 应用程序环境配置工具,它可以帮助我们快速构建和管理应用程序的配置信息,提高开发效率和代码健壮性,是前端开发过程中不可或缺的一环。

示例代码

全文示例代码如下:

-- -------------------- ---- -------
----- ----- - -----------------

----- ------ - -------
  ---------- ------------
  ---------- -------
  ---------- -------
  ----- -
    ------- ------------
    ------- -------
    ------- ------
  -
---

----------------------------                       -- -----------
----------------------------                       -- ------
----------------------------                       -- ------
---------------------------------------             -- -----------
---------------------------------------             -- ------
---------------------------------------             -- ------
------------------------------------------ --------- -- ------
展开代码

以上代码可通过 npm install enfig 安装 enfig 后直接在 Node.js 环境中运行。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066e25a563576b7b1eced9

纠错
反馈

纠错反馈