Node.js环境设置与配置—dotenv

简介

dotenv是一个使用.env文件来加载你的环境变量的零依赖模块。适用于Node.js或浏览器环境。它的主要目的是将应用程序的配置与代码分离，从而使代码更加清晰，干净和可读。

使用方法

1. 安装

dotenv可以使用npm安装：

npm install dotenv

2. 加载环境变量

在你的代码中使用dotenv来加载.env文件中的环境变量：

// 通过 require 方法导入 dotenv 模块
require('dotenv').config();

// 使用 process.env 访问 .env 中的环境变量
console.log(process.env.DB_NAME);

此时，在项目根目录下创建一个名为.env的文件，填入你的环境变量，例如：

DB_NAME=mydb
DB_PORT=5432

3. 语法格式

.env文件基本是键值对的形式，以等号= 分隔，键和值都遵循以下规则：

• 名称中不应该添加任何引号，即使它们包含空格
• 如果键名和值包含空格，要用引号括起来
• 仅从ASCII中选择常规字母数字字符来定义“名称”

例如：

SERVER_NAME="localhost"
SERVER_PORT=3000
DB_NAME="my_database"
DB_USER=user
DB_PASSWORD="my#password"

4. 支持加载多个文件

可以通过.config()方法指定.env文件的路径，或者直接在.env文件中使用DOTENV_CONFIG_PATH环境变量指定.env文件的路径。

这样在不同的阶段使用不同的文件就可以做到简单的环境切换了。

require('dotenv').config({path: '/full/custom/path/to/.env'});

或者在.env文件中使用：

DOTENV_CONFIG_PATH=/full/custom/path/to/.env

5. 注释和空白行

.env文件内部可以添加注释和空白行。所有以#开头的内容都会被视为注释。

# This is a comment

VAR_NAME=value # This is also a comment

总结

dotenv是Node.js中很有用的环境变量管理工具。使用.env文件中包含的环境变量来存储机密数据和配置文件可大大简化代码，并提高了安全性。环境变量的管理不仅仅是将它们的值注入到代码中，还能更好的对不同的构建环境进行配置，比如测试机器，本地开发机器，预生产环境和生产环境。