MyBatis 如何實現流式查詢?

導讀：流式查詢指的是查詢成功後不是返回一個集合而是返回一個迭代器，應用每次從迭代器取一條查詢結果。流式查詢的好處是可以下降內存使用

若是沒有流式查詢，咱們想要從數據庫取 1000 萬條記錄而又沒有足夠的內存時，就不得不分頁查詢，而分頁查詢效率取決於表設計，若是設計的很差，就沒法執行高效的分頁查詢。所以流式查詢是一個數據庫訪問框架必須具有的功能。

流式查詢的過程中，數據庫鏈接是保持打開狀態的，所以要注意的是：執行一個流式查詢後，數據庫訪問框架就不負責關閉數據庫鏈接了，須要應用在取完數據後本身關閉。

MyBatis 流式查詢接口

MyBatis 提供了一個叫 org.apache.ibatis.cursor.Cursor 的接口類用於流式查詢，這個接口繼承了 java.io.Closeable 和 java.lang.Iterable 接口，由此可知：

• Cursor 是可關閉的。實際上當關閉 Cursor 時，也一併將數據庫鏈接關閉了；
• Cursor 是可遍歷的。

除此以外，Cursor 還提供了三個方法：

• isOpen()：用於在取數據以前判斷 Cursor 對象是不是打開狀態。只有當打開時 Cursor 才能取數據；
• isConsumed()：用於判斷查詢結果是否所有取完；
• getCurrentIndex()：返回已經獲取了多少條數據。

由於 Cursor 實現了迭代器接口，所以在實際使用當中，從 Cursor 取數據很是簡單：

try(Cursor cursor = mapper.querySomeData()) {
    cursor.forEach(rowObject -> {
        // ...
    });
}
複製代碼

使用 try-resource 方式能夠令 Cursor 自動關閉。

但構建 Cursor 的過程不簡單

咱們舉個實際例子。下面是一個 Mapper 類：

@Mapper
public interface FooMapper {
    @Select("select * from foo limit #{limit}")
    Cursor<Foo> scan(@Param("limit") int limit);
}
複製代碼

方法 scan() 是一個很是簡單的查詢。咱們在定義這個方時，指定返回值爲 Cursor 類型，MyBatis 就明白這個查詢方法是一個流式查詢。

而後咱們再寫一個 SpringMVC Controller 方法來調用 Mapper（無關的代碼已經省略）:

@GetMapping("foo/scan/0/{limit}")
public void scanFoo0(@PathVariable("limit") int limit) throws Exception {
    try (Cursor<Foo> cursor = fooMapper.scan(limit)) {  // 1
        cursor.forEach(foo -> {});                      // 2
    }
}
複製代碼

假設 fooMapper 是 @Autowired 進來的。註釋 1 處是獲取 Cursor 對象並保證它能最後關閉；2 處則是從 cursor 中取數據。

上面的代碼看上去沒什麼問題，可是執行scanFoo0(int)時會報錯：

java.lang.IllegalStateException: A Cursor is already closed.
複製代碼

這是由於咱們前面說了在取數據的過程當中須要保持數據庫鏈接，而 Mapper 方法一般在執行完後鏈接就關閉了，所以 Cusor 也一併關閉了。

因此，解決這個問題的思路不復雜，保持數據庫鏈接打開便可。咱們至少有三種方案可選。

方案一：SqlSessionFactory

咱們能夠用 SqlSessionFactory 來手工打開數據庫鏈接，將 Controller 方法修改以下：

@GetMapping("foo/scan/1/{limit}")
public void scanFoo1(@PathVariable("limit") int limit) throws Exception {
    try (
        SqlSession sqlSession = sqlSessionFactory.openSession();  // 1
        Cursor<Foo> 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<Foo> 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<Foo> cursor = fooMapper.scan(limit)) {
        cursor.forEach(foo -> { });
    }
}
複製代碼

它僅僅是在原來方法上面加了個 @Transactional 註解。這個方案看上去最簡潔，但請注意 Spring 框架當中註解使用的坑：只在外部調用時生效。在當前類中調用這個方法，依舊會報錯。

以上是三種實現 MyBatis 流式查詢的方法。

首發地址：MyBatis 如何實現流式查詢?

關注技術號：公衆號：碼農架構