如何集成Jenkins流水线任务并使用Groovy传递动态变量

核心逻辑 #

以项目标识作为入参，通过Groovy编写的Pipeline动态加载对应项目的个性化配置，完全解耦通用集成逻辑和项目差异化配置，适配多项目共用同一套Jenkins任务的场景。

具体落地步骤 #

1. 配置任务基础参数 #

首先开启Jenkins任务的参数化构建能力，声明通用入参，触发任务时通过这些入参匹配对应项目的配置。如果使用声明式Pipeline，直接在Jenkinsfile中定义参数即可：

pipeline {
  agent any
  parameters {
    // 核心参数：项目唯一标识，用于匹配对应配置
    string(name: 'PROJECT_NAME', defaultValue: '', description: '触发任务的项目标识，例：service-order、service-user')
    // 按需扩展通用参数
    string(name: 'ENV', defaultValue: 'test', description: '部署环境：test/pre/prod')
    string(name: 'BUILD_BRANCH', defaultValue: 'main', description: '代码构建分支')
  }
  // 后续Pipeline逻辑
}

2. 维护项目动态变量配置 #

根据团队场景二选一即可：

方案A：内置配置映射（适合项目少、变量变动频率低的场景）

直接在Pipeline代码中定义所有项目的配置映射，运行时通过入参PROJECT_NAME动态取值：

// 全局项目配置映射
def projectConfig = [
  "service-order": [
    gitUrl: "git@internal.com:order/service-order.git",
    buildCmd: "mvn clean package -DskipTests",
    deployPath: "/opt/app/order",
    healthCheckUrl: "http://localhost:8080/health"
  ],
  "service-user": [
    gitUrl: "git@internal.com:user/service-user.git",
    buildCmd: "npm install && npm run build",
    deployPath: "/opt/app/user",
    healthCheckUrl: "http://localhost:3000/api/health"
  ]
]

// 校验并获取当前项目配置
def currentProjectConfig = projectConfig[params.PROJECT_NAME]
if (!currentProjectConfig) {
  error "未找到项目[${params.PROJECT_NAME}]的配置，请检查入参是否正确"
}

方案B：外置配置文件（适合项目多、变量变动频繁的场景）

每个项目在自身代码仓库根目录维护jenkins-config.groovy配置文件，Pipeline拉取代码后动态加载该文件获取变量：

stage('拉取项目代码') {
  steps {
    // 先根据项目标识拉取对应代码
    git url: currentProjectConfig.gitUrl, branch: params.BUILD_BRANCH
    script {
      // 加载当前项目的自定义配置，覆盖默认配置
      def customConfig = load "${WORKSPACE}/jenkins-config.groovy"
      currentProjectConfig.putAll(customConfig)
    }
  }
}

项目侧jenkins-config.groovy示例：

return [
  jdkVersion: "11",
  nodeVersion: "16",
  notifyGroup: "order-rd-group",
  afterDeployScript: "sh /opt/scripts/flush-order-cache.sh"
]

3. 触发任务时传入动态参数 #

• 上游Jenkins任务触发：直接调用build方法传参即可

// 上游项目Pipeline中触发通用集成任务的代码
build job: '通用集成部署任务', parameters: [
  string(name: 'PROJECT_NAME', value: 'service-order'),
  string(name: 'ENV', value: 'prod'),
  string(name: 'BUILD_BRANCH', value: env.BUILD_BRANCH)
], wait: true

• 外部系统触发：调用Jenkins构建OpenAPI，把参数放在请求体中即可。

4. 动态变量使用 #

后续所有Pipeline步骤直接调用已加载的currentProjectConfig中的变量即可，自动适配不同项目的差异化逻辑：

stage('代码构建') {
  steps {
    sh currentProjectConfig.buildCmd
  }
}

stage('服务部署') {
  steps {
    sh "scp ./build/*.jar root@deploy-server:${currentProjectConfig.deployPath}"
  }
}

注意事项 #

• 敏感类变量（数据库密码、接口秘钥等）不要明文写在配置中，统一存储在Jenkins凭据管理中，通过credentials()方法动态引用
• 建议设置参数优先级：触发传入参数 > 项目自定义配置 > 全局默认配置，提升使用灵活度
• 增加参数合法性校验逻辑，避免非法入参导致任务执行异常

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