Egg.js 多环境配置开发实践指南

背景与需求

在实际开发中，我们经常需要针对不同环境使用不同的配置。以Egg.js项目为例，开发者可能需要在本地开发时使用多套配置方案，比如针对不同业务场景的devForOne、devForTwo等配置，而不希望每次切换时都手动修改配置文件。

解决方案

Egg.js框架本身提供了灵活的环境配置机制，可以通过环境变量来指定当前使用的配置环境。具体实现方式如下：

1. 配置文件命名规范

在Egg.js项目中，配置文件的加载遵循特定规则：

• config.default.js - 基础默认配置
• config.{env}.js - 环境特定配置，会覆盖default配置

例如：

• config.dev.js - 开发环境配置
• config.devForOne.js - 特定业务场景1的配置
• config.devForTwo.js - 特定业务场景2的配置

2. 环境变量控制

通过设置EGG_SERVER_ENV环境变量，可以指定当前使用的配置环境。框架会自动加载对应的配置文件并覆盖默认配置。

对于Windows系统，在package.json中配置脚本：

"scripts": {
  "devForOne": "set EGG_SERVER_ENV=devForOne && egg-bin dev",
  "devForTwo": "set EGG_SERVER_ENV=devForTwo && egg-bin dev"
}

对于Linux/Mac系统：

"scripts": {
  "devForOne": "EGG_SERVER_ENV=devForOne egg-bin dev",
  "devForTwo": "EGG_SERVER_ENV=devForTwo egg-bin dev"
}

3. 执行方式

配置完成后，可以通过以下命令启动不同环境的开发服务器：

npm run devForOne  # 使用devForOne配置
npm run devForTwo  # 使用devForTwo配置

实现原理

Egg.js的配置加载机制基于环境变量EGG_SERVER_ENV工作：

1. 框架启动时，会检查EGG_SERVER_ENV环境变量
2. 如果设置了该变量，框架会加载对应的config.{env}.js文件
3. 加载的环境特定配置会覆盖config.default.js中的默认配置
4. 最终形成合并后的配置对象供应用使用

注意事项

1. 系统兼容性：Windows和Unix-like系统设置环境变量的语法不同，需要注意区分
2. 配置优先级：环境特定配置会覆盖默认配置，但不会覆盖config.local.js（本地开发配置）
3. 变量命名：环境名称应保持一致，避免大小写不一致导致的加载问题
4. 调试技巧：可以通过在中间件中打印app.config来验证配置是否按预期加载

最佳实践建议

1. 为每个业务场景创建独立的配置文件，保持配置的清晰隔离
2. 在团队协作时，将通用开发配置放在config.dev.js中
3. 个人特定配置可以使用config.local.js（不会被提交到版本控制）
4. 在文档中明确记录各环境配置的用途和差异

通过这种方式，开发者可以轻松管理多套开发环境配置，提高开发效率的同时保持配置的规范性和可维护性。