如何在Spring Batch ItemReader中正确访问JobParameters并解决初始化报错？

问题根源 #

你的CustomDataReader构造函数执行时机早于@StepScope属性注入和@BeforeStep方法调用，此时collectionName为null，调用setCollection(collectionName)会直接导致Mongo读取器初始化失败，触发你遇到的两类错误：

"Failed to initialize the reader: Cannot determine collection name from type 'org.bson.Document'. Is it a store native type?"
"Error while closing item reader. Cannot invoke "org.springframework.data.util.CloseableIterator.close()" because "this.cursor" is null"

解决方案（仅修改Reader） #

将依赖JobParameters的配置逻辑延迟到属性注入完成后执行，可选择以下两种方式：

方式一：使用@PostConstruct（推荐）

利用Spring的@PostConstruct注解，在所有属性注入完成后再设置集合名称：

@Getter
@Setter
@StepScope
@Component
public class CustomDataReader extends MongoCursorItemReader<Document> {

    @Value("#{jobParameters['collectionName']}")
    private String collectionName;

    // 补充默认常量的定义（根据实际业务调整）
    private static final int DEFAULT_CHUNK_SIZE = 100;
    private static final int DEFAULT_LIMIT_SIZE = 1000;
    private Query query = new Query(); // 根据实际需求初始化查询条件

    public CustomDataReader(@Qualifier("mongoTemplate") MongoTemplate mongoTemplate) {
        setName("customDataReader");
        setTargetType(Document.class);
        setTemplate(mongoTemplate);
        setBatchSize(DEFAULT_CHUNK_SIZE);
        setLimit(DEFAULT_LIMIT_SIZE);
        setQuery(query);
        // 移除构造函数中的setCollection调用，避免传入null
    }

    @PostConstruct
    public void initReader() {
        // 属性注入完成后，安全设置集合名称
        setCollection(collectionName);
    }
}

方式二：调整@BeforeStep逻辑

保留@BeforeStep，但移除构造函数中的setCollection调用，确保集合名称在Step启动前才被设置：

@Getter
@Setter
@StepScope
@Component
public class CustomDataReader extends MongoCursorItemReader<Document> {

    @Value("#{jobParameters['collectionName']}")
    private String collectionName;

    private static final int DEFAULT_CHUNK_SIZE = 100;
    private static final int DEFAULT_LIMIT_SIZE = 1000;
    private Query query = new Query();

    public CustomDataReader(@Qualifier("mongoTemplate") MongoTemplate mongoTemplate) {
        setName("customDataReader");
        setTargetType(Document.class);
        setTemplate(mongoTemplate);
        setBatchSize(DEFAULT_CHUNK_SIZE);
        setLimit(DEFAULT_LIMIT_SIZE);
        setQuery(query);
        // 移除构造函数中的setCollection调用
    }

    @BeforeStep
    public void beforeStep(final StepExecution stepExecution) {
        // 直接使用已注入的collectionName，无需重复从StepExecution获取
        setCollection(collectionName);
    }
}

关键说明 #

1. @StepScope的Bean属性注入发生在构造函数执行之后，因此构造函数中无法直接获取JobParameters注入的值。
2. 两种方式都确保了setCollection在collectionName有有效值时才被调用，避免了初始化阶段的空值错误。
3. 如果你的query也依赖JobParameters，同样需要用上述方式延迟设置，避免类似问题。

内容的提问来源于stack exchange，提问作者Murat Yıldız