Cucumber自定义插件实现中如何获取StepDefinition上的自定义注解

该需求完全可行。你当前编写的监听器仅能读取到步骤的状态、ID、代码位置等事件公开信息，这些字段本身不包含StepDefinition方法上的注解元数据，无法直接读取到@Group的属性值，需要顺着Cucumber的步骤匹配链路定位到实际的Java方法对象后，通过Java反射获取注解。

核心实现原理 #

Cucumber运行时会为每个Java实现的StepDefinition维护统一的元数据句柄（接口为io.cucumber.core.backend.StepDefinition），该句柄直接关联StepDefinition方法对应的Java反射Method实例，方法上标注的自定义注解属于方法元数据的组成部分，完全可以通过反射API直接读取。
具体衔接逻辑：

• 对于PickleStepTestStep类型的事件对象（也就是Gherkin场景映射的可执行步骤），可以获取到该步骤与StepDefinition的匹配关系对象StepDefinitionMatch
• 从匹配关系对象中取出关联的StepDefinition句柄，进一步拿到对应的Method反射实例
• 直接从Method实例上读取@Group注解，即可获取注解中定义的id属性值

改造后的插件代码示例 #

在你原有StepListener的基础上，补充注解读取的逻辑，完整代码如下：

package hellocucumber.listener;

import io.cucumber.plugin.ConcurrentEventListener;
import io.cucumber.plugin.event.*;
import hellocucumber.annotation.Group; // 替换为你项目中@Group注解的实际包路径
import io.cucumber.core.backend.StepDefinition;
import io.cucumber.core.runtime.StepDefinitionMatch;
import java.lang.reflect.Method;

public class StepListener implements ConcurrentEventListener {

    @Override
    public void setEventPublisher(EventPublisher publisher) {
        publisher.registerHandlerFor(TestStepFinished.class, this::handleTestStepFinished);
    }

    private void handleTestStepFinished(final TestStepFinished event) {
        System.out.println("Status: "+event.getResult().getStatus());
        System.out.println("Id: "+ event.getTestStep().getId());
        System.out.println("Code Location: "+event.getTestStep().getCodeLocation());

        if (event.getTestStep() instanceof PickleStepTestStep) {
            PickleStepTestStep testStep = (PickleStepTestStep) event.getTestStep();
            System.out.println("Step Text: " + testStep.getStep().getText());
            
            // 获取当前步骤与StepDefinition的匹配关系
            StepDefinitionMatch definitionMatch = testStep.getDefinitionMatch();
            // 获取关联的StepDefinition元数据句柄
            StepDefinition stepDefinition = definitionMatch.getStepDefinition();
            // 获取对应的Java反射Method对象
            Method stepMethod = stepDefinition.getMethod();
            
            // 读取方法上的@Group自定义注解
            Group groupAnnotation = stepMethod.getAnnotation(Group.class);
            if (groupAnnotation != null) {
                System.out.println("步骤关联的Group ID: " + groupAnnotation.id());
            }
        }
    }
}

落地注意事项 #

• 自定义注解@Group在定义时必须添加@Retention(RetentionPolicy.RUNTIME)配置，否则运行时Java反射无法读取到注解值，这是反射读取运行时注解的强制要求
• 上述实现适配Cucumber 6.0及以上稳定版本；如果使用的是4.x及更早的旧版本，getDefinitionMatch()可能未开放为公共API，此时可以预先扫描项目中的所有StepDefinition类，基于getCodeLocation()返回的"全类名.方法名():行号"格式字符串，建立方法位置与Method对象的映射关系，在步骤执行时通过字符串匹配定位对应的Method对象后再读取注解
• 该方案仅适用于Java语言实现的StepDefinition，跨语言实现的步骤（如JavaScript、Python编写的StepDefinition）不存在对应的Java方法，无法通过该方式读取注解

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