1.ResultHandler结果集处理
1.1 ResultHandler 简介
Mybatis 中的 ResultHandler 相当于数据结果集的处理器,它是一个回调函数(Callback),用来处理每一行数据的结果,这个回调函数可以在查询结果处理到一定量时触发,对结果集数据进行定制化处理。
ResultHandler 的使用可以大幅提升数据处理的效率,当我们需要处理大量的数据时,一般会使用 ResultHandler 来进行结果的处理,避免一次查询就全部返回结果,浪费内存资源或造成 OOM。
ResultHandler 接口只有一个方法 handleResult,我们可以实现这个方法去处理每一条 SQL 查询返回的数据。
1.2 ResultHandler 实现结果流式输出(两种写法)
Mybatis:
<select id="selectByResultHandler" resultMap="BaseResultMap">
SELECT
<include refid="Base_Column_List" />
FROM tbl_test_user
</select>
Mapper:
package com.test.dao;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.session.ResultHandler;
public interface TblTestUserMapper {
// SQL 返回值为 void,所以我们并没有接收这个返回值。所以不会产生大对象
// 方法中的第一个参数是查询时的限制条件,第二个是结果处理器
void selectByResultHandler(@Param(value = "actNo") String actNo,
ResultHandler resultHandler);
}
实现ResultHandler:
package com.test.handler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.session.ResultContext;
import org.apache.ibatis.session.ResultHandler;
import com.test.model.TblTestUser;
@Slf4j
public class TestResultHandler implements ResultHandler<TblTestUser> {
@Override
public void handleResult(ResultContext<? extends TblTestUser> resultContext) {
TblTestUser tblTestUser = resultContext.getResultObject();
// TODO 处理数据的逻辑
try {
// 打印每行日志
log.info("userNo : [{}]", tblTestUser.getUserNo());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}
Service:
package com.test.service;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.session.ResultContext;
import org.apache.ibatis.session.ResultHandler;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;
import com.test.dao.TblTestUserMapper;
import com.test.model.TblTestUser;
import javax.annotation.Resource;
@Service
@Slf4j
public class TestService {
@Resource
private TblTestUserMapper tblTestUserMapper;
/**
* 写法 1
*
* @param actNo 筛选条件:活动号
*/
@Async
public void test1(String actNo) {
log.info("ResultHandler1 处理查询结果");
TestResultHandler testResultHandler = new TestResultHandler();
tblTestUserMapper.selectByResultHandler(actNo, testResultHandler);
}
/**
* 写法 2
*
* @param actNo 筛选条件:活动号
*/
@Async
public void test2(String actNo) {
log.info("ResultHandler2 处理查询结果");
tblTestUserMapper.selectByResultHandler(actNo, new ResultHandler<TblTestUser>() {
@Override
public void handleResult(ResultContext<? extends TblTestUser> resultContext) {
TblTestUser tblTestUser = resultContext.getResultObject();
// 处理数据的逻辑
try {
// 打印每行日志
log.info("userNo : [{}]", tblTestUser.getUserNo());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
});
}
}
2.游标(Cursor)
MyBatis 3.2 以上版本支持游标,允许逐行处理结果集。它提供了一个叫 org.apache.ibatis.cursor.Cursor
的接口类用于流式查询,这个接口继承了 java.io.Closeable
和 java.lang.Iterable
接口,由此可知:
-
Cursor 是可关闭的;
-
Cursor 是可遍历的。
除此之外,Cursor 还提供了三个方法:
-
isOpen()
:用于在取数据之前判断 Cursor 对象是否是打开状态。只有当打开时 Cursor 才能取数据; -
isConsumed()
:用于判断查询结果是否全部取完。 -
getCurrentIndex()
:返回已经获取了多少条数据
因为 Cursor 实现了迭代器接口,因此在实际使用当中,从 Cursor 取数据非常简单, 在 Mapper 接口中,通过指定 Mapper 方法的返回值为 Cursor 类型,MyBatis 就知道这个查询方法一个流式查询。
cursor.forEach(rowObject -> {...});
2.1 构建Cursor
Mapper:
@Mapper
public interface FooMapper {
@Select("select * from foo limit #{limit}")
Cursor scan(@Param("limit") int limit);
}
2.1.1 错误示范
@GetMapping("foo/scan/0/{limit}")
public void scanFoo0(@PathVariable("limit") int limit) throws Exception {
try (Cursor cursor = fooMapper.scan(limit)) { // 1
cursor.forEach(foo -> {}); // 2
}
}
说明:
上面的代码中,fooMapper 是 @Autowired 进来的。
注释 1 处调用 scan 方法,得到 Cursor 对象并保证它能最后关闭;
注释 2 处则是从 cursor 中取数据。
上面的代码看上去没什么问题,但是执行 scanFoo0() 时会报错:
java.lang.IllegalStateException: A Cursor is already closed.
这是因为我们前面说了在取数据的过程中需要保持数据库连接,而 Mapper 方法通常在执行完后连接就关闭了,因此 Cusor 也一并关闭了。
所以,解决这个问题的思路不复杂,保持数据库连接打开即可。我们至少有三种方案可选。
2.1.2 正确示范
SqlSessionFactory
我们可以用 SqlSessionFactory 来手工打开数据库连接:
@GetMapping("foo/scan/1/{limit}")
public void scanFoo1(@PathVariable("limit") int limit) throws Exception {
try (
SqlSession sqlSession = sqlSessionFactory.openSession(); // 1
Cursor cursor =
sqlSession.getMapper(FooMapper.class).scan(limit) // 2
) {
cursor.forEach(foo -> { });
}
}
上面的代码中,1 处我们开启了一个 SqlSession (实际上也代表了一个数据库连接),并保证它最后能关闭;2 处我们使用 SqlSession 来获得 Mapper 对象。这样才能保证得到的 Cursor 对象是打开状态的。
TransactionTemplate
在 Spring 中,我们可以用 TransactionTemplate 来执行一个数据库事务,这个过程中数据库连接同样是打开的:
@GetMapping("foo/scan/2/{limit}")
public void scanFoo2(@PathVariable("limit") int limit) throws Exception {
TransactionTemplate transactionTemplate =
new TransactionTemplate(transactionManager); // 1
transactionTemplate.execute(status -> { // 2
try (Cursor cursor = fooMapper.scan(limit)) {
cursor.forEach(foo -> { });
} catch (IOException e) {
e.printStackTrace();
}
return null;
});
}
上面的代码中,1 处我们创建了一个 TransactionTemplate 对象(此处 transactionManager 是怎么来的不用多解释,本文假设读者对 Spring 数据库事务的使用比较熟悉了),2 处执行数据库事务,而数据库事务的内容则是调用 Mapper 对象的流式查询。注意这里的 Mapper 对象无需通过 SqlSession 创建。
@Transactional 注解
这个本质上和方案二一样,代码如下:
@GetMapping("foo/scan/3/{limit}")
@Transactional
public void scanFoo3(@PathVariable("limit") int limit) throws Exception {
try (Cursor cursor = fooMapper.scan(limit)) {
cursor.forEach(foo -> { });
}
}
它仅仅是在原来方法上面加了个 @Transactional
注解。这个方案看上去最简洁,但请注意 Spring 框架当中注解使用的坑:只在外部调用时生效。在当前类中调用这个方法,依旧会报错。
以上是三种实现 MyBatis 流式查询的方法。