實(shí)現(xiàn)Mybatis流式查詢(xún)接口的三種方法詳解

導(dǎo)讀：流式查詢(xún)指的是查詢(xún)成功后不是返回一個(gè)集合而是返回一個(gè)迭代器，應(yīng)用每次從迭代器取一條查詢(xún)結(jié)果。流式查詢(xún)的好處是能夠降低內(nèi)存使用

如果沒(méi)有流式查詢(xún)，我們想要從數(shù)據(jù)庫(kù)取 1000 萬(wàn)條記錄而又沒(méi)有足夠的內(nèi)存時(shí)，就不得不分頁(yè)查詢(xún)，而分頁(yè)查詢(xún)效率取決于表設(shè)計(jì)，如果設(shè)計(jì)的不好，就無(wú)法執(zhí)行高效的分頁(yè)查詢(xún)。因此流式查詢(xún)是一個(gè)數(shù)據(jù)庫(kù)訪問(wèn)框架必須具備的功能。
流式查詢(xún)的過(guò)程當(dāng)中，數(shù)據(jù)庫(kù)連接是保持打開(kāi)狀態(tài)的，因此要注意的是：執(zhí)行一個(gè)流式查詢(xún)后，數(shù)據(jù)庫(kù)訪問(wèn)框架就不負(fù)責(zé)關(guān)閉數(shù)據(jù)庫(kù)連接了，需要應(yīng)用在取完數(shù)據(jù)后自己關(guān)閉。

MyBatis 流式查詢(xún)接口

MyBatis 提供了一個(gè)叫 org.apache.ibatis.cursor.Cursor 的接口類(lèi)用于流式查詢(xún)，這個(gè)接口繼承了 java.io.Closeable 和 java.lang.Iterable 接口，由此可知：

• Cursor 是可關(guān)閉的。實(shí)際上當(dāng)關(guān)閉 Cursor 時(shí)，也一并將數(shù)據(jù)庫(kù)連接關(guān)閉了；
• Cursor 是可遍歷的。

除此之外，Cursor 還提供了三個(gè)方法：

• isOpen()：用于在取數(shù)據(jù)之前判斷 Cursor 對(duì)象是否是打開(kāi)狀態(tài)。只有當(dāng)打開(kāi)時(shí) Cursor 才能取數(shù)據(jù)；
• isConsumed()：用于判斷查詢(xún)結(jié)果是否全部取完；
• getCurrentIndex()：返回已經(jīng)獲取了多少條數(shù)據(jù)。

因?yàn)?Cursor 實(shí)現(xiàn)了迭代器接口，因此在實(shí)際使用當(dāng)中，從 Cursor 取數(shù)據(jù)非常簡(jiǎn)單：

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

使用 try-resource 方式可以令 Cursor 自動(dòng)關(guān)閉。
但構(gòu)建 Cursor 的過(guò)程不簡(jiǎn)單
我們舉個(gè)實(shí)際例子。下面是一個(gè) Mapper 類(lèi)：

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

方法 scan() 是一個(gè)非常簡(jiǎn)單的查詢(xún)。我們?cè)诙x這個(gè)方時(shí)，指定返回值為 Cursor 類(lèi)型，MyBatis 就明白這個(gè)查詢(xún)方法是一個(gè)流式查詢(xún)。

然后我們?cè)賹?xiě)一個(gè) SpringMVC Controller 方法來(lái)調(diào)用 Mapper（無(wú)關(guān)的代碼已經(jīng)省略）:

@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
    }
}

假設(shè) fooMapper 是 @Autowired 進(jìn)來(lái)的。注釋 1 處是獲取 Cursor 對(duì)象并保證它能最后關(guān)閉；2 處則是從 cursor 中取數(shù)據(jù)。
上面的代碼看上去沒(méi)什么問(wèn)題，但是執(zhí)行scanFoo0(int)時(shí)會(huì)報(bào)錯(cuò)：

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

這是因?yàn)槲覀兦懊嬲f(shuō)了在取數(shù)據(jù)的過(guò)程中需要保持?jǐn)?shù)據(jù)庫(kù)連接，而 Mapper 方法通常在執(zhí)行完后連接就關(guān)閉了，因此 Cusor 也一并關(guān)閉了。
所以，解決這個(gè)問(wèn)題的思路不復(fù)雜，保持?jǐn)?shù)據(jù)庫(kù)連接打開(kāi)即可。我們至少有三種方案可選。

方案一：SqlSessionFactory

我們可以用 SqlSessionFactory 來(lái)手工打開(kāi)數(shù)據(jù)庫(kù)連接，將 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 處我們開(kāi)啟了一個(gè) SqlSession （實(shí)際上也代表了一個(gè)數(shù)據(jù)庫(kù)連接），并保證它最后能關(guān)閉；2 處我們使用 SqlSession 來(lái)獲得 Mapper 對(duì)象。這樣才能保證得到的 Cursor 對(duì)象是打開(kāi)狀態(tài)的。

方案二：TransactionTemplate

在 Spring 中，我們可以用 TransactionTemplate 來(lái)執(zhí)行一個(gè)數(shù)據(jù)庫(kù)事務(wù)，這個(gè)過(guò)程中數(shù)據(jù)庫(kù)連接同樣是打開(kāi)的。代碼如下：

@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 處我們創(chuàng)建了一個(gè) TransactionTemplate 對(duì)象（此處 transactionManager 是怎么來(lái)的不用多解釋?zhuān)疚募僭O(shè)讀者對(duì) Spring 數(shù)據(jù)庫(kù)事務(wù)的使用比較熟悉了），2 處執(zhí)行數(shù)據(jù)庫(kù)事務(wù)，而數(shù)據(jù)庫(kù)事務(wù)的內(nèi)容則是調(diào)用 Mapper 對(duì)象的流式查詢(xún)。注意這里的 Mapper 對(duì)象無(wú)需通過(guò) SqlSession 創(chuàng)建。

方案三：@Transactional 注解

這個(gè)本質(zhì)上和方案二一樣，代碼如下：

@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 -> { });
    }
}

它僅僅是在原來(lái)方法上面加了個(gè) @Transactional 注解。這個(gè)方案看上去最簡(jiǎn)潔，但請(qǐng)注意 Spring 框架當(dāng)中注解使用的坑：只在外部調(diào)用時(shí)生效。在當(dāng)前類(lèi)中調(diào)用這個(gè)方法，依舊會(huì)報(bào)錯(cuò)。

到此這篇關(guān)于MyBatis流式查詢(xún)的實(shí)現(xiàn)方法的文章就介紹到這了，想要了解更多相關(guān)MyBatis流式查詢(xún)內(nèi)容，請(qǐng)多多關(guān)注W3Cschool其他相關(guān)內(nèi)容的文章！