已兼容Pipeline的Jenkins SimpleBuildStep插件如何获取环境参数？

针对你遇到的Jenkins插件Pipeline兼容后无法获取环境参数的问题，我整理了几种可行的解决办法，同时解答你关于Step接口的疑问：

方案一：基于现有SimpleBuildStep实现获取环境变量 #

虽然你当前实现的SimpleBuildStep的perform方法参数没有直接提供环境变量，但可以通过传入的Run对象来获取完整的环境参数：

public void perform(@Nonnull Run<?, ?> run, @Nonnull FilePath workspace, @Nonnull Launcher launcher, @Nonnull TaskListener listener) throws AbortException {
    // 获取基础环境变量（包含Jenkins全局变量和构建相关变量）
    EnvVars envVars = run.getEnvironment(listener);
    
    // 如果需要包含节点本地的环境变量，可以结合Launcher补充
    envVars.overrideAll(launcher.getEnvironment());
    
    // 示例：获取BUILD_NUMBER参数
    String buildNumber = envVars.get("BUILD_NUMBER");
    listener.getLogger().println("当前构建编号：" + buildNumber);
    
    // 你的业务逻辑代码...
}

这种方式不需要改动现有类结构，适合快速解决问题。

方案二：改用Workflow Step接口（对应JENKINS-29144的建议） #

你提到的Step接口确实来自workflow-basic-steps依赖包，这个方案是Pipeline场景下更原生的实现方式，能更便捷地获取上下文信息。

1. 依赖配置确认 #

你给出的依赖是正确的，建议添加provided作用域（避免打包时重复引入Jenkins已提供的依赖），同时尽量使用适配你Jenkins版本的稳定版：

<dependency>
  <groupId>org.jenkins-ci.plugins.workflow</groupId>
  <artifactId>workflow-basic-steps</artifactId>
  <version>2.24</version> <!-- 可根据你的Jenkins版本调整，建议选LTS兼容版 -->
  <scope>provided</scope>
</dependency>

2. 实现Step接口的具体步骤 #

首先，重构你的类实现Step接口，同时需要定义对应的StepExecution来处理实际执行逻辑：

import org.jenkinsci.plugins.workflow.steps.Step;
import org.jenkinsci.plugins.workflow.steps.StepContext;
import org.jenkinsci.plugins.workflow.steps.StepExecution;
import hudson.Extension;
import org.kohsuke.stapler.DataBoundConstructor;

public class JobBuildStep implements Step {

    // 如果你的插件需要配置参数，用@DataBoundConstructor标注构造方法
    @DataBoundConstructor
    public JobBuildStep() {
        // 初始化逻辑
    }

    @Override
    public StepExecution start(StepContext stepContext) throws Exception {
        // 返回自定义的执行类，将上下文传递进去
        return new JobBuildStepExecution(stepContext);
    }

    // 注册这个步骤为Pipeline可用的扩展
    @Extension
    public static class DescriptorImpl extends StepDescriptor {
        @Override
        public String getFunctionName() {
            // 这个名称就是Pipeline脚本中调用你的步骤时用的指令，比如`jobBuildStep()`
            return "jobBuildStep";
        }

        @Override
        public String getDisplayName() {
            return "我的自定义构建步骤";
        }
    }
}

3. 实现StepExecution执行类 #

StepExecution是实际处理业务逻辑的核心，在这里可以直接从上下文获取环境变量、Run、Workspace等对象：

import org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl;
import org.jenkinsci.plugins.workflow.steps.StepContext;
import hudson.EnvVars;
import hudson.FilePath;
import hudson.Launcher;
import hudson.model.Run;
import hudson.model.TaskListener;

public class JobBuildStepExecution extends AbstractStepExecutionImpl {

    public JobBuildStepExecution(StepContext context) {
        super(context);
    }

    @Override
    public boolean start() throws Exception {
        // 直接从上下文获取所需对象，包括环境变量
        Run<?, ?> run = getContext().get(Run.class);
        FilePath workspace = getContext().get(FilePath.class);
        Launcher launcher = getContext().get(Launcher.class);
        TaskListener listener = getContext().get(TaskListener.class);
        EnvVars envVars = getContext().get(EnvVars.class);

        // 示例：获取自定义环境变量
        String customVar = envVars.get("MY_CUSTOM_VAR");
        listener.getLogger().println("获取到自定义变量：" + customVar);

        // 你的业务逻辑代码...

        // 执行完成后标记成功，若执行失败可调用onFailure()
        getContext().onSuccess(null);
        return false; // 返回false表示同步执行；若为异步任务返回true，后续手动触发完成
    }

    // 序列化需要的UID，若存在非序列化字段需额外处理
    private static final long serialVersionUID = 1L;
}

两种方案的选择建议 #

• 如果你的插件需要同时支持Freestyle和Pipeline项目，可以保留SimpleBuildStep的实现，同时新增Step接口的实现（通过多类或适配器模式），实现双向兼容。
• 如果只专注于Pipeline场景，直接使用Step接口方案更简洁，上下文信息的获取也更直接。

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