当前位置：首页 > news >正文

Nestjs框架: Node.js 多环境配置策略与 dotenv 与 config 库详解

news 2025/8/5 6:45:22

概述

在现代前端与后端开发中，多环境配置管理是一项基础但至关重要的工作
无论是开发（development）、测试（testing）、预上线（staging）还是生产（production）环境
都需要独立的配置文件来保证项目的稳定性与安全性
本文将围绕两个在 Node.js 生态中广泛使用的配置管理库 —— dotenv 与 config
我们要理解 dotenv 与 config 的核心功能与使用流程
对比其在复杂配置、多环境管理中的表现，掌握如何在项目中集成并灵活使用它们

使用 dotenv 管理配置文件

dotenv 是一个轻量级的 Node.js 配置管理库，主要用于解析 .env 文件中的键值对配置
其核心功能是解析 .env 文件中的键值对，并将其挂载到 process.env 对象上，便于在项目中全局访问

1 ）安装与使用方式

我们首先在项目的根目录下创建一个 .env 文件，格式如下：

TOKEN_SECRET=yourlongrandomsecret
USERNAME=admin 
PASSWORD=myhousewordlongsecret
DATABASE_USERNAME=uthename 
DATABASE_PASSWORD=password 
SITE_DATABASE_USERTNAME=username

安装 dotenv：

npm install dotenv

在项目入口文件中（如 index.js）进行加载：

require('dotenv').config();
console.log(process.env);

通过这种方式，我们就可以在任何地方通过 process.env.TOKEN_SECRET 等方式访问配置项

优点：

简单易用，适合小型项目或简单配置场景
广泛兼容，适用于前端与后端项目
支持 .env, .env.local 等扩展命名方式

缺点：

不支持嵌套结构，所有配置都扁平化为键值对
多环境配置需要手动切换文件（如 .env.development, .env.production ）
不支持 YAML、JSON 等结构化格式

2 ） ES6 模块中的使用

如果你使用的是 ES6 模块（如 import 语法），可以这样使用：

import 'dotenv/config';
import express from 'express';

3 ）多环境配置的处理

dotenv 本身并不直接支持多环境配置文件（如 .env.development、.env.production），但我们可以手动指定加载哪个文件。例如：

require('dotenv').config({ path: './.env.development' });

在生产环境中切换为：

require('dotenv').config({ path: './.env.production' });

这种方式虽然灵活，但配置项较多时容易造成 .env 文件臃肿，且键名重复或嵌套结构不够清晰，管理起来不够直观。

使用 config 库实现更灵活的多环境配置管理

config 是另一个非常流行且功能更强大的配置管理库，支持多种配置文件格式（如 JSON、YAML、Properties 等），尤其擅长处理嵌套结构和多环境配置合并

1 ）安装与配置结构

首先安装 config：

npm install config

然后在项目根目录下创建 config/ 文件夹，结构如下：

/config
├──  default.json
├──  development.json
└──  production.json

2 ）示例配置文件

default.json

{"tokenSecret": "longsecret","db": {"host": "localhost","port": 5432},"username": "test","password": "example"
}

production.json

{"db": {"host": "yourdomain.com","port": 5432}
}

3 ）使用 config 读取配置

const config = require('config');
const dbConfig = config.get('db');
console.log(dbConfig);

4 ）环境变量控制配置加载

类Unix 环境

通过设置 NODE_ENV 环境变量来加载不同的配置文件：

export NODE_ENV=production

之后，执行 node index.js 看一下，即可验证，

config 会自动将 default 配置与对应环境配置合并，优先级为：环境配置 > 默认配置**Windows环境**使用 `cross-env` 跨平台设置环境变量：```bash
npm install cross-env

"scripts": {"dev": "cross-env NODE_ENV=development node index.js","prod": "cross-env NODE_ENV=production node index.js"
}

可使用 cross-env：$ npm install cross-env

并配置脚本：

"scripts": {"dev": "cross-env NODE_ENV=development node index.js","prod": "cross-env NODE_ENV=production node index.js"
}

支持格式与解析器扩展

文件格式	是否默认支持	需要额外安装包
JSON	是	无需
YAML	否	`yamljs`
TOML	否	`toml`
CoffeeScript	否	`coffeescript`

安装示例：

npm install yamljs

优点：

支持结构化数据格式（JSON、YAML 等）
自动合并多环境配置
模块化配置组织，易于维护
支持自定义配置目录与命名规则

缺点：

配置结构相对复杂，学习成本略高
对于简单配置场景可能“杀鸡用牛刀”

5 ）YAML 格式支持

config 同样支持 YAML 格式，但需要额外安装解析器，这和上面有些不一样：

npm install js-yaml

然后创建 default.yml 文件：

tokenSecret: longsecret
db:host: localhostport: 5432

6 ）多环境配置合并机制

config 的一大优势是支持多环境配置文件的自动合并。例如：

default.yaml 是基础配置；
production.yaml 是生产环境配置；
development.yaml 是开发环境配置；

当 NODE_ENV=production 时，会自动将 default.json 与 production.json 合并，且以 production.json 中的配置为准。

dotenv 与 config 的对比与总结

特性	dotenv	config
配置格式	`.env` 键值对	JSON / YAML / TOML 等结构化格式
环境配置支持	手动切换文件	自动合并 default + 环境配置
嵌套结构支持	不支持，需手动处理	支持
可读性与维护性	简洁但不直观	结构清晰，易于维护
使用难度	简单易用	稍复杂但更强大
全局变量	挂载在 `process.env`	通过 `config.get()` 获取对象
适用项目类型	小型项目 / 快速原型开发	中大型项目 / 需要多环境管理的项目
社区活跃与文档支持	非常流行，文档完善	社区活跃，文档详细