如何修改/自定义JBehave步骤并添加Spring上下文数据至报告？

我刚好做过类似的需求，给你几个可行的方案，应该能完美解决你的问题：

方案1：自定义StepReporter扩展报告内容（最推荐） #

JBehave的StepReporter是管控步骤报告输出的核心接口，我们可以自定义一个实现类，在步骤成功执行后动态修改报告里的步骤描述。

首先创建自定义的StepReporter（通过Spring注入上下文来获取数据）：

import org.jbehave.core.reporters.NullStepReporter;
import org.jbehave.core.reporters.StepReporter;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;

@Component
public class CustomStepReporter extends NullStepReporter {

    private final ApplicationContext applicationContext;

    // 构造注入Spring上下文
    public CustomStepReporter(ApplicationContext applicationContext) {
        this.applicationContext = applicationContext;
    }

    @Override
    public void successful(String step) {
        // 匹配目标步骤
        if (step.startsWith("When login as random user")) {
            // 从Spring上下文取出预先存储的随机用户名
            String username = applicationContext.getBean(RandomUserHolder.class).getUsername();
            // 修改步骤描述
            String modifiedStep = step + " (" + username + ")";
            // 调用父类方法输出修改后的内容
            super.successful(modifiedStep);
        } else {
            // 其他步骤原样输出
            super.successful(step);
        }
    }
}

然后在JBehave配置类里注册这个自定义Reporter：

import org.jbehave.core.configuration.Configuration;
import org.jbehave.core.configuration.MostUsefulConfiguration;
import org.jbehave.core.reporters.StoryReporterBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class JBehaveConfig {

    private final CustomStepReporter customStepReporter;

    public JBehaveConfig(CustomStepReporter customStepReporter) {
        this.customStepReporter = customStepReporter;
    }

    @Bean
    public Configuration jbehaveConfiguration() {
        return new MostUsefulConfiguration()
                .useStoryReporterBuilder(new StoryReporterBuilder()
                        // 添加自定义Reporter
                        .withReporters(customStepReporter)
                        // 保留默认报告格式（比如HTML、控制台输出）
                        .withDefaultFormats());
    }
}

这里需要注意：你得在生成随机用户的步骤里，把生成的用户名存到Spring上下文的一个线程安全Bean里，比如用ThreadLocal避免多线程场景的数据污染：

@Component
public class RandomUserHolder {
    private final ThreadLocal<String> usernameHolder = new ThreadLocal<>();

    public void setUsername(String username) {
        usernameHolder.set(username);
    }

    public String getUsername() {
        return usernameHolder.get();
    }

    // 场景结束后清理数据
    public void clear() {
        usernameHolder.remove();
    }
}

方案2：在步骤方法里直接控制报告输出（最简单） #

如果你的步骤类已经能访问Spring上下文和StepReporter，也可以在步骤执行成功后直接输出修改后的描述。比如：

import org.jbehave.core.annotations.When;
import org.jbehave.core.reporters.StepReporter;
import org.springframework.beans.factory.annotation.Autowired;

public class LoginSteps {

    @Autowired
    private RandomUserHolder userHolder;
    @Autowired
    private StepReporter stepReporter;

    @When("login as random user")
    public void loginAsRandomUser() {
        // 生成随机用户名
        String username = generateRandomUsername();
        // 存储到Holder
        userHolder.setUsername(username);
        // 执行登录逻辑
        performLogin(username);
        // 直接输出修改后的步骤描述到报告
        stepReporter.successful("When login as random user (" + username + ")");
    }

    // 辅助方法
    private String generateRandomUsername() {
        return "user_" + System.currentTimeMillis();
    }

    private void performLogin(String username) {
        // 登录操作逻辑
    }
}

这种方式要注意：默认Reporter可能会输出两次原步骤和修改后的步骤，所以可以调整配置关闭默认的步骤输出，或者直接用方案1的方式覆盖原输出。

额外提醒 #

• 记得在场景结束后清理RandomUserHolder里的ThreadLocal数据，可以通过@AfterScenario注解实现：

@AfterScenario
public void cleanUp() {
    userHolder.clear();
}

• 如果是并行执行场景，ThreadLocal是必须的，避免不同场景的数据互相干扰。

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