Spring Batch 1.x迁移至4.x时,存在Bean依赖的已移除Ibatis数据库Reader如何实现
Spring Batch 1.x 迁移至4.x 适配方案:替代已移除的IbatisDrivingQueryItemReader
核心问题
- Spring Batch 4.x 已完全移除原1.x版本提供的
org.springframework.batch.item.database.IbatisDrivingQueryItemReader类,配套的老iBatis(SqlMapClient)驱动查询相关实现不再随官方构件发布 - 原有业务执行链路存在严格的前后依赖:
withdrawalIbatisKeyGenerator(自定义类BatchKeyCollector)需优先执行,批量生成的业务主键集合将作为输入,传递给后续Reader完成全量业务明细的数据读取,两个Bean不可拆分并行
等价实现思路
Spring Batch 4.x 原生框架已内置对“先批量拉取主键集合,再逐主键查询明细”这类驱动查询模式的支持,完全可以覆盖原有功能,无需保留强依赖废弃类的Bean绑定关系:
- 若仍需兼容存量老iBatis的
sqlMapBean配置,可基于AbstractPagingItemReader/AbstractCursorItemReader自定义适配实现,将原KeyCollector的所有逻辑内嵌到Reader生命周期中 - 若后续计划升级到MyBatis 3.x,可直接使用框架原生的
MyBatisCursorItemReader/MyBatisPagingItemReader完成替换,零额外开发成本
具体迁移步骤
1. 原有业务逻辑解耦
把原废弃Reader和KeyCollector的强绑定关系拆分为独立的可复用逻辑:
- 抽离原
BatchKeyCollector的三类核心能力:- 主键批量查询:执行
withdrawalTransactionDao.getWithdrawalTransactionKey,按传入的定价日期、保单号、版本号、生效日期、批单类型等参数,拉取所有匹配的业务主键Map集合(对应原配置isKeyAMap=true) - 断点续跑:执行
withdrawalTransactionDao.restartWithdrawalTransaction,从上次执行中断的主键位置恢复读取,无需从头扫描全量数据 - 参数解析:兼容原配置里
%%参数名:类型:SQL字段的自定义参数占位符解析逻辑
- 主键批量查询:执行
- 保留原Reader的明细查询逻辑:执行
withdrawalTransactionDao.getWithdrawalTransaction,根据单条主键值查询对应的完整业务实体
2. 自定义Reader适配实现
基于Spring Batch 4.x 的AbstractCursorItemReader实现兼容类,完全对齐原执行流程:
- Reader初始化阶段,优先执行原KeyCollector的主键查询逻辑,将全量主键集合缓存到Reader内部成员变量中
- 断点恢复阶段:检测到Job是重启场景时,先调用原restartQueryId对应的SQL定位中断点,将缓存的主键列表截断到对应位置
- 数据读取循环阶段:每次从缓存中取出单条主键,调用原detailsQueryId对应的SQL查询完整业务明细后返回
- 状态持久化:将当前读取到的主键偏移量存入Job的ExecutionContext,复用框架原生的状态管理能力,替代原KeyCollector自行维护的中断状态
3. XML配置替换
原有两个Bean的配置可以合并为单个自定义Reader配置,移除对废弃类的依赖:
<bean id="ibatisWithdrawalReader" class="com.xxx.batch.CompatIbatisDrivingQueryItemReader"> <!-- 原明细查询配置 --> <property name="detailsQueryId" value="withdrawalTransactionDao.getWithdrawalTransaction" /> <property name="sqlMapClient" ref="sqlMap" /> <!-- 原KeyCollector的配置全量迁移 --> <property name="drivingKeyQueryId" value="withdrawalTransactionDao.getWithdrawalTransactionKey" /> <property name="restartQueryId" value="withdrawalTransactionDao.restartWithdrawalTransaction" /> <property name="queryParameters"> <list> <value>%%pricing_date_ibatis:date:pricing_date</value> <value>%%policy_number:string:pol_no</value> <value>%%version_no:string:version_no</value> <value>%%start_date:date:start_dt</value> <value>%%endt_type:string:endt_code</value> </list> </property> <property name="keyAsMap" value="true" /> </bean>
迁移注意事项
- 原自定义
BatchKeyCollector里的参数占位符解析逻辑需要原样迁移到自定义Reader中,不需要修改存量iBatis的SQL映射配置 - 自定义Reader的游标大小、单次拉取的主键批量数要和原IbatisDrivingQueryItemReader的默认值保持一致,避免单次查询拉取过多数据导致内存溢出
- 迁移完成后需验证断点续跑能力:在Job执行过程中手动终止任务,重启后需从上次中断的位置继续读取,不能重复处理已提交的业务数据
内容的提问来源于stack exchange,提问作者Rachel
相关产品推荐
相关产品推荐

