Jenkins Job DSL：如何在Groovy脚本步骤中传递并使用构建参数

我刚接触Job DSL和Groovy的时候也踩过这些参数传递的坑，给你一步步梳理解决方法：

问题1：正确定义并传递参数给stepscript.groovy #

你之前的报错核心原因是：把Jenkins构建参数当成了Job DSL脚本本身的变量来引用。Job DSL是用来生成Jenkins任务配置的Groovy代码，所以得让生成的配置里保留参数占位符，供Jenkins运行构建时去替换，而不是让Job DSL解析器在生成配置时就去查找这个变量。

修正后的DSL代码如下：

job('generated-job-1'){
    label ('master')
    parameters{
        stringParam('DEPLOY_URI', 'https://192.168.200.176/hyperManager', 'Provide the URL where DeploymentManager can be accessed.')
        stringParam('REG_ID', '12', 'The id of the owner (Registration) of this deployment.')
    }
    steps {
        groovyCommand(readFileFromWorkspace('stepscript.groovy')){
            prop('name', 'value')
            // 用转义的双引号，让DSL生成的配置里保留${DEPLOY_URI}占位符
            prop('DEPLOY_URI', "\${DEPLOY_URI}")
            prop('REG_ID', "\${REG_ID}")
        }
    }
}

这里的关键是"\${DEPLOY_URI}"：转义$符号后，Job DSL会把${DEPLOY_URI}作为字符串写入生成的Jenkins任务配置中，当Jenkins实际运行构建时，会自动将这个占位符替换为你触发构建时传入的参数值。

问题2：在Shell/BatchFile步骤中使用构建参数 #

在Shell或Batch步骤里，直接用Jenkins自动注入的环境变量即可，写法和普通脚本一致，注意Job DSL里的字符串处理：

• Shell步骤：用单引号包裹命令（避免Job DSL提前解析$），或者转义$：

steps {
    // 方式1：单引号，Job DSL不解析$，交给Jenkins运行Shell时处理
    shell('echo Deployment URI: $DEPLOY_URI')
    shell('echo Registration ID: $REG_ID')
    
    // 方式2：双引号加转义，效果相同
    shell("echo Deployment URI: \$DEPLOY_URI")
}

• BatchFile步骤（Windows环境）：用%参数名%的格式：

steps {
    batchFile('echo Deployment URI: %DEPLOY_URI%')
    batchFile('echo Registration ID: %REG_ID%')
}

问题3：在stepscript.groovy中访问参数 #

有两种可靠的方式获取参数，推荐第二种更通用的：

方式1：通过Binding获取（对应DSL里的prop传递）

如果你在DSL里用prop传递了参数，这些参数会被放入Groovy脚本的Binding对象中，直接引用变量名就能拿到：

// stepscript.groovy
def deployUri = DEPLOY_URI // 直接使用传递的prop属性
def regId = REG_ID

println "Deploy URI from prop: ${deployUri}"
println "Registration ID from prop: ${regId}"

方式2：读取Jenkins环境变量（推荐）

不管有没有用prop传递，Jenkins都会把构建参数注入到当前构建的环境变量中，你可以直接通过System.getenv()获取，这种方式更灵活，后续修改DSL步骤也不需要同步调整脚本：

// stepscript.groovy
def deployUri = System.getenv('DEPLOY_URI')
def regId = System.getenv('REG_ID')

// 可以加个参数校验，避免空值
if (!deployUri) {
    throw new IllegalArgumentException("DEPLOY_URI parameter is required!")
}

println "Deploy URI from env: ${deployUri}"
println "Registration ID from env: ${regId}"

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