如何通过MyBatis 流式查询实现千万数据表快速分页查询

2020/04/28 22:24
阅读数 3.8K

点击上方“小罗技术笔记”,关注公众号

第一时间送达实用干货

来源:http://suo.im/5IQ3Ld

作者:捏造的信仰


基本概念

流式查询指的是查询成功后不是返回一个集合而是返回一个迭代器,应用每次从迭代器取一条查询结果。流式查询的好处是能够降低内存使用。

如果没有流式查询,我们想要从数据库取 1000 万条记录而又没有足够的内存时,就不得不分页查询,而分页查询效率取决于表设计,如果设计的不好,就无法执行高效的分页查询。因此流式查询是一个数据库访问框架必须具备的功能。

流式查询的过程当中,数据库连接是保持打开状态的,因此要注意的是:执行一个流式查询后,数据库访问框架就不负责关闭数据库连接了,需要应用在取完数据后自己关闭。

MyBatis 流式查询接口

MyBatis 提供了一个叫 org.apache.ibatis.cursor.Cursor 的接口类用于流式查询,这个接口继承了 java.io.Closeablejava.lang.Iterable 接口,由此可知:

1、 Cursor 是可关闭的;

2、 Cursor 是可遍历的。

除此之外,Cursor 还提供了三个方法:

1、 isOpen():用于在取数据之前判断 Cursor 对象是否是打开状态。只有当打开时 Cursor 才能取数据;2、 isConsumed():用于判断查询结果是否全部取完。3、 getCurrentIndex():返回已经获取了多少条数据

因为 Cursor 实现了迭代器接口,因此在实际使用当中,从 Cursor 取数据非常简单:

     
   
   
   
  1. cursor.forEach(rowObject -> {...});

但构建 Cursor 的过程不简单

我们举个实际例子。下面是一个 Mapper 类:

     
   
   
   
  1. @Mapper

  2. public interface FooMapper {

  3.    @Select("select * from foo limit #{limit}")

  4.    Cursor<Foo> scan(@Param("limit") int limit);

  5. }

方法 scan() 是一个非常简单的查询。通过指定 Mapper 方法的返回值为 Cursor 类型,MyBatis 就知道这个查询方法一个流式查询。

然后我们再写一个 SpringMVC Controller 方法来调用 Mapper(无关的代码已经省略):

     
   
   
   
  1. @GetMapping("foo/scan/0/{limit}")

  2. public void scanFoo0(@PathVariable("limit") int limit) throws Exception {

  3.    try (Cursor<Foo> cursor = fooMapper.scan(limit)) {  // 1

  4.        cursor.forEach(foo -> {});                      // 2

  5.    }

  6. }

上面的代码中,fooMapper 是 @Autowired 进来的。注释 1 处调用 scan 方法,得到 Cursor 对象并保证它能最后关闭;2 处则是从 cursor 中取数据。

上面的代码看上去没什么问题,但是执行 scanFoo0() 时会报错:

     
   
   
   
  1. java.lang.IllegalStateException: A Cursor is already closed.

这是因为我们前面说了在取数据的过程中需要保持数据库连接,而 Mapper 方法通常在执行完后连接就关闭了,因此 Cusor 也一并关闭了。

所以,解决这个问题的思路不复杂,保持数据库连接打开即可。我们至少有三种方案可选。

方案一:SqlSessionFactory

我们可以用 SqlSessionFactory 来手工打开数据库连接,将 Controller 方法修改如下:

     
   
   
   
  1. @GetMapping("foo/scan/1/{limit}")

  2. public void scanFoo1(@PathVariable("limit") int limit) throws Exception {

  3.    try (

  4.        SqlSession sqlSession = sqlSessionFactory.openSession();  // 1

  5.        Cursor<Foo> cursor =

  6.              sqlSession.getMapper(FooMapper.class).scan(limit)   // 2

  7.    ) {

  8.        cursor.forEach(foo -> { });

  9.    }

  10. }

上面的代码中,

1 处我们开启了一个 SqlSession (实际上也代表了一个数据库连接),并保证它最后能关闭;

2 处我们使用 SqlSession 来获得 Mapper 对象。这样才能保证得到的 Cursor 对象是打开状态的。

方案二:TransactionTemplate

在 Spring 中,我们可以用 TransactionTemplate 来执行一个数据库事务,这个过程中数据库连接同样是打开的。代码如下:

     
   
   
   
  1. @GetMapping("foo/scan/2/{limit}")

  2. public void scanFoo2(@PathVariable("limit") int limit) throws Exception {

  3.    TransactionTemplate transactionTemplate =

  4.            new TransactionTemplate(transactionManager);  // 1

  5.    transactionTemplate.execute(status -> {               // 2

  6.        try (Cursor<Foo> cursor = fooMapper.scan(limit)) {

  7.            cursor.forEach(foo -> { });

  8.        } catch (IOException e) {

  9.            e.printStackTrace();

  10.        }

  11.        return null;

  12.    });

  13. }

上面的代码中,

1 处我们创建了一个 TransactionTemplate 对象(此处 transactionManager 是怎么来的不用多解释,本文假设读者对 Spring 数据库事务的使用比较熟悉了)。

2 处执行数据库事务,而数据库事务的内容则是调用 Mapper 对象的流式查询。注意这里的 Mapper 对象无需通过 SqlSession 创建。

方案三:@Transactional 注解

这个本质上和方案二一样,代码如下:

     
   
   
   
  1. @GetMapping("foo/scan/3/{limit}")

  2. @Transactional

  3. public void scanFoo3(@PathVariable("limit") int limit) throws Exception {

  4.    try (Cursor<Foo> cursor = fooMapper.scan(limit)) {

  5.        cursor.forEach(foo -> { });

  6.    }

  7. }

它仅仅是在原来方法上面加了个 @Transactional 注解。这个方案看上去最简洁,但请注意 Spring 框架当中注解使用的坑:只在外部调用时生效。在当前类中调用这个方法,依旧会报错。

以上是三种实现 MyBatis 流式查询的方法。



长按二维码关注

点个在看再走呗!

本文分享自微信公众号 - 小罗技术笔记(javaCodeNote)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

展开阅读全文
0
0 收藏
分享
加载中
更多评论
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部