env-helper

一个基于环境变量的配置管理工具，用于处理不同环境下的配置需求。

项目结构

├── config/           # 项目配置目录
│   └── project.js    # 项目基础配置
├── lib/             # 核心库目录
│   └── configManage/ # 配置管理模块
│       ├── envManager.js    # 环境变量管理
│       └── projectManager.js # 项目配置管理
├── .env.development  # 开发环境配置
├── .env.preview     # 预览环境配置
├── .env.production  # 生产环境配置
├── .env.template    # 环境变量模板
├── Dockerfile       # Docker构建文件
└── docker-compose.yml # Docker编排文件

配置管理策略

环境变量管理

• 开发环境：使用 .env.development 文件管理环境变量
• 预览环境：使用 .env.preview 文件管理环境变量
• 生产环境：使用 .env.production 文件管理环境变量
• 环境变量模板：.env.template 提供所有可配置的环境变量示例

配置层级

1. 基础配置（config/project.js）

   • 存放项目的基础配置
   • 不同环境共享的默认值

2. 环境变量覆盖

   • 通过环境变量覆盖默认配置
   • 支持开发、预览、生产三种环境

使用方法

1. 环境变量配置

# .env.template 示例
TYPE_CODE=H5_PT
REDIS_HOST=127.0.0.1
WAC_BASE_URL=https://wac-kit.axinfu.com/wac_kit

2. 获取配置

const projectManager = require('./lib/configManage/projectManager');

// 获取当前环境完整配置
const config = projectManager.getConfig();

// 获取特定配置项
const wacBaseUrl = projectManager.getConfigByKey('WAC_BASE_URL');

3. 配置分类

• BASE：项目共享基础配置
• WAC：子应用配置
• REDIS：Redis服务配置
• LOG：日志服务配置（阿里云SLS）

Docker部署

1. 构建镜像

docker-compose build

2. 运行容器

docker-compose up -d

3. 环境变量注入

在 docker-compose.yml 中通过 environment 配置注入环境变量：

environment:
  - NODE_ENV=production
  - TYPE_CODE=H5_PT
  - PORT=3004

最佳实践

1. 环境变量管理

   • 使用 .env.template 维护所有可配置项
   • 不同环境使用对应的 .env 文件
   • 敏感信息（密钥、密码）通过环境变量注入

2. 配置分层

   • 基础配置：config/project.js
   • 环境配置：.env 文件
   • 运行时配置：Docker环境变量

3. 开发流程

   • 本地开发使用 .env.development
   • 预览环境使用 .env.preview
   • 生产环境通过 Docker 环境变量注入

4. 安全性

   • 敏感配置使用环境变量
   • 避免配置信息硬编码

注意事项

1. 不要将包含敏感信息的 .env 文件提交到版本控制
2. 确保 .env.template 包含所有必要的配置项
3. Docker部署时正确配置环境变量
4. 定期更新环境变量模板