Spring Batch如何实现reader、processor、writer启动时仅打印一次日志

问题根源 #

你当前使用的ItemProcessListener的beforeProcess方法是每条数据处理前都会触发，同理ItemReadListener的beforeRead是单条数据读取前触发、ItemWriteListener的beforeWrite是每chunk数据写入前触发，这就是日志重复打印的核心原因。你需要绑定整个Step生命周期仅触发一次的监听逻辑，即可满足需求。

实现方案 #

方案1：StepExecutionListener + 状态标记（通用方案，适配所有场景） #

StepExecutionListener的beforeStep方法在整个Step运行周期中仅执行1次，你可以直接在该方法中打印启动日志，也可以搭配状态标记实现首次执行业务逻辑时打印，同时适配多线程Step场景：

@Log4j2
@Component
public class ProcessorListener implements ItemProcessListener<Input, Output>, StepExecutionListener {
    // 原子布尔保证多线程场景下仅打印一次
    private final AtomicBoolean hasLogged = new AtomicBoolean(false);

    @Override
    public void beforeStep(StepExecution stepExecution) {
        // 每次Step启动重置标记，适配多次运行Job的场景
        hasLogged.set(false);
        // 若只需在Step初始化Processor时打印，直接在这里写日志即可，无需下面的判断
        log.info("step: processor初始化完成");
    }

    @Override
    public void beforeProcess(Input input) {
        // 若需要在第一次处理数据时才打印日志，加这个判断即可
        if (hasLogged.compareAndSet(false, true)) {
            log.info("step: 开始执行processor数据处理");
        }
    }

    // 原有其余方法保持不变
    @Override
    public void afterProcess(Input input, Output output) {}

    @Override
    public void onProcessError(Input input, Exception e) {}

    @Override
    public ExitStatus afterStep(StepExecution stepExecution) {
        return null;
    }
}

Reader、Writer组件的日志逻辑同理：

• Reader对应监听器实现ItemReadListener + StepExecutionListener
• Writer对应监听器实现ItemWriteListener + StepExecutionListener
  所有监听器都需要注册到Step的listener配置中，和你现有配置方式一致。

方案2：@StepScope + @PostConstruct（自定义组件场景更简洁） #

如果Reader、Processor、Writer是你自定义实现的业务类，可以直接在类上添加@StepScope注解，配合@PostConstruct实现组件初始化时仅打印一次日志，不需要额外编写监听器：

@StepScope
@Component
public class CustomReader implements ItemReader<Input> {
    
    @PostConstruct
    public void initLog() {
        log.info("step: reader启动完成");
    }

    @Override
    public Input read() throws Exception {
        // 原有读取逻辑
    }
}

注意：该方案必须搭配@StepScope使用，若组件为单例模式，@PostConstruct仅会在Spring容器启动时执行一次，多次运行Job不会重复打印日志。

适配场景说明 #

• 若你使用Spring Batch自带的通用读写组件（如JdbcCursorItemReader、FlatFileItemWriter等），无需自定义实现，直接使用方案1即可。
• 多线程Step场景下推荐使用方案1的原子布尔标记，避免线程安全问题导致重复打印。

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