Node.js本地与生产环境统一配置环境变量方案咨询

核心思路：统一变量清单，环境侧各自注入 #

不用割裂本地和生产的变量管理逻辑，而是通过模板文件同步所有需要的变量名，本地和生产环境各自用合规的方式注入变量值，既符合版本控制最佳实践，又能简化新增变量的流程。

具体实现步骤 #

• 步骤1：提交.env.example模板到版本库
  在项目根目录创建.env.example文件，列出所有业务需要的环境变量键名，示例：

  DB_HOST=
  DB_PORT=
  API_KEY=
  NODE_ENV=
  REDIS_URL=
  

  这个文件作为所有环境的变量清单提交到Git，新增变量时只需要更新该模板，确保本地和生产的变量名完全一致。

• 步骤2：本地使用.env文件（不提交）
  本地开发时，复制.env.example为.env，填充本地开发环境的实际值，同时把.env加入.gitignore，避免提交到版本库，符合npm的最佳实践要求。

• 步骤3：Jenkins端同步变量清单，统一注入
  对照.env.example里的变量名，在Jenkins的凭证管理或流水线参数中配置生产环境的对应值，构建时通过Jenkins的环境变量注入能力（比如流水线的environment块）将变量注入到Node.js的process.env中。
  示例Jenkins流水线片段：

  pipeline {
      agent any
      environment {
          DB_HOST = credentials('prod-db-host')
          DB_PORT = '5432'
          API_KEY = credentials('prod-api-key')
          NODE_ENV = 'production'
          REDIS_URL = credentials('prod-redis-url')
      }
      stages {
          stage('Build') {
              steps {
                  sh 'npm install'
                  sh 'npm run build'
              }
          }
          stage('Deploy') {
              steps {
                  sh 'npm run deploy'
              }
          }
      }
  }
  

代码层统一处理，无需区分环境 #

使用dotenv包统一加载变量，本地环境自动读取.env，生产环境下该包会自动忽略未存在的.env文件，直接读取Jenkins注入的系统环境变量：

// config.js
require('dotenv').config()

module.exports = {
  dbHost: process.env.DB_HOST,
  dbPort: process.env.DB_PORT,
  apiKey: process.env.API_KEY,
  nodeEnv: process.env.NODE_ENV || 'development',
  redisUrl: process.env.REDIS_URL
}

这样代码逻辑完全一致，新增变量时仅需三步：更新.env.example、本地.env添加对应值、Jenkins配置生产值，流程统一且清晰。

内容的提问来源于stack exchange，提问作者systems_n_systems