MPL Jenkins库自定义类中如何调用withCredentials等Jenkins方法？

一、核心解决思路：传递上下文对象 #

Jenkins Pipeline的内置方法大多依附于steps或script块的运行时上下文，自定义类无法直接访问这些方法，最直接的处理方式是把需要的上下文对象（比如steps、docker、withCredentials）在实例化类时传入，或作为方法参数传递。

1. 复用已传的steps对象 #

你已经知道通过steps可以调用checkout、cleanws，其实stash也属于steps的内置方法，直接用steps.stash(...)就能调用。

2. 按需传递特定工具对象 #

像docker、withCredentials这类独立工具对象，可以直接作为参数传给自定义类：

class PrepStageHelper {
    def steps
    def docker
    def withCredentials

    // 构造方法接收所需上下文对象
    PrepStageHelper(steps, docker, withCredentials) {
        this.steps = steps
        this.docker = docker
        this.withCredentials = withCredentials
    }

    def execute() {
        // 调用steps下的方法
        steps.cleanws()
        steps.checkout(scm)
        
        // 使用withCredentials及嵌套的usernamePassword
        withCredentials([usernamePassword(credentialsId: 'repo-creds', usernameVariable: 'REPO_USER', passwordVariable: 'REPO_PASS')]) {
            steps.echo "当前使用的用户名：${env.REPO_USER}"
        }

        // 调用docker方法
        docker.image('openjdk:17').inside {
            steps.sh 'java -version'
        }

        // 执行stash操作
        steps.stash(name: 'source-code', includes: 'src/**/*')
    }
}

在Pipeline阶段中实例化类时传入对应对象：

stage('Prepare') {
    steps {
        script {
            def prepHelper = new PrepStageHelper(steps, docker, withCredentials)
            prepHelper.execute()
        }
    }
}

二、查看上层上下文变量的实用方法 #

如果不确定哪些对象可以传递，在Pipeline的script块里打印当前上下文的变量集合：

script {
    // 打印当前所有可访问的上下文变量
    println "当前上下文变量：${binding.variables.keySet()}"
    // 查看steps对象下的所有可用方法
    println "steps支持的方法：${steps.metaClass.methods*.name.unique()}"
}

执行Pipeline后，控制台输出会列出所有可传递的对象（比如docker、env、withCredentials等），以及steps包含的全部方法，帮你明确需要传入的内容。

三、更简便的上下文传递方式：传入整个binding #

如果需要用到大量内置方法，不用逐个传递对象，可以直接把script块的binding（上下文绑定对象）传给类：

class StageHelper {
    def binding

    StageHelper(binding) {
        this.binding = binding
    }

    def run() {
        // 从binding中取出所需对象
        def steps = binding.variables.steps
        def docker = binding.variables.docker
        def withCredentials = binding.variables.withCredentials
        
        // 后续用法和之前一致
        steps.sh 'echo 执行自定义逻辑'
        docker.image('maven:3.9').inside { ... }
    }
}

实例化时直接传入binding：

def stageHelper = new StageHelper(binding)

四、额外注意点 #

• usernamePassword是withCredentials的参数子方法，不需要单独传递，只要能调用withCredentials就能直接使用它。
• 如果需要访问env环境变量，同样可以通过传递env对象或从binding中获取。
• 共享库的自定义类建议放在src目录下，遵循Groovy的包结构，便于维护和复用。

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