Spring Batch应用进度条开发：如何获取总条目数或块数？

首先明确：Spring Batch支持获取总条目数，但能否获取取决于你使用的ItemReader类型，总块数可通过总条目数和块大小计算得出。

一、可获取总条目数的场景（分页式Reader） #

如果使用分页类型的ItemReader（如JdbcPagingItemReader、JpaPagingItemReader），这类Reader在初始化阶段会预先执行count查询获取总条目数，你可以通过以下方式获取：

1. 直接调用Reader的API
   以JdbcPagingItemReader为例，它提供了getTotalItems()方法（需先调用afterPropertiesSet()完成初始化）：

   JdbcPagingItemReader<YourEntity> reader = new JdbcPagingItemReader<>();
   // 配置reader的数据源、SQL、分页规则等
   reader.afterPropertiesSet();
   int totalItems = reader.getTotalItems();
   // 计算总块数，向上取整
   int totalChunks = (int) Math.ceil((double) totalItems / chunkSize);
   

2. 通过StepExecution传递总条目数
   可以在Reader初始化时，将总条目数存入StepExecution的ExecutionContext，后续在Listener中读取使用：

   @Bean
   public ItemReader<YourEntity> itemReader(DataSource dataSource, StepExecution stepExecution) {
       JdbcPagingItemReader<YourEntity> reader = new JdbcPagingItemReader<>();
       // 配置reader的SQL、分页参数等
       reader.setDataSource(dataSource);
       reader.setSql("SELECT id, name FROM your_table");
       SqlPagingQueryProviderFactoryBean queryProvider = new SqlPagingQueryProviderFactoryBean();
       queryProvider.setDataSource(dataSource);
       queryProvider.setSelectClause("SELECT id, name");
       queryProvider.setFromClause("FROM your_table");
       queryProvider.setSortKey("id");
       reader.setQueryProvider(queryProvider.getObject());
       reader.setPageSize(chunkSize);
       
       reader.afterPropertiesSet();
       int totalItems = reader.getTotalItems();
       // 将总条目数存入ExecutionContext
       stepExecution.getExecutionContext().putInt("totalItems", totalItems);
       return reader;
   }
   

二、无法获取总条目数的场景（流式Reader） #

如果使用流式ItemReader（如默认模式的FlatFileItemReader、JmsItemReader、KafkaItemReader），这类Reader是逐条读取数据，没有预先计数的机制，无法提前获取总条目数，自然也无法计算总块数。这种情况下，进度条只能展示已处理的条目数，无法显示百分比进度。

三、进度条实现思路 #

• 若能获取总条目数：在StepListener的beforeStep中拿到总条目数，在afterChunk事件中累加已处理的条目数，实时计算进度百分比。
• 若无法获取总条目数：仅展示已处理的条目数量，或结合业务场景预估大致范围（不推荐，误差较大）。

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