Spring Batch使用StepScope注解后ItemWriter无输出问题排查

核心错误点 #

你的代码有两个关键问题导致加@StepScope后输出为空：

1. 手动调用reader(null)绕过了Spring的Scope代理机制 #

在Step的定义中，你直接调用reader(null)创建实例，完全跳过了Spring对@StepScope bean的代理逻辑。加@StepScope后，Spring本应在Step执行时才实例化reader并自动注入jobParameters中的fileName，但手动调用方法传null会生成一个未被Spring管理的实例，导致@Value("#{jobParameters['fileName']}")完全不生效，最终读不到源文件数据，输出自然为空。

2. 异常被吞掉导致初始化失败无提示 #

reader方法的try-catch块捕获了所有异常但未抛出，即使fileName为空、文件不存在或BeanIO配置错误，程序也不会终止，只会返回一个未正确初始化的reader实例，该实例无法读取任何数据，却能让作业流程“正常”执行完毕，最终输出空文件。

修复后的代码 #

修改ItemReader的异常处理 #

@Bean
@StepScope
public ItemReader<Contact> reader(@Value("#{jobParameters['fileName']}") String fileName) {             
    
    BeanIOFlatFileItemReader<Contact> reader = new BeanIOFlatFileItemReader<>();
    try {           
        reader.setUseSpringExceptions(true);
        reader.setResource(new FileSystemResource(fileName));
        reader.setStreamName(inputContactStreamName);
        reader.setStreamMapping(new ClassPathResource(beanIoConfigurationXmlPath));
        reader.setStreamFactory(StreamFactory.newInstance());
        reader.getLineNumber();
        reader.afterPropertiesSet();
    } catch (Exception e) {
        log.error("ERROR: An issue occurred in the BeanIO Item Reader:: {} {}", e.getMessage(), e.getStackTrace());
        // 抛出异常让Spring Batch感知初始化失败，避免无数据静默执行
        throw new IllegalStateException("Failed to initialize BeanIOFlatFileItemReader", e);
    }
    
    return reader;      
}

修改Step的配置，使用Spring注入的reader实例 #

@Bean
public Step step(ItemReader<Contact> reader) {      
    return stepBuilderFactory.get("step")
      .<Contact, Contact> chunk(10)
      .reader(reader) // 直接使用Spring注入的StepScope代理实例，不要手动调用reader(null)
      .processor(contactItemProcessor)
      .writer(writer())          
      .build();
}

额外注意事项 #

启动作业时必须传入fileName参数，确保jobParameters中存在该键值对，否则@Value会抛出异常（此时抛出的异常能帮你快速定位参数缺失问题）。

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