dotenv-flow使用指南

dotenv-flow使用指南

dotenv-flow Loads environment variables from .env.[development|test|production][.local] files for Node.js® projects. 项目地址: https://gitcode.com/gh_mirrors/do/dotenv-flow

项目介绍

dotenv-flow 是一个扩展了原始 dotenv 功能的 npm 包，专门为基于 Node.js 的项目设计。它允许开发者从不同环境（如开发、测试、生产）的特定 .env 文件中加载环境变量，并支持本地环境文件的覆盖功能。这意味着你可以根据 NODE_ENV 设置，自动匹配加载对应的.env.development, .env.test, 或 .env.production 等文件，以及它们的本地变体（如 .env.development.local, .env.production.local），以适应不同的开发、调试及部署需求。

项目快速启动

安装

首先，你需要安装 dotenv-flow 到你的项目中：

使用npm

npm install dotenv-flow --save

使用yarn

yarn add dotenv-flow

使用pnpm

pnpm add dotenv-flow

初始化使用

在你的 Node.js 应用的入口文件尽早地初始化 dotenv-flow：

CommonJS 方式

require('dotenv-flow').config()

ES 模块方式

import dotenvFlow from 'dotenv-flow'
dotenvFlow.config()

或者，通过命令行参数配置或预加载：

NODE_ENV=development node -r "dotenv-flow/config" your_app.js

应用案例和最佳实践

假设你有一个多环境的应用，下面是如何设置和使用的例子：

1. 创建不同的 .env 文件来存储对应环境的变量。

   • .env: 储存默认或回退值。
   • .env.development: 开发环境变量。
   • .env.development.local: 开发环境下的个性化配置。
   • .env.test, .env.test.local: 测试环境配置。
   • .env.production, .env.production.local: 生产环境配置。

2. 在代码中访问这些环境变量：

console.log(process.env.DATABASE_HOST);
console.log(process.env.DATABASE_NAME);

3. 运行时设置 NODE_ENV 来选择加载哪个环境的配置：

export NODE_ENV=production
node index.js

最佳实践

• 敏感信息：保证 .env.*.local 文件不被版本控制，避免泄露敏感数据。
• 命名规范：遵循约定俗成的环境名称，如 development, test, production。
• 默认值：在 .env 中提供默认值，方便团队共享非敏感的基础配置。

典型生态项目

dotenv-flow 本身是为解决Node.js项目环境变量管理而生，与其他工具结合使用可构建更健壮的开发和部署流程，比如与CI/CD工具（如GitLab CI/CD、Jenkins）集成，实现自动化环境配置切换。此外，利用 cross-env 可以确保在不同操作系统间正确设置 NODE_ENV，增强跨平台兼容性。

通过这样的整合，开发者可以在不同的部署阶段轻松管理复杂的应用配置，提高开发效率并确保安全。

---

以上就是关于dotenv-flow的基本使用教程和建议实践，帮助您高效且安全地管理您的环境变量。

dotenv-flow Loads environment variables from .env.[development|test|production][.local] files for Node.js® projects. 项目地址: https://gitcode.com/gh_mirrors/do/dotenv-flow