脚手架开发工具——dotenv

14 阅读1分钟

简介

dotenv 是一个轻量级的 Node.js 环境变量管理工具,其核心作用是:从项目根目录的 .env 文件中加载自定义的环境变量,并将它们注入到 Node.js 的 process.env 对象中,使得我们可以在项目代码中统一通过 process.env.XXX 的方式获取这些环境配置,无需手动在系统环境中配置临时变量或永久变量。

核心工作原理

  1. 当在项目中引入并执行 dotenv 时,它会自动查找项目根目录下的 .env 文件(该文件为纯文本格式,采用键值对配置);
  2. 它会解析 .env 文件中的每一行配置(格式通常为 KEY=VALUE);
  3. 将解析后的键值对逐一挂载到 Node.js 内置的 process.env 对象上(process.env 原本用于存储系统级环境变量,dotenv 为其扩展了项目自定义环境变量);
  4. 之后在项目的任意代码文件中,都可以通过 process.env.KEY 的形式获取对应的值。

使用示例

npm install dotenv --save
# .env 文件内容 当前用户路径下创建 `.env` 文件
PORT=3000
DB_HOST=localhost
DB_USER=root
DB_PASSWORD=123456
API_KEY=abcdefg123456
    const dotenv = require('dotenv');
    const dotenvPath = path.resolve(userHome, '.env'); // /Users/***/.env
    if (pathExists(dotenvPath)) {
        dotenv.config({
            path: dotenvPath,
        });
    }