Jenkinsfile中自定义函数无法访问全局变量的解决方案问询

报错原因 #

在Jenkins Pipeline的Groovy语法中，使用def关键字在顶层定义的变量属于当前脚本的局部绑定变量，自定义的顶层函数默认无法直接访问该作用域的变量，仅声明式pipeline块内部可以正常读取该值。

可行解决方案 #

方案1：使用@Field注解定义脚本成员变量（推荐） #

通过Groovy内置的Field注解将顶层变量声明为脚本类的成员变量，即可在自定义函数、pipeline块全域访问，不会污染全局绑定空间：

import groovy.transform.Field

// 加@Field注解将变量定义为脚本成员变量
@Field def globalVariable = "my variable"

def myFunction() {
    def myString = "my String and ${globalVariable}"
    // 此处可正常访问globalVariable
}

pipeline {
    agent any
    stages {
        stage('测试') {
            steps {
                script {
                    myFunction()
                    // pipeline内部也可正常访问
                    echo globalVariable
                }
            }
        }
    }
}

方案2：去掉def定义为全局绑定变量 #

直接移除变量前的def关键字，变量会被加入Groovy脚本的全局绑定对象，所有自定义函数都可以直接访问：

// 去掉def，变量进入全局绑定
globalVariable = "my variable"

def myFunction() {
    def myString = "my String and ${globalVariable}"
    // 此处可正常访问globalVariable
}

pipeline {
    // pipeline内部也可正常访问
    ...
}

注意：该方案会污染全局绑定空间，可能和Jenkins内置变量、插件变量重名引发冲突，仅适合简单Pipeline场景使用。

方案3：将变量作为参数传入自定义函数 #

如果不需要全域修改变量，仅需在少数函数中读取值，可以在调用时手动将变量作为参数传递给函数，作用域隔离最彻底：

def globalVariable = "my variable"

// 函数新增参数接收传入的变量
def myFunction(String inputVar) {
    def myString = "my String and ${inputVar}"
    // 此处通过参数读取变量值
}

pipeline {
    agent any
    stages {
        stage('测试') {
            steps {
                script {
                    // 调用时传入顶层变量
                    myFunction(globalVariable)
                }
            }
        }
    }
}

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