Jenkins流水线脚本：何时用params.parameterName或直接引用parameterName？

问题场景 #

在以下Jenkins流水线脚本中：

def sonarAnalysisFn(sonarAnalysis) {
    if (sonarAnalysis == true) {  
        echo "Sonar analysis is running"
    } else {
        echo "Skipping Sonar Analysis"
    }
}

node {
    properties([
        parameters([
            string(name: 'name', defaultValue: 'World', description: 'Enter your name'),
            booleanParam(defaultValue: true, description: 'Untick if you want to skip Sonar analysis', name: 'sonarAnalysis')
        ])
    ])
    
    stage('Greet') {
        echo "Hello, ${name}"  // 此处直接使用name可正常获取用户输入
    }
    
    stage('Sonar Analysis') {
        sonarAnalysisFn(sonarAnalysis)  // 此处直接传sonarAnalysis始终拿到默认值true
        // sonarAnalysisFn(params.sonarAnalysis)  // 改用params.sonarAnalysis可正常获取用户输入
    }
}

出现了特殊现象：字符串参数name直接引用能拿到用户输入，但布尔参数sonarAnalysis直接传递给函数时，始终使用默认值true，只有通过params.sonarAnalysis才能获取用户修改后的参数值。

核心原因 #

1. 变量作用域与Groovy解析逻辑 #

Jenkins流水线基于Groovy运行，Groovy的变量解析遵循就近作用域优先原则：

• 你定义的函数sonarAnalysisFn的参数名也是sonarAnalysis，和流水线参数同名。当在node块中调用sonarAnalysisFn(sonarAnalysis)时，Groovy解析器会优先将sonarAnalysis解析为函数参数的隐性默认值（Groovy对布尔类型有特殊的类型推断逻辑），而非流水线注入的全局变量。
• 字符串参数name没有和任何局部变量、函数参数重名，所以直接引用时会正常指向流水线注入的全局变量，能拿到用户输入。

2. params对象的作用 #

params是Jenkins流水线的内置全局对象，专门用于存储所有流水线参数：

• 所有用户传入的参数（包括修改后的布尔参数）都会同步到params对象中，无论当前作用域是否有同名变量，通过params.parameterName都能精准获取用户实际提交的参数值，不受作用域冲突影响。

最佳实践 #

• 当参数名可能与局部变量、函数参数重名时，始终使用params.parameterName引用参数，避免作用域冲突导致的取值错误。
• 对于布尔类型的流水线参数，建议统一使用params.parameterName引用，Groovy对布尔类型的隐式处理更容易引发作用域解析问题。
• 也可以给函数参数起不同的名字，比如把sonarAnalysisFn的参数改为runSonar，这样直接传递sonarAnalysis也能正常获取用户输入。

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