如何通过Cucumber Java获取Feature文件中Step名称用于Extent报告

我之前在项目里正好做过这个需求，下面分享两种实用的实现方式，覆盖普通Scenario和Scenario Outline的场景，都是Java环境下适配Cucumber + Extent Reports的方案：

方法一：通过Cucumber Hook结合Scenario对象（快速实现） #

这种方式适合不需要太细粒度监听的场景，利用Cucumber的@BeforeStep和@AfterStep Hook来获取当前Step的信息。

实现步骤： #

1. 确保项目已引入Cucumber和Extent Reports的核心依赖（如果还没配置的话）
2. 创建Hook类，注入Scenario对象，在@BeforeStep中获取Step名称：

import io.cucumber.java.AfterStep;
import io.cucumber.java.BeforeStep;
import io.cucumber.java.Scenario;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.Status;

public class CucumberExtentHooks {
    // 用ThreadLocal管理多线程下的ExtentTest实例，避免线程安全问题
    private static ThreadLocal<ExtentTest> extentStepTest = new ThreadLocal<>();
    // 假设全局已通过ThreadLocal维护当前Scenario对应的ExtentTest实例
    private static ThreadLocal<ExtentTest> extentScenarioTest = new ThreadLocal<>();

    @BeforeStep
    public void beforeStep(Scenario scenario) {
        // 获取当前运行的Step文本（Scenario Outline会自动替换参数值）
        String stepName = scenario.getCurrentStep().getText();
        // 为当前Step创建Extent报告节点
        ExtentTest stepTest = extentScenarioTest.get().createNode(stepName);
        extentStepTest.set(stepTest);
    }

    @AfterStep
    public void afterStep(Scenario scenario) {
        ExtentTest stepTest = extentStepTest.get();
        // 根据Scenario状态更新Extent Step的状态
        if (scenario.isFailed()) {
            stepTest.log(Status.FAIL, "Step执行失败");
            // 可添加截图等附加信息：stepTest.addScreenCaptureFromPath("截图路径");
        } else {
            stepTest.log(Status.PASS, "Step执行成功");
        }
        extentStepTest.remove();
    }
}

注意：scenario.getCurrentStep()在Cucumber 6+版本可用，旧版本可能需要通过scenario.getStepResults()结合执行状态匹配，建议升级到较新的Cucumber版本。

方法二：实现Cucumber Plugin（EventListener）（更灵活） #

如果需要精准监听Step的完整生命周期（开始、结束、失败等），可以实现Cucumber的EventListener接口，这种方式能直接获取Step的原始定义（包括Scenario Outline中未替换参数的文本）。

实现步骤： #

1. 创建自定义Plugin类，实现EventListener接口：

import io.cucumber.plugin.EventListener;
import io.cucumber.plugin.event.EventPublisher;
import io.cucumber.plugin.event.StepStarted;
import io.cucumber.plugin.event.StepFinished;
import io.cucumber.plugin.event.Result;
import io.cucumber.plugin.event.ScenarioStarted;
import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.Status;

public class ExtentReportPlugin implements EventListener {
    private final ExtentReports extentReports;
    private ThreadLocal<ExtentTest> currentScenarioTest = new ThreadLocal<>();
    private ThreadLocal<ExtentTest> currentStepTest = new ThreadLocal<>();

    // 构造函数传入ExtentReports实例（全局初始化的报告对象）
    public ExtentReportPlugin(ExtentReports extentReports) {
        this.extentReports = extentReports;
    }

    @Override
    public void setEventPublisher(EventPublisher publisher) {
        // 注册需要监听的事件：Scenario开始、Step开始、Step结束
        publisher.registerHandlerFor(ScenarioStarted.class, this::handleScenarioStarted);
        publisher.registerHandlerFor(StepStarted.class, this::handleStepStarted);
        publisher.registerHandlerFor(StepFinished.class, this::handleStepFinished);
    }

    private void handleScenarioStarted(ScenarioStarted event) {
        // 创建当前Scenario对应的ExtentTest实例
        String scenarioName = event.getScenario().getName();
        ExtentTest scenarioTest = extentReports.createTest(scenarioName);
        currentScenarioTest.set(scenarioTest);
    }

    private void handleStepStarted(StepStarted event) {
        // 获取Step的原始文本（Scenario Outline会保留<参数>格式）
        String originalStepName = event.getStep().getText();
        // 若需要带关键字的完整Step文本：String fullStepName = event.getStep().getKeyword() + originalStepName;
        // 创建当前Step对应的Extent节点
        ExtentTest stepTest = currentScenarioTest.get().createNode(originalStepName);
        currentStepTest.set(stepTest);
    }

    private void handleStepFinished(StepFinished event) {
        Result result = event.getResult();
        ExtentTest stepTest = currentStepTest.get();
        // 根据Step执行结果更新状态
        switch (result.getStatus()) {
            case PASSED:
                stepTest.log(Status.PASS, "Step执行成功");
                break;
            case FAILED:
                stepTest.log(Status.FAIL, "执行失败: " + result.getError().getMessage());
                break;
            case SKIPPED:
                stepTest.log(Status.SKIP, "Step被跳过");
                break;
            default:
                stepTest.log(Status.INFO, "Step状态未知");
        }
        currentStepTest.remove();
    }
}

2. 在Cucumber运行配置中注册该Plugin：
   比如在TestRunner类的@CucumberOptions中添加：

import io.cucumber.junit.Cucumber;
import io.cucumber.junit.CucumberOptions;
import org.junit.runner.RunWith;
import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.reporter.ExtentSparkReporter;

@RunWith(Cucumber.class)
@CucumberOptions(
        features = "src/test/resources/features",
        glue = "com.yourpackage.stepdefinitions",
        plugin = {"com.yourpackage.ExtentReportPlugin"}
)
public class TestRunner {
    // 全局初始化ExtentReports实例
    public static ExtentReports extentReports = new ExtentReports();
    static {
        ExtentSparkReporter sparkReporter = new ExtentSparkReporter("target/extent-report.html");
        extentReports.attachReporter(sparkReporter);
    }
}

处理Scenario Outline的特殊需求 #

如果需要区分两种Step文本：

• 原始Step文本（如Given 用户输入<用户名>）：通过event.getStep().getText()获取（方法二的方式）
• 运行时替换参数后的文本（如Given 用户输入张三）：通过方法一中的scenario.getCurrentStep().getText()获取，Cucumber会自动完成参数替换

注意事项 #

• 多线程执行测试时，必须用ThreadLocal管理ExtentTest实例，避免线程安全问题
• 确保Cucumber与Extent Reports版本兼容，比如Cucumber 7.x搭配Extent Reports 5.x是稳定组合
• 如需添加截图、日志等附加信息，可在@AfterStep或StepFinished事件中调用Extent的API实现

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