Spring Batch手动配置时@StepScope报“No Scope registered”错误

问题根源 #

不使用@EnableBatchProcessing时，Spring Batch不会自动注册StepScope和JobScope这两个自定义作用域，仅手动声明StepScope Bean不足以让Spring识别该作用域，导致依赖@StepScope的组件无法正确初始化。

解决方案 #

1. 显式注册Batch作用域

使用CustomScopeConfigurer将StepScope和JobScope注册到Spring的作用域注册表中，注意该配置类需为static Bean（因为CustomScopeConfigurer是BeanFactoryPostProcessor，需在其他Bean实例化前生效）：

@Configuration
public class BatchManualConfig {

    @Bean
    public static CustomScopeConfigurer batchScopeConfigurer() {
        CustomScopeConfigurer configurer = new CustomScopeConfigurer();
        Map<String, Object> scopes = new HashMap<>();
        scopes.put("step", new StepScope());
        scopes.put("job", new JobScope());
        configurer.setScopes(scopes);
        return configurer;
    }

    // 其他Batch核心Bean配置...
}

2. 手动配置Spring Batch核心组件

必须自行提供JobRepository、JobLauncher等核心Bean（替代@EnableBatchProcessing的自动创建逻辑）：

@Bean
public JobRepository jobRepository(DataSource dataSource, PlatformTransactionManager transactionManager) throws Exception {
    JobRepositoryFactoryBean factoryBean = new JobRepositoryFactoryBean();
    factoryBean.setDataSource(dataSource);
    factoryBean.setTransactionManager(transactionManager);
    factoryBean.setDatabaseType("POSTGRES"); // 根据你的数据库类型调整（如MYSQL、ORACLE）
    factoryBean.setTablePrefix("BATCH_"); // 可选，若你的Batch表有前缀
    return factoryBean.getObject();
}

@Bean
public JobLauncher jobLauncher(JobRepository jobRepository) throws Exception {
    SimpleJobLauncher jobLauncher = new SimpleJobLauncher();
    jobLauncher.setJobRepository(jobRepository);
    // 可选：设置任务执行器，支持异步作业
    jobLauncher.setTaskExecutor(new SimpleAsyncTaskExecutor());
    return jobLauncher;
}

3. 正确配置@StepScope的Reader/Processor/Writer

在需要访问Job参数的组件上添加@StepScope注解，并通过@Value注入Job参数：

@Bean
@StepScope
public ItemReader<Invoice> consInvoiceReader(@Value("#{jobParameters['invoiceId']}") String invoiceId) {
    FlatFileItemReader<Invoice> reader = new FlatFileItemReader<>();
    // 配置reader的资源、行映射等逻辑，使用注入的invoiceId参数
    reader.setResource(new ClassPathResource("invoices/" + invoiceId + ".csv"));
    reader.setLineMapper(new DefaultLineMapper<Invoice>() {{
        setLineTokenizer(new DelimitedLineTokenizer() {{
            setNames("id", "amount", "date");
        }});
        setFieldSetMapper(new BeanWrapperFieldSetMapper<Invoice>() {{
            setTargetType(Invoice.class);
        }});
    }});
    return reader;
}

4. 正确构建Step和Job

确保Step和Job的构建依赖正确的核心组件，关联@StepScope的组件：

@Bean
public Step transformStep(JobRepository jobRepository, PlatformTransactionManager transactionManager,
                          ItemReader<Invoice> consInvoiceReader, ItemProcessor<Invoice, ProcessedInvoice> invoiceProcessor,
                          ItemWriter<ProcessedInvoice> invoiceWriter) {
    return new StepBuilder("transformStep", jobRepository)
            .<Invoice, ProcessedInvoice>chunk(50, transactionManager)
            .reader(consInvoiceReader)
            .processor(invoiceProcessor)
            .writer(invoiceWriter)
            .build();
}

@Bean
public Job consInvoiceJob(JobRepository jobRepository, Step transformStep) {
    return new JobBuilder("consInvoiceJob", jobRepository)
            .start(transformStep)
            .build();
}

关键注意事项 #

• 确保CustomScopeConfigurer是static Bean，否则作用域无法在Bean实例化前注册，导致@StepScope失效。
• 不要混淆Step的名称和作用域名称：错误信息中出现的transformStep作为作用域名，通常是因为未正确注册step作用域，Spring尝试将Step名称当作作用域解析。
• 手动提供的PlatformTransactionManager需与现有应用的事务管理器一致，避免冲突。

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