一、JdbcCursorItemReader结构及关键属性
JdbcCursorItemReader将数据库记录转换为Java对象时主要有两步工作:首先根据PreparedStatement从数据库中获取结果集ResultSet;然后使用RowMapper将结果集ResultSet转换为Java对象。
二、关键接口、类和关键属性
1.JdbcCursorItemReader关键接口、类
关键类 | 说明 |
DataSource | 提供读取数据库的数据源信息 |
PreparedStatement | PreparedStatement实例包含已编译的SQL语句,并提供执行SQL语句的能力,返回结果集ResultSet |
PreparedStatementSetter | 负责为PreparedStatement中的SQL提供参数支持 |
RowMapper | 负责将结果集ResultSet转换为Java对象 |
2.JdbcCursorItemReader关键属性
属性 | 类型 | 说明 |
dataSource | DataSource | 数据源,通过该属性指定使用的数据库信息 |
driverSupportsAbsolute | Boolean | 数据库驱动是否支持结果集的绝对定位。 默认值:false |
fetchSize | int | 设置ResultSet每次向数据库取的行数;setFetchSize的意思是当调用rs.next时,ResultSet会一次性从服务器上取多少行数据回来,这样在下次rs.next时,可以直接从内存中获取数据而不需要网络交互,提高了效率。 默认值:-1 |
ignoreWarnings | Boolean | 是否忽略SQL执行期间的警告信息,true表示忽略警告,false表示会抛出异常。 默认值:true |
maxRows | int | 设置结果集做大行数。 默认值:-1(表示不限制) |
preparedStatementSetter | PreparedStatementSetter | SQL语句参数准备,可以使用批处理框架提供的ListPreparedStatementSetter,也可以自定义实现该类接口 |
queryTimeout | int | 查询超时时间。如果超时,将抛出超时异常。 默认值:-1(表示永不超时) |
rowMapper | RowMapper | 将结果集ResultSet转换为指定的Pojo对象类;需要实现RowMapper接口;默认可以使用BeanPropertyRowMapper |
saveState | Boolean | 是否将当前Reader的状态保存到Job Repository中,即当前读取到数据库的行数;在操作ItemStream#update()中被持久化。 默认值:true |
sql | String | 需要执行的SQL语句 |
useSharedExtendedConnection | Boolean | 不同游标是否共享数据库连接;如果共享则必须在同一个事务当中,否则使用不同的事务。 默认:false |
verifyCursorPosition | Boolean | 处理完当前行后,是否校验游标位置。 默认值:true |
三、配置JdbcCursorItemReader
使用JdbcCursorItemReader至少需要配置dataSource、sql、rowMapper三个属性:dataSource指定访问的数据源,sql用于指定查询的SQL语句,rowMapper用于将结果集ResultSet转换为Java业务。
<!-- 读取db --> <bean id="jdbcItemReader" scope="step" class="org.springframework.batch.item.database.JdbcCursorItemReader" > <!--指定访问的数据源--> <property name="dataSource" ref="dataSource"/> <!--指定查询的SQL语句--> <property name="sql" value="select ID,ACCOUNTID,NAME,AMOUNT,DATE,ADDRESS from t_credit where id between 1 and 5 "/> <!--用于将指定结果集ResultSet转换为Java业务对象,即CreditBill--> <property name="rowMapper"> <bean class="org.springframework.jdbc.core.BeanPropertyRowMapper"> <property name="mappedClass" value="com.xj.demo26.CreditBill"/> </bean> </property> </bean>
配置数据源:
<!--数据源-->
<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<property name="driverClassName">
<value>${datasource.driver}</value>
</property>
<property name="url">
<value>${datasource.url}</value>
</property>
<property name="username" value="${datasource.username}"></property>
<property name="password" value="${datasource.password}"></property>
</bean>
数据库参数:
1>mysql版本为5.1.25时:
2>mysql版本为8.0.20时:
四、RowMapper
1.框架提供的BeanPropertyRowMapper
<!-- 读取db --> <bean id="jdbcItemReader" scope="step" class="org.springframework.batch.item.database.JdbcCursorItemReader" > <!--指定访问的数据源--> <property name="dataSource" ref="dataSource"/> <!--指定查询的SQL语句--> <property name="sql" value="select ID,ACCOUNTID,NAME,AMOUNT,DATE,ADDRESS from t_credit where id between 1 and 5 "/> <!--用于将指定结果集ResultSet转换为Java业务对象,即CreditBill--> <property name="rowMapper"> <bean class="org.springframework.jdbc.core.BeanPropertyRowMapper"> <property name="mappedClass" value="com.xj.demo26.CreditBill"/> </bean> </property> </bean>
使用Spring Batch提供的BeanPropertyRowMapper完成将结果集ResultSet转换为CreditBill对象,通过设置属性mappedClass,自动将结果集ResultSet和CreditBill对象映射(即将表中的字段名称映射到CreditBill对象的属性中)。
项目实例:
Spring Batch之读数据库——JdbcCursorItemReader之使用框架提供的BeanPropertyRowMapper(三十六)_人……杰的博客-CSDN博客
2.自定义RowMapper
通过实现接口org.springframework.jdbc.core.RowMapper<T>,可以自定义RowMapper的实现类。RowMapper接口为:
public interface RowMapper<T> {
T mapRow(ResultSet var1, int var2) throws SQLException;
}
- mapRow():核心转换法,参数为结果集和当前游标所在的位置。
实现类CreditBillRowMapper.java:
package com.xj.demo28;
import org.springframework.jdbc.core.RowMapper;
import java.sql.ResultSet;
import java.sql.SQLException;
/**
* @Author : xjfu
* @Date : 2023/7/17 01:31
* @Description : 自定义RowMapper实现CreditBillRowMapper,将给定的结果集ResultSet转化为CreditBill对象
*/
public class CreditBillRowMapper implements RowMapper<CreditBill> {
public CreditBill mapRow(ResultSet rs, int rowNum) throws SQLException {
CreditBill bill = new CreditBill();
bill.setAccountID(rs.getString("ACCOUNTID"));
bill.setAddress(rs.getString("ADDRESS"));
bill.setAmount(rs.getDouble("AMOUNT"));
bill.setDate(rs.getString("DATE"));
bill.setName(rs.getString("NAME"));
return bill;
}
}
配置方法:
<!-- 参数化读取db --> <bean id="jdbcParameterItemReader" scope="step" class="org.springframework.batch.item.database.JdbcCursorItemReader" > <property name="dataSource" ref="dataSource"/> <property name="sql" value="select ID,ACCOUNTID,NAME,AMOUNT,DATE,ADDRESS from t_credit where id between 1 and ? "/> <property name="rowMapper" ref="custCreditRowMapper" /> <property name="preparedStatementSetter" ref="paramStatementSetter"/> </bean> <bean id="paramStatementSetter" scope="step" class="org.springframework.batch.core.resource.ListPreparedStatementSetter"> <property name="parameters"> <list> <value>#{jobParameters['id']}</value> </list> </property> </bean> <!--自定义RowMapper--> <bean id="custCreditRowMapper" class="com.xj.demo28.CreditBillRowMapper"/>
项目实例:
Spring Batch之读数据库——JdbcCursorItemReader之自定义RowMapper(三十七)_人……杰的博客-CSDN博客
五、preparedStatementSetter
1.框架提供的ListPreparedStatementSetter
Spring Batch框架提供了自带的ListPreparedStatementSetter,用来设置SQL语句需要的参数。配置详情见上“配置方法”。
2.自定义preparedStatementSetter
开发者可以根据自己业务需要实现自定义的PreparedStatementSetter来进行参数设置。PreparedStatementSetter接口定义如下:
public interface PreparedStatementSetter {
void setValues(PreparedStatement var1) throws SQLException;
}
- setValues:核心方法,为参数PreparedStatement设置SQL需要的参数
自定义CreditBillPreparedStatementSetter.java:
package com.xj.demo29;
import org.springframework.jdbc.core.PreparedStatementSetter;
import java.sql.PreparedStatement;
import java.sql.SQLException;
public class CreditBillPreparedStatementSetter implements
PreparedStatementSetter {
public void setValues(PreparedStatement ps) throws SQLException {
ps.setString(1, "5");
}
}
配置方法:
<!-- 参数化读取db --> <bean id="jdbcParameterItemReader" scope="step" class="org.springframework.batch.item.database.JdbcCursorItemReader" > <property name="dataSource" ref="dataSource"/> <property name="sql" value="select ID,ACCOUNTID,NAME,AMOUNT,DATE,ADDRESS from t_credit where id between 1 and ? "/> <property name="rowMapper" ref="custCreditRowMapper" /> <property name="preparedStatementSetter" ref="custPreparedStatementSetter"/> </bean> <!--自定义PreparedStatementSetter--> <bean id="custPreparedStatementSetter" class="com.xj.demo29.CreditBillPreparedStatementSetter"/> <!--自定义RowMapper--> <bean id="custCreditRowMapper" class="com.xj.demo29.CreditBillRowMapper"/>
项目实例:
Spring Batch之读数据库——JdbcCursorItemReader之自定义PreparedStatementSetter(三十八)_人……杰的博客-CSDN博客