基本概念
流式查询 指的是查询成功后不是返回一个集合而是返回一个迭代器,应用每次从迭代器取一条查询结果。流式查询的好处是能够降低内存使用。
举例:如果没有流式查询,我们想要从数据库取 1000 万条记录而又没有足够的内存时,就不得不分页查询,而分页查询效率取决于表设计,如果设计的不好,就无法执行高效的分页查询。因此流式查询是一个数据库访问框架必须具备的功能。
MyBatis 流式查询接口
MyBatis 提供了一个叫 org.apache.ibatis.cursor.Cursor 的接口类用于流式查询,这个接口继承了 java.io.Closeable 和 java.lang.Iterable 接口,由此可知:
Cursor 是可关闭的;
Cursor 是可遍历的。
除此之外,Cursor 还提供了三个方法:
isOpen():用于在取数据之前判断 Cursor 对象是否是打开状态。只有当打开时 Cursor 才能取数据;
isConsumed():用于判断查询结果是否全部取完。
getCurrentIndex():返回已经获取了多少条数据
因为 Cursor 实现了迭代器接口,因此在实际使用当中,从 Cursor 取数据非常简单:
![](https://i-blog.csdnimg.cn/blog_migrate/fdbfe85499d0e290e65b3cefbf7a2ba4.png)
java.lang 包下的 Iterable 接口源码:
![](https://i-blog.csdnimg.cn/blog_migrate/4df6f0696741ae9034f3dbbbe7a8cfbe.png)
构建 Cursor 的过程
我们举个实际例子。下面是一个 Mapper 类:
![](https://i-blog.csdnimg.cn/blog_migrate/28ec891a680890ccfe8775fc7422a604.png)
方法 scan() 是一个非常简单的查询。通过指定 Mapper 方法的返回值为 Cursor 类型,MyBatis 就知道这个查询方法一个流式查询。
然后我们再写一个 SpringMVC Controller 方法来调用 Mapper:
![](https://i-blog.csdnimg.cn/blog_migrate/0719e9d3951591a21f8d5526398b07b8.png)
![](https://i-blog.csdnimg.cn/blog_migrate/7520866f03bfd6dfd9373e3fa0fb8303.png)
![](https://i-blog.csdnimg.cn/blog_migrate/558c2677ea2e4aad542994e75dc83d8f.png)
假设studentMapper 是 @Autowired 进来的。注释 1 处调用 scan 方法,得到 Cursor 对象并保证它能最后关闭;2 处则是从 cursor 中取数据。
上面的代码看上去没什么问题,但是执行 scan() 时会报错:
![](https://i-blog.csdnimg.cn/blog_migrate/51da69f9a8af449194e91961481f232f.png)
这是因为我们前面说了在取数据的过程中需要保持数据库连接,而 Mapper 方法通常在执行完后连接就关闭了,因此 Cusor 也一并关闭了。
所以,解决这个问题的思路不复杂,保持数据库连接打开即可。我们至少有三种方案可选。
方案一:SqlSessionFactory
我们可以用 SqlSessionFactory 来手工打开数据库连接,将 StudentServiceImpl 方法修改如下:
![](https://i-blog.csdnimg.cn/blog_migrate/8a96c71ceefdccf8dd4eb124618207a5.png)
上面的代码中,1 处我们开启了一个 SqlSession (实际上也代表了一个数据库连接),并保证它最后能关闭;2 处我们使用 SqlSession 来获得 Mapper 对象。这样才能保证得到的 Cursor 对象是打开状态的。
方案二:TransactionTemplate
在 Spring 中,我们可以用 TransactionTemplate 来执行一个数据库事务,这个过程中数据库连接同样是打开的。代码如下:
![](https://i-blog.csdnimg.cn/blog_migrate/06517534fecd78cf4e725e2aa5e1f08f.png)
上面的代码中,1 处我们创建了一个 TransactionTemplate 对象(此处 transactionManager 是怎么来的不用多解释,本文假设读者对 Spring 数据库事务的使用比较熟悉了),2 处执行数据库事务,而数据库事务的内容则是调用 Mapper 对象的流式查询。注意这里的 Mapper 对象无需通过 SqlSession 创建。
方案三:@Transactional 注解
![](https://i-blog.csdnimg.cn/blog_migrate/3c1368a7425009729388df593b01bea5.png)
它仅仅是在原来方法上面加了个 @Transactional 注解。这个方案看上去最简洁,但请注意 Spring 框架当中注解使用的坑:只在外部调用时生效 。在当前类中调用这个方法,依旧会报错。
运行结果演示:
数据库student表的数据如下
![](https://i-blog.csdnimg.cn/blog_migrate/1c7404586f2d796097c994e24a210791.png)
http://localhost:8090/student/scan/1
![](https://i-blog.csdnimg.cn/blog_migrate/5c61fda617a0fbbb91f39a1569b5c13e.png)
http://localhost:8090/student/scan/2
![](https://i-blog.csdnimg.cn/blog_migrate/1135bc67b4f93b4567b4f8b9216f85cf.png)
以上是三种实现 MyBatis 流式查询的方法。