Spring Batch：ItemReader等组件是否需标注@StepScope？示例疑问解析

核心问题 #

• 定义ItemReader、ItemProcessor、ItemWriter时，是否必须添加@StepScope注解？
• 示例中的LineReader仅存在一个实例，且包含成员变量fu，在多线程环境下会不会引发线程安全问题？为什么教程里不给它标注@StepScope？

相关代码 #

ChunksConfig.java #

....
    @Bean // 这里没有@StepScope，但我觉得应该加
    public ItemReader<Line> itemReader() {
        return new LineReader();
    }

    @Bean
    protected Step processLines(ItemReader<Line> reader, ItemProcessor<Line, Line> processor, ItemWriter<Line> writer) {
        return steps.get("processLines").<Line, Line> chunk(2)
          .reader(reader)
          .processor(processor)
          .writer(writer)
          .build();
    }
....

LineReader.java #

public class LineReader implements ItemReader<Line>, StepExecutionListener {

    private final Logger logger = LoggerFactory.getLogger(LineReader.class);
    private FileUtils fu;

    @Override
    public void beforeStep(StepExecution stepExecution) {
        fu = new FileUtils("taskletsvschunks/input/tasklets-vs-chunks.csv");
        logger.debug("Line Reader initialized.");
    }

    @Override
    public Line read() throws Exception {
        Line line = fu.readLine();
        if (line != null) logger.debug("Read line: " + line.toString());
        return line;
    }

    @Override
    public ExitStatus afterStep(StepExecution stepExecution) {
        fu.closeReader();
        logger.debug("Line Reader ended.");
        return ExitStatus.COMPLETED;
    }
}

问题解答 #

1. @StepScope是否必须添加？ #

不是必须的，要分场景判断：

• 如果组件是无状态的，或者状态是在每个step执行时才初始化（比如示例里的fu），单实例就能正常工作，不需要加@StepScope。
• 但如果组件需要依赖step级动态参数（比如从job parameters取值），或者需要每个step执行时生成新实例（比如多step复用同一组件类、多线程step场景），那就必须加@StepScope，否则会出现参数注入失败、线程安全问题。

2. LineReader的线程安全与无@StepScope的原因 #

先看线程安全：
示例中的LineReader虽是单实例，但成员变量fu是在beforeStep方法里初始化的——而beforeStep是每个step执行前由当前step的线程调用，且step执行期间read方法也由同一个线程调用（Spring Batch的chunk step默认是单线程执行）。所以单线程场景下，不会有多个线程同时操作同一个fu的情况，自然不会有线程安全问题。

再看为什么没加@StepScope：
这个示例是单线程的简单场景，LineReader的状态在step执行时初始化，且没有依赖step级动态参数，单实例完全能正常工作，因此不需要加@StepScope。但如果把这个step改成多线程执行（比如配置自定义taskExecutor），单实例的LineReader就会出问题——多个线程共用同一个实例，fu会被交替初始化、读写，必然引发线程安全问题，这时候就必须给LineReader加上@StepScope，让每个线程拿到独立的实例。

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