Mybatis Cursor详解

一、什么是Mybatis Cursor?

Mybatis Cursor是Mybatis提供的一个API，用于处理大量数据时占用内存过高的问题。它是对JDBC ResultSet游标的封装，将查询结果逐个读取，而不是一次性读取全部数据，从而避免了OOM问题。

Cursor可以看做是一种惰性加载的机制，只有在使用结果集中的数据时才会被读取，并且可以自动关闭ResultSet和Statement。

二、Mybatis Cursor的分类及使用方式

1. FORWARD_ONLY Cursor (默认)

当使用FORWARD_ONLY Cursor时，只能沿游标方向向下移动，不能返回。这种Cursor只需要遍历一次结果集，运行速度最快，但如果需要重复遍历同一行，则必须重新执行查询。

// 使用ForwardOnlyCursor
try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
  ResultHandler resultHandler = context -> {
    while (context.next()) {
      MyEntity entity = context.getResultObject();
      // do something
    }
  };
  sqlSession.select(SELECT_MY_ENTITY, null, new RowBounds(0, 10), resultHandler, ExecutorType.SIMPLE);
}

  

2. SCROLL_SENSITIVE Cursor

SCROLL_SENSITIVE Cursor支持行级别的修改和动态游标，可以随意移动游标，但是相对之前的遍历速度会下降。

// 使用ScrollSensitiveCursor
try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
  ResultHandler resultHandler = context -> {
    while (context.next()) {
      MyEntity entity = context.getResultObject();
      // do something
      context.updateRow(); // 可以动态修改行数据
    }
  };
  sqlSession.select(SELECT_MY_ENTITY, null, new RowBounds(0, 10), resultHandler, ExecutorType.SCROLL_SENSITIVE);
}

  

3. SCROLL_INSENSITIVE Cursor

SCROLL_INSENSITIVE Cursor支持还原游标位置，因此可以多次遍历相同的结果集。但是在移动游标时，可能会产生额外的性能开销。

// 使用ScrollInsensitiveCursor
try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
  ResultHandler resultHandler = context -> {
    while (context.next()) {
      MyEntity entity = context.getResultObject();
      // do something
    }
  };
  sqlSession.select(SELECT_MY_ENTITY, null, new RowBounds(0, 10), resultHandler, ExecutorType.SCROLL_INSENSITIVE);
}

  

三、注意事项

使用Cursor需要注意以下问题：

1. ResultSet的关闭

如果使用Cursor，在使用完Cursor后，必须手动调用ResultSet.close()，否则会内存泄漏。

2. 事务

Cursor在使用时需要开启事务，否则无法正常关闭ResultSet和Statement

3. 内存占用

虽然Cursor可以减小内存占用，但是对于大数据量查询，仍会引起内存占用过高的问题。需要在程序中进一步优化。

四、总结

Mybatis Cursor是一个非常实用的API，可以有效减小内存占用问题，处理大量数据时非常实用。使用时需要注意ResultSet的关闭、事务的开启以及内存占用问题。