什么是 .env 文件？

为什么要使用 .env 文件？（好处）

如何使用 .env 文件？

通用步骤：

具体技术栈中的实现：

最佳实践和注意事项

总结

什么是 .env 文件？

.env 文件（英文全称 environment，即“环境”）是一个纯文本文件，用于存储应用程序的环境变量。每一行定义一个变量，格式通常是 键=值 对,通常我们创建好之后丢在项目的根目录下

例如，一个典型的 .env 文件可能长这样：

# 数据库连接配置
DATABASE_HOST=localhost
DATABASE_PORT=3306
DATABASE_USER=root
DATABASE_PASSWORD=my_secret_password# 第三方API密钥
API_KEY=abcdef123456
STRIPE_SECRET_KEY=sk_test_...# 应用运行配置
NODE_ENV=development
DEBUG=true
APP_PORT=3000

为什么要使用 .env 文件？（好处）

使用 .env 文件主要基于以下几个核心好处：

安全性（最重要）
- 将敏感信息与代码分离：像数据库密码、API 密钥、加密盐等绝对不应该直接硬编码在源代码中。如果代码被上传到公开的Git仓库（如GitHub），这些秘密就会瞬间暴露。
- .env 文件通常被添加到 .gitignore 中，确保它不会被提交到版本控制系统，从而保护了敏感信息。
配置管理
- 区分不同环境：你可以为不同的运行环境（开发、测试、生产）创建不同的 .env 文件（如 .env.development, .env.production），轻松管理不同的配置，而无需修改代码。
- 示例：
  - 开发环境 (.env.development)：使用本地的测试数据库。
  - 生产环境 (.env.production)：使用云上正式数据库的地址和密码。
协作便利性
- 团队协作时，你可以在项目中提供一个示例文件（如 .env.example），里面列出项目需要的所有环境变量键名，但不包含真实的值。
- 新成员克隆项目后，只需复制 .env.example 为 .env，然后填入自己的本地配置值即可，非常清晰方便。
可移植性
- 应用程序的行为由环境变量控制，使得它可以在任何地方（你的笔记本、同事的电脑、云服务器、Docker容器）运行，只要提供相应的 .env 文件即可，应用本身无需改变。

如何使用 .env 文件？

使用方法根据你使用的编程语言和框架有所不同，但核心流程是一致的。

通用步骤：

创建文件：在你的项目根目录下创建一个名为 .env 的文件。
定义变量：在文件中以 KEY=VALUE 的格式写入你的配置。注意：值通常不需要引号，除非值本身包含空格或特殊字符。
```
DB_HOST=localhost
DB_USER=admin
```
忽略文件：务必将 .env 添加到你的 .gitignore 文件中，以防止它被意外提交。
```
# .gitignore
.env
```
读取文件：在你的应用程序中，使用特定的库或模块来加载 .env 文件，并将其中的变量注入到应用的环境变量中。

具体技术栈中的实现：

1. Node.js (使用 dotenv 库)
这是最经典的用法。

安装：
```
npm install dotenv
```

在应用入口文件（如 app.js 或 index.js）的最顶部加载：

require('dotenv').config(); // 默认会读取项目根目录下的 .env 文件// 现在 process.env 中就有了 .env 文件里定义的变量
console.log(process.env.DB_HOST); // 输出 'localhost'
console.log(process.env.DB_USER); // 输出 'admin'

许多现代框架（如 Next.js, Vue CLI, Create React App）已经内置了 dotenv 支持，你只需创建文件即可，无需显式调用 require(‘dotenv’).config()。

2. Python (使用 python-dotenv 库)

安装：
```
pip install python-dotenv
```

使用：

from dotenv import load_dotenv
import osload_dotenv()  # 加载 .env 文件中的变量到 os.environdb_host = os.getenv('DB_HOST')
db_user = os.getenv('DB_USER')

3. PHP (使用 vlucas/phpdotenv)

安装 (通过Composer)：
```
composer require vlucas/phpdotenv
```

使用：

$dotenv = Dotenv\Dotenv::createImmutable(__DIR__);
$dotenv->load();$dbHost = $_ENV['DB_HOST'];
$dbUser = $_ENV['DB_USER'];

4. 在 Docker 中使用
在 Docker 世界中，环境变量尤为重要。你可以在 docker run 命令中直接使用 --env-file 参数来指定 .env 文件。

docker run --env-file .env -p 80:80 my-app

或者在 docker-compose.yml 文件中指定：

version: '3'
services:my-app:image: my-appenv_file: .env

最佳实践和注意事项

不要提交 .env：再次强调，这是安全底线。通过 .gitignore 确保它不会进入版本历史。
提供 .env.example：在仓库中包含一个示例文件，列出所有需要的键，方便其他开发者。
```
# .env.example
DB_HOST=
DB_USER=
DB_PASS=
API_KEY=
```
不要滥用：并非所有配置都适合放在 .env 文件中。它更适合与环境相关或敏感的配置。对于应用内部固定不变的配置，使用专门的配置文件可能更合适。
变量命名：通常使用大写字母和下划线 (_) 来命名，如 AWS_ACCESS_KEY_ID，这是一种广泛接受的约定。
生产环境：在云服务器或容器平台（如 Heroku, Vercel, AWS, Docker Swarm, Kubernetes）上，通常有专门的管理界面让你设置环境变量，而无需上传 .env 文件本身。在这些平台上，你应该使用其提供的配置工具。