Jenkins声明式管道中Groovy类复用步骤报错求助

本人具备面向对象编程（OOP）背景，希望在Groovy类中定义可复用步骤，随后在Jenkins声明式管道中创建这些类的对象并执行其中的步骤。

代码实现 #

IStage.groovy #

interface IStage{
   def executeSteps()
}

GitStage.groovy #

class GitStage implements IStage {
    def executeSteps() {
        echo "Hi From GitStage"
    }
}

Jenkinsfile #

stages {   
        stage ('GitStage stuff') {
            steps {
                script {         
                    def gitStage = new GitStage()  
                    gitStage.executeSteps()
                } 
            }              
        }                                      
    }

报错信息 #

groovy.lang.MissingMethodException: No signature of method: stages.GitStage.echo() is applicable for argument types: (java.lang.String) values: [Hi From GitStage]

本人对此感到困惑，因为在类外定义方法并通过库对象调用是可行的，希望得到问题的原因及解决方法。

问题原因 #

echo是Jenkins声明式管道提供的内置步骤方法，它的作用域绑定在Jenkins的Pipeline上下文环境中。自定义的GitStage类是独立的Groovy类，默认无法直接访问Jenkins管道的上下文，因此调用echo时会提示找不到该方法。类外的script块能正常调用echo，是因为script块本身处于Jenkins Pipeline的上下文范围内。

解决方法 #

方案1：传递Jenkins管道上下文到类中 #

修改GitStage类，通过构造函数接收Jenkins管道上下文，再使用上下文对象调用echo方法：

修改后的GitStage.groovy

class GitStage implements IStage {
    def pipelineContext

    // 构造函数接收管道上下文
    GitStage(def context) {
        this.pipelineContext = context
    }

    def executeSteps() {
        // 通过上下文调用echo
        pipelineContext.echo "Hi From GitStage"
    }
}

修改后的Jenkinsfile

stages {   
    stage ('GitStage stuff') {
        steps {
            script {         
                // 实例化时传入当前管道上下文（this代表当前Pipeline对象）
                def gitStage = new GitStage(this)  
                gitStage.executeSteps()
            } 
        }              
    }                                      
}

方案2：使用Jenkins共享库（多管道复用推荐） #

如果需要在多个Jenkins管道中复用这类Groovy类，建议将类放到Jenkins共享库的src目录下。共享库中的类可直接通过steps对象访问Jenkins内置方法：

共享库中的GitStage.groovy

class GitStage implements IStage {
    def steps

    GitStage(steps) {
        this.steps = steps
    }

    def executeSteps() {
        steps.echo "Hi From GitStage"
    }
}

Jenkinsfile中调用共享库类

@Library('your-shared-lib') _

stages {   
    stage ('GitStage stuff') {
        steps {
            script {         
                def gitStage = new GitStage(steps)  
                gitStage.executeSteps()
            } 
        }              
    }                                      
}

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