dotenv-extended 是一个 Node.js 应用程序的 npm 包，它允许您轻松地从 .env 文件加载环境变量，并扩展了 dotenv 功能以支持更多数据类型和命名空间。在这篇文章中，我们将深入研究 dotenv-extended 的使用方法，包括安装、配置以及具体应用场景，让您可以更加方便地使用这个强大的 npm 包。
安装
使用 npm 命令来安装 dotenv-extended：
npm i dotenv-extended
安装完成后，在您的项目中就可以使用 dotenv-extended 了。
配置
安装完 dotenv-extended 后，您需要正确配置它的参数。dotenv-extended 有两种配置方法：
-- -------------------- ---- ------- -- ----- ---- ----------- ---------------------------------- -- -------- ---- --------- --------------------------------- ----- ------- --------- ------- ------ ----- ------------------- ---- ---
其中，load() 函数有一个可选参数 config，它是一个字典对象，用来描述如何解析 .env 文件。以下是常用的配置参数：
- path：
.env文件路径，默认为项目根目录下的.env - encoding：
.env文件编码，默认为utf8 - debug：输出调试信息开关，默认为
false - assignToProcessEnv：是否自动添加环境变量到 Node.js 进程的
process.env对象，默认为true
应用示例
现在假设您有这个 .env 文件：
-- -------------------- ---- ------- - ------- ------------- -------------- ------------------------- ------------ ------- ---- - ------ ----------------- ------------ ----------------- --------------------- ----------------------
要读取 .env 文件中的变量，可以按照以下方式：
-- -------------------- ---- ------- -- ------ ---------------------------------- -- ------ ----- ------- - --------------------- ----- -------- - --------------------- --- ------- ----- --------- - ----------------------- ----- ------- - --------------------- ----- ------ - -------------------- ----- ------ - -------------------- ----- ---------- - ------------------------ ----- ---------- - ------------------------ ----- ---------- - ------------------------
上面的代码加载了 .env 文件中的所有变量，并添加到 Node.js 进程 process.env 中。变量可以通过 process.env 访问，无需手动解析 .env 文件。
dotenv-extended 的高级用法
dotenv-extended 支持高级应用场景，例如：
支持多个 .env 文件
如果您需要通过多个 .env 文件来配置环境变量，可以使用 dotenv-extended 的 load() 方法来加载多个文件：
require('dotenv-extended').load({
path: '.env.default', // 默认值，覆盖其他文件的同名变量
defaults: '.env.defaults', // 默认配置文件
overrides: '.env.overrides' // 优先级最高的配置文件
});这样，您可以像这样在 .env.default 文件中设置默认变量：
APP_PORT=3000 APP_DEBUG=true
在 .env.defaults 中覆盖默认变量：
APP_SECRET=verysecretpass APP_NAME="My Awesome App"
并在 .env.overrides 中设置高优先级的变量：
APP_PORT=9000 APP_DEBUG=false
此时，Node.js 进程的 process.env 恰当的变量值应如下：
{
APP_PORT: '9000',
APP_DEBUG: 'false'，
APP_SECRET: 'verysecretpass',
APP_NAME: 'My Awesome App'
}支持配置命名空间
为了避免变量名冲突，您可以设置不同的命名空间：
-- -------------------- ---- -------
---------------------------------
----- -------
--------- ----------------
------- --------------
--------------- ----
---
-- ---------
----- ----- - -
----- ---------------------------
------ --------------------------- --- -------
------- -----------------------------
----- ---------------------------
--- -
----- --------------------------
----- --------------------------
----- --------------------------
--------- -----------------------------
-
--您可以在 .env 文件中使用 myapp 前缀来设置命名空间变量，例如：
-- -------------------- ---- ------- ------------------- -------------------- ------------------------------- ------------------ ------- ---- ----------------------- ------------------ ----------------------- ----------------------- ----------------------------
在 Node.js 进程中的 myapp 对象包含了命名空间为 MYAPP 的所有变量值。
支持自定义数据类型
dotenv-extended 支持自定义数据类型以扩展默认的数据解析。例如，如果您需要解析 boolean 类型，可以这样做：
require('dotenv-extended').load({
schema: '.env.schema', // 配置文件
parseBoolean: true // 支持 `boolean` 类型
});
// 访问 boolean 类型的变量
const appDebugEnabled = process.env.APP_DEBUG === true;然后在 .env.schema 文件中设置解析规则：
APP_PORT=number:3000 APP_DEBUG=boolean:true APP_SECRET=string
上面的规则说明：
APP_PORT是一个数字类型，默认值为3000APP_DEBUG是一个布尔类型，默认值为trueAPP_SECRET是一个字符串类型
使用这些规则，您可以有效地限制和验证变量的合法性。
总结
本文介绍了 dotenv-extended 的安装和配置方法，并详细阐述了其常用和高级应用场景。dotenv-extended 提供了很多便利的功能，可以帮助您更好地管理环境变量。如果您需要在 Node.js 应用程序中配置复杂的环境变量，那么 dotenv-extended 是一个不错的选择。如果您有什么疑问或需要请看文中的配置，可以在评论区留言或者查看 官方文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/dotenv-extended