使用@MockBean模拟含@BeforeStep的ItemReader时抛出多方法异常的解决办法

这个问题我之前也碰到过，核心原因是Spring Batch默认不允许单个bean存在多个标注了@BeforeStep的方法，而当你用@MockBean把自定义Reader放进Spring容器后，Spring Batch的StepExecutionListenerBeanPostProcessor会扫描到这些方法，直接抛出IllegalStateException。下面给你几个可行的解决思路：

方案一：合并Reader中的多个@BeforeStep方法（最推荐） #

其实Spring Batch的设计理念里，单个监听器类型（比如@BeforeStep）在一个bean中最好只保留一个方法。如果你的Reader里的两个@BeforeStep方法是做不同的初始化逻辑，完全可以把它们合并成一个方法，让代码结构更清晰的同时从根源解决问题：

public class Reader implements ItemReader<Integer> {
    private final Logger logger = LoggerFactory.getLogger(getClass());
    private Iterator<Integer> iterator;

    @Override
    public Integer read() throws Exception {
        if(iterator.hasNext()){
            return iterator.next();
        }
        return null;
    }

    @BeforeStep
    public void initAll(StepExecution stepExecution){
        // 原来第一个@BeforeStep方法的逻辑
        List<Integer> integerList = ...;
        iterator = integerList.iterator();
        // 原来第二个@BeforeStep方法的逻辑
        logger.info("Step {} initialized", stepExecution.getStepName());
    }
}

方案二：配置Spring Batch允许多个同类型监听方法 #

如果你因为某些原因不能修改Reader的代码，可以通过配置StepExecutionListenerBeanPostProcessor的allowMultiple属性为true，来关闭多方法检查：

@Configuration
public class BatchConfig {

    @Bean
    public StepExecutionListenerBeanPostProcessor stepExecutionListenerBeanPostProcessor() {
        StepExecutionListenerBeanPostProcessor processor = new StepExecutionListenerBeanPostProcessor();
        processor.setAllowMultiple(true); // 允许一个bean有多个@BeforeStep/@AfterStep方法
        return processor;
    }
}

不过要注意：这种情况下多个@BeforeStep方法的执行顺序是不确定的，如果你的业务逻辑依赖它们的执行顺序，这个方案可能不适用。

方案三：手动创建Mock，避免@MockBean的自动处理 #

如果不想修改Reader代码，也不想调整Spring Batch的全局配置，可以不用@MockBean，而是手动用Mockito创建Reader的mock实例，在测试中手动调用@BeforeStep方法，绕过Spring Batch的自动扫描：

@SpringBootTest
public class BatchJobTest {

    @Autowired
    private JobLauncherTestUtils jobLauncherTestUtils;

    // 不用@MockBean，手动创建mock
    private Reader mockReader;

    @BeforeEach
    void setUp() {
        mockReader = Mockito.mock(Reader.class);
        // 模拟read方法的返回行为
        Mockito.when(mockReader.read())
               .thenReturn(1, 2, 3, null);
    }

    @Test
    void testJob() throws Exception {
        // 获取测试用的StepExecution
        StepExecution stepExecution = jobLauncherTestUtils.getUniqueStepExecution();
        // 手动调用mockReader的@BeforeStep方法
        Method beforeStepMethod = Reader.class.getMethod("init", StepExecution.class);
        beforeStepMethod.invoke(mockReader, stepExecution);
        
        // 替换Job中的Reader为mock实例（如果用到@JobScope等特殊作用域，需额外处理）
        // 执行job测试逻辑...
    }
}

这种方式完全由你控制mock的行为和初始化逻辑，适合需要精细控制测试场景的情况。

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