如何在SpringBatch测试的when().thenReturn()中Mock私有方法

问题场景 #

我在Spring Batch配置类EodDataDumpSpringBatchConfig中定义了一个私有方法getWriterResource，代码如下：

@Slf4j
public class EodDataDumpSpringBatchConfig {

    private Resource getWriterResource(StepExecution stepExecution, Storage storage) {
        String chunkUri = stepExecution.getJobParameters().getString(EodDataDumpConstants.CHUNK_URI);
        String fileUri = chunkUri + stepExecution.getStepName();
        Resource resource = new GoogleStorageResource(storage, fileUri);
        return resource;
    }

    // 其他业务代码...

}

当前编写Spring Batch测试类时，希望Mock这个私有方法，让它被调用时返回指定的Resource对象，测试类代码如下：

@SpringBatchTest
@EnableAutoConfiguration
@SpringJUnitConfig({EodDataDumpSpringBatchConfig.class})
@ExtendWith(MockitoExtension.class)
@TestPropertySource(locations = "classpath:application.properties")
@MockitoSettings(strictness = Strictness.LENIENT)
public class EodDataDumpSpringBatchTest {

    @Value("file:src/test/resources/storageFile.csv")
    private Resource resource;

    @Test
    public void dataDumpJobEndToEndTest() throws Exception {
        
    }

}

尝试过ReflectionUtils和PowerMock但未解决问题，请问该如何实现？

解决方案 #

优先方案：重构代码（更优雅的测试实践） #

Mock私有方法通常是代码设计的信号——该方法的职责可以抽离为独立组件，让测试更简单且符合面向接口原则。

1. 抽离资源获取逻辑为独立组件

// 定义接口
public interface ResourceProvider {
    Resource getWriterResource(StepExecution stepExecution, Storage storage);
}

// 实现类
public class GoogleStorageResourceProvider implements ResourceProvider {
    @Override
    public Resource getWriterResource(StepExecution stepExecution, Storage storage) {
        String chunkUri = stepExecution.getJobParameters().getString(EodDataDumpConstants.CHUNK_URI);
        String fileUri = chunkUri + stepExecution.getStepName();
        return new GoogleStorageResource(storage, fileUri);
    }
}

2. 修改配置类，通过构造注入依赖

@Slf4j
public class EodDataDumpSpringBatchConfig {

    private final ResourceProvider resourceProvider;

    // 构造注入资源提供者
    public EodDataDumpSpringBatchConfig(ResourceProvider resourceProvider) {
        this.resourceProvider = resourceProvider;
    }

    // 原调用私有方法的位置，改为调用resourceProvider的方法
    // ...
}

3. 测试时直接Mock接口

@SpringBatchTest
@EnableAutoConfiguration
@SpringJUnitConfig(classes = {EodDataDumpSpringBatchConfig.class})
@ExtendWith(MockitoExtension.class)
@TestPropertySource(locations = "classpath:application.properties")
@MockitoSettings(strictness = Strictness.LENIENT)
public class EodDataDumpSpringBatchTest {

    @Value("file:src/test/resources/storageFile.csv")
    private Resource resource;

    // Mock资源提供者接口
    @MockBean
    private ResourceProvider resourceProvider;

    @BeforeEach
    void setUp() {
        // 指定方法调用返回的资源对象
        when(resourceProvider.getWriterResource(any(StepExecution.class), any(Storage.class)))
                .thenReturn(resource);
    }

    @Test
    public void dataDumpJobEndToEndTest() throws Exception {
        // 执行你的测试逻辑
    }

}

这种方式无需处理私有方法的反射问题，代码结构更清晰，也符合Spring的依赖注入设计理念。

备选方案：直接Mock私有方法（不推荐） #

如果因限制无法重构，可使用PowerMock实现，但需注意版本兼容性：

JUnit 4 版本配置

@SpringBatchTest
@EnableAutoConfiguration
@SpringJUnitConfig({EodDataDumpSpringBatchConfig.class})
@RunWith(PowerMockRunner.class)
@PowerMockRunnerDelegate(SpringJUnit4ClassRunner.class) // 整合Spring测试环境
@PrepareForTest(EodDataDumpSpringBatchConfig.class) // 指定要Mock的目标类
@TestPropertySource(locations = "classpath:application.properties")
@MockitoSettings(strictness = Strictness.LENIENT)
public class EodDataDumpSpringBatchTest {

    @Value("file:src/test/resources/storageFile.csv")
    private Resource resource;

    @Autowired
    private EodDataDumpSpringBatchConfig config;

    @Test
    public void dataDumpJobEndToEndTest() throws Exception {
        // 创建配置类的Spy对象
        EodDataDumpSpringBatchConfig configSpy = PowerMockito.spy(config);

        // Mock私有方法，指定返回值
        PowerMockito.doReturn(resource)
                .when(configSpy, "getWriterResource", any(StepExecution.class), any(Storage.class));

        // 若需将Spy对象替换到Spring上下文，可通过反射工具类实现
        // 后续执行测试逻辑
    }

}

JUnit 5 版本配置

@SpringBatchTest
@EnableAutoConfiguration
@SpringJUnitConfig({EodDataDumpSpringBatchConfig.class})
@ExtendWith({PowerMockExtension.class, SpringExtension.class})
@PrepareForTest(EodDataDumpSpringBatchConfig.class)
@TestPropertySource(locations = "classpath:application.properties")
@MockitoSettings(strictness = Strictness.LENIENT)
public class EodDataDumpSpringBatchTest {

    @Value("file:src/test/resources/storageFile.csv")
    private Resource resource;

    @Autowired
    private EodDataDumpSpringBatchConfig config;

    @Test
    public void dataDumpJobEndToEndTest() throws Exception {
        EodDataDumpSpringBatchConfig configSpy = PowerMockito.spy(config);
        PowerMockito.doReturn(resource)
                .when(configSpy, "getWriterResource", any(StepExecution.class), any(Storage.class));

        // 执行测试逻辑
    }

}

注意：PowerMock与Spring Boot、JUnit版本兼容性较强，需确保使用的PowerMock版本与项目依赖版本匹配，否则易出现初始化异常。

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