本文详解如何正确测试 spring batch 中带 @beforestep 注解的 @stepscope bean，解决因作用域未激活导致的 npe 问题，并提供可运行的 junit 5 + spring batch 5 完整示例。
本文详解如何正确测试 spring batch 中带 @beforestep 注解的 @stepscope bean，解决因作用域未激活导致的 npe 问题，并提供可运行的 junit 5 + spring batch 5 完整示例。
在 Spring Batch 中，@StepScope Bean 的生命周期严格绑定于 Step 执行上下文——其字段注入（如 @Value("#{jobParameters['date']}")）、@BeforeStep 回调、以及代理行为，均依赖 StepExecution 的存在。直接 @Autowired 注入 Step-scoped Bean 并调用方法（如 read()），会导致 someService 为 null、date 未解析、@BeforeStep 完全不执行，最终触发 NullPointerException（NPE）。这并非代码缺陷，而是作用域机制的必然表现。
要正确测试此类组件，必须显式模拟 Step 执行上下文，并确保 Spring 的 Step Scope 代理机制被激活。核心步骤如下：
- 准备 JobParameters 和 StepExecution：使用 JobParametersBuilder 构建含所需参数（如 "date"）的 JobParameters，再通过 MetaDataInstanceFactory.createStepExecution(jobParameters) 创建已绑定参数的 StepExecution；
- 声明 Bean 方式注册 Reader：避免直接 @Component + @StepScope（测试中难以控制代理），改用 @Configuration 类中 @Bean + @StepScope 显式定义，确保 Spring 能为其创建正确的范围代理；
- 使用 StepScopeTestUtils.doInStepScope()：这是 Spring Batch Test 模块提供的关键工具，它临时将当前线程绑定到指定 StepExecution，触发 @BeforeStep、完成 @Value 解析，并以代理方式调用目标方法。
以下为完整、可运行的测试示例（适配 Spring Batch 5.x + JUnit 5）：
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.JobParametersBuilder;
import org.springframework.batch.core.StepExecution;
import org.springframework.batch.core.configuration.annotation.StepScope;
import org.springframework.batch.item.support.IteratorItemReader;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.batch.test.MetaDataInstanceFactory;
import org.springframework.batch.test.StepScopeTestUtils;
import java.time.LocalDate;
import java.util.List;
@ExtendWith(SpringExtension.class)
class SomeItemReaderTest {
@Autowired
private SomeItemReader someItemReader;
@Test
void read() throws Exception {
// Given: 构建含 'date' 参数的 JobParameters
JobParameters jobParameters = new JobParametersBuilder()
.addString("date", "2024-01-01")
.toJobParameters();
StepExecution stepExecution = MetaDataInstanceFactory.createStepExecution(jobParameters);
// When & Then: 在 Step 上下文中执行 read()，自动触发 @BeforeStep 和参数注入
String firstItem = StepScopeTestUtils.doInStepScope(stepExecution, someItemReader::read);
assert firstItem != null : "Expected non-null item after @BeforeStep initialization";
}
@Configuration
static class TestConfig {
@Bean
@StepScope
SomeItemReader someItemReader(SomeService someService) {
return new SomeItemReader(someService);
}
// 模拟 SomeService 实现（测试中需替换为真实或 Mock 实例）
@Bean
SomeService someService() {
return date -> List.of("item1", "item2", "item3"); // 返回固定列表供 init() 使用
}
// 必须显式注册 StepScope（若未启用 EnableBatchProcessing）
@Bean
org.springframework.batch.core.scope.StepScope stepScope() {
return new org.springframework.batch.core.scope.StepScope();
}
}
}
// 重构后的 Reader（推荐构造器注入 + 显式初始化）
@Slf4j
@StepScope
class SomeItemReader extends IteratorItemReader<string> {
@Value("#{jobParameters['date']}")
private String date;
private final SomeService someService;
public SomeItemReader(SomeService someService) {
super(List.of()); // 占位，实际由 init() 设置
this.someService = someService;
}
@BeforeStep
public void init(StepExecution stepExecution) {
try {
List<string> list = someService.getList(LocalDate.parse(date));
setItems(list); // IteratorItemReader 提供的安全设置方式
} catch (Exception e) {
log.error("Failed to initialize reader for date: {}", date, e);
throw new RuntimeException("Reader initialization failed", e);
}
}
}
interface SomeService {
List<string> getList(LocalDate date);
}</string></string></string>
关键注意事项：
- ✅ StepScopeTestUtils.doInStepScope() 是测试 Step Scope Bean 的唯一可靠方式，不可省略；
- ✅ JobParameters 必须包含 @Value 所引用的所有键（如 "date"），否则 SpEL 解析失败；
- ✅ 避免在测试类中 @Autowired @Component + @StepScope 的类——它无法被正确代理；务必通过 @Configuration 的 @Bean 声明；
- ✅ 若使用 IteratorItemReader 等基类，优先调用 setItems() 而非手动操作内部列表，确保线程安全与状态一致性；
- ⚠️ @BeforeStep 方法签名可选 StepExecution 参数（如上例），便于日志或上下文访问，但非必需。
通过以上结构，即可彻底规避 NPE，精准验证 Step-scoped 组件在真实批处理流程中的行为。
