Spring Batch：RepositoryItemReader读取JobExecution Context参数的最佳方法

这个问题我之前在项目里也碰到过，核心矛盾就是@PostConstruct的执行时机早于@BeforeStep，导致初始化RepositoryItemReader时还拿不到JobContext里的值。下面给你两种最实用的实现方式，按需选择：

方法一：利用Step Scope延迟初始化（推荐，简洁高效） #

Spring Batch提供了@StepScope注解，标记为该作用域的bean会延迟到Step执行前才初始化，这时候JobExecution Context已经可以访问了。直接通过@Value就能注入JobContext里的值，然后动态配置RepositoryItemReader的参数。

示例代码：

@Configuration
@EnableBatchProcessing
public class BatchConfig {

    // 定义Step Scope的RepositoryItemReader
    @Bean
    @StepScope
    public RepositoryItemReader<MyEntity> myStep2Reader(MyRepository myRepository,
                                                        @Value("#{jobExecutionContext['yourKeyFromStep1']}") String targetValue) {
        RepositoryItemReader<MyEntity> reader = new RepositoryItemReader<>();
        
        // 配置Repository和查询方法
        reader.setRepository(myRepository);
        reader.setMethodName("findByTargetValue"); // 你的Repository查询方法名
        
        // 设置查询参数（对应Repository方法的参数名）
        Map<String, Object> parameters = new HashMap<>();
        parameters.put("targetValue", targetValue);
        reader.setParameterValues(parameters);
        
        // 其他必要配置，比如分页大小
        reader.setPageSize(20);
        reader.setSort(Map.of("id", Sort.Direction.ASC));
        
        return reader;
    }

    // 后续配置Step2，使用上面的reader即可
    @Bean
    public Step step2(StepBuilderFactory stepBuilderFactory,
                      RepositoryItemReader<MyEntity> myStep2Reader,
                      MyItemProcessor processor,
                      MyItemWriter writer) {
        return stepBuilderFactory.get("step2")
                .<MyEntity, MyDto>chunk(20)
                .reader(myStep2Reader)
                .processor(processor)
                .writer(writer)
                .build();
    }
}

这种方式完全利用Spring Batch的原生特性，代码简洁，不需要额外的Listener逻辑，是最推荐的方案。

方法二：自定义Reader实现StepExecutionListener（灵活适配复杂场景） #

如果你的业务逻辑比较复杂，比如需要在读取前做一些额外的参数处理，可以自定义一个Reader，实现StepExecutionListener接口，在beforeStep方法中获取JobContext的值，再动态设置到RepositoryItemReader的参数里。

示例代码：

@Component
public class CustomStep2Reader extends RepositoryItemReader<MyEntity> implements StepExecutionListener {

    @Autowired
    public void setMyRepository(MyRepository myRepository) {
        // 提前配置Repository和查询方法，不用@PostConstruct
        super.setRepository(myRepository);
        super.setMethodName("findByTargetValue");
        super.setPageSize(20);
        super.setSort(Map.of("id", Sort.Direction.ASC));
    }

    @Override
    public void beforeStep(StepExecution stepExecution) {
        // 从JobExecution Context中获取Step1存入的值
        String targetValue = stepExecution.getJobExecution()
                .getExecutionContext()
                .getString("yourKeyFromStep1");
        
        // 动态设置查询参数
        Map<String, Object> parameters = new HashMap<>();
        parameters.put("targetValue", targetValue);
        super.setParameterValues(parameters);
    }

    // 可选：实现afterStep方法做清理工作
    @Override
    public ExitStatus afterStep(StepExecution stepExecution) {
        return ExitStatus.COMPLETED;
    }
}

然后在Step配置中使用这个自定义Reader：

@Bean
public Step step2(StepBuilderFactory stepBuilderFactory,
                  CustomStep2Reader customStep2Reader,
                  MyItemProcessor processor,
                  MyItemWriter writer) {
    return stepBuilderFactory.get("step2")
            .<MyEntity, MyDto>chunk(20)
            .reader(customStep2Reader)
            .processor(processor)
            .writer(writer)
            .listener(customStep2Reader) // 注册Listener（如果Spring没自动识别的话）
            .build();
}

关键注意点 #

1. 确保Repository的查询方法参数名和parameterValues中的key一致，比如方法是List<MyEntity> findByTargetValue(String targetValue)，那么参数key必须是targetValue。
2. 使用@StepScope时，必须确保配置类上标注了@EnableBatchProcessing，Spring Batch会自动注册StepScope的bean定义。
3. JobContext中的键要和Step1存入的键完全一致，避免拼写错误。

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