npm 包 envfile 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在 Web 开发过程中，我们经常需要在不同环境中使用不同的配置，如开发环境、测试环境和生产环境等，这时候使用 envfile 这个 npm 包可以帮助我们轻松管理环境变量和配置文件。

本文将介绍 envfile 包的使用方法，包括安装、基本使用、高级使用以及实际示例。

安装

使用 npm 安装 envfile 包：

npm install envfile --save

安装成功后，在项目中引入即可使用。

基本使用

加载 .env 文件

.env 文件是环境变量和配置文件的主要来源，我们需要将其从磁盘上加载到内存中。可以使用以下方式：

const envfile = require('envfile');

const config = envfile.parseFileSync('.env');
console.log(config);

这里使用 parseFileSync 方法将 .env 文件内容解析成对象并打印出来。

获取环境变量

我们可以使用以下方式获取环境变量：

const envfile = require('envfile');

const config = envfile.parseFileSync('.env');
console.log(config.PORT);

假设 .env 文件中定义了 PORT=3000，上述代码将输出 3000。

在命令行中设置环境变量

在某些情况下，我们需要在命令行中设置环境变量，例如：

PORT=8080 node app.js

我们可以使用以下方式将其解析成对象：

const envfile = require('envfile');

const config = envfile.parse(process.env);
console.log(config.PORT);

上述代码将输出 8080。

高级使用

内置默认值

envfile 支持添加默认值以确保在没有配置时使用默认值。例如：

const envfile = require('envfile');

const defaults = { PORT: 3000 };
const config = envfile.parseFileSync('.env', { defaults });
console.log(config.PORT);

如果 .env 文件中没有设置 PORT，则输出 3000。

变量替换

在 .env 文件中，我们可以通过 ${} 语法使用其他环境变量和配置。例如：

PORT=3000
HOST=localhost:${PORT}

上述配置中，对于 HOST 的值是 localhost:3000。

更多变量替换的用法请参见 dotenv-expand。

支持其他数据格式

envfile 默认支持 .env 格式，但也支持其他数据格式（如 .ini、.plist）。例如，使用 ini 格式解析：

const envfile = require('envfile');

const config = envfile.parseFileSync('config.ini', { format: 'ini' });
console.log(config.server.port);

实际示例

以下是一个基于 envfile 的实际示例：使用多个 .env 文件来实现多个环境下的配置：

.env
.env.staging
.env.production

我们可以通过设置 NODE_ENV 环境变量来指定当前的环境，例如：

NODE_ENV=staging node app.js

这时候 envfile 将加载 .env.staging 文件和 .env 文件，并将其合并为一个对象。

const envfile = require('envfile');

// 根据 NODE_ENV 加载对应的环境变量和配置
const env = process.env.NODE_ENV || 'development';
const config = envfile.parseFileSync(`.env.${env}`, { defaults: '.env' });

console.log(config.SERVER_URL);
console.log(config.DATABASE_URL);

当 NODE_ENV 环境变量为 staging 时，上述代码将加载 .env.staging 和 .env 文件，并将其合并为一个对象。如果 .env.staging 文件中有定义 SERVER_URL，则使用 .env.staging 中的值，否则使用 .env 中的值。同理，当 NODE_ENV 环境变量为 production 时，加载 .env.production 和 .env 文件。

结语

envfile 是一个轻巧但强大的 npm 包，可以帮助我们简化多环境下的配置。我们可以将 envfile 与其他 npm 包结合使用，以更好地管理和扩展我们的应用程序。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/61846