Mybatis中流式查詢(xún)的實(shí)現(xiàn)示例

更新時(shí)間：2024年09月27日 10:20:53 作者：Desiro_

MyBatis的ResultHandler是用于處理數(shù)據(jù)庫(kù)查詢(xún)結(jié)果集的工具,可以通過(guò)回調(diào)函數(shù)對(duì)數(shù)據(jù)進(jìn)行流式處理,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

1.ResultHandler結(jié)果集處理

1.1 ResultHandler 簡(jiǎn)介

Mybatis 中的 ResultHandler 相當(dāng)于數(shù)據(jù)結(jié)果集的處理器，它是一個(gè)回調(diào)函數(shù)（Callback），用來(lái)處理每一行數(shù)據(jù)的結(jié)果，這個(gè)回調(diào)函數(shù)可以在查詢(xún)結(jié)果處理到一定量時(shí)觸發(fā)，對(duì)結(jié)果集數(shù)據(jù)進(jìn)行定制化處理。

ResultHandler 的使用可以大幅提升數(shù)據(jù)處理的效率，當(dāng)我們需要處理大量的數(shù)據(jù)時(shí)，一般會(huì)使用 ResultHandler 來(lái)進(jìn)行結(jié)果的處理，避免一次查詢(xún)就全部返回結(jié)果，浪費(fèi)內(nèi)存資源或造成 OOM。

ResultHandler 接口只有一個(gè)方法 handleResult，我們可以實(shí)現(xiàn)這個(gè)方法去處理每一條 SQL 查詢(xún)返回的數(shù)據(jù)。

1.2 ResultHandler 實(shí)現(xiàn)結(jié)果流式輸出（兩種寫(xiě)法）

Mybatis：

 <select id="selectByResultHandler" resultMap="BaseResultMap">
    SELECT
    <include refid="Base_Column_List" />
    FROM tbl_test_user
  </select>

Mapper:

package com.test.dao;

import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.session.ResultHandler;

public interface TblTestUserMapper {

	// SQL 返回值為 void，所以我們并沒(méi)有接收這個(gè)返回值。所以不會(huì)產(chǎn)生大對(duì)象
	// 方法中的第一個(gè)參數(shù)是查詢(xún)時(shí)的限制條件，第二個(gè)是結(jié)果處理器
    void selectByResultHandler(@Param(value = "actNo") String actNo,
                               ResultHandler resultHandler);
}

實(shí)現(xiàn)ResultHandler：

package com.test.handler;

import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.session.ResultContext;
import org.apache.ibatis.session.ResultHandler;
import com.test.model.TblTestUser;

@Slf4j
public class TestResultHandler implements ResultHandler<TblTestUser> {

    @Override
    public void handleResult(ResultContext<? extends TblTestUser> resultContext) {
        TblTestUser tblTestUser = resultContext.getResultObject();

        // TODO 處理數(shù)據(jù)的邏輯
        try {
            // 打印每行日志
            log.info("userNo : [{}]", tblTestUser.getUserNo());
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
}

Service:

package com.test.service;

import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.session.ResultContext;
import org.apache.ibatis.session.ResultHandler;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;
import com.test.dao.TblTestUserMapper;
import com.test.model.TblTestUser;

import javax.annotation.Resource;

@Service
@Slf4j
public class TestService {

    @Resource
    private TblTestUserMapper tblTestUserMapper;

    /**
     * 寫(xiě)法 1
     *
     * @param actNo 篩選條件：活動(dòng)號(hào)
     */
    @Async
    public void test1(String actNo) {
        log.info("ResultHandler1 處理查詢(xún)結(jié)果");
        TestResultHandler testResultHandler = new TestResultHandler();
        tblTestUserMapper.selectByResultHandler(actNo, testResultHandler);
    }

    /**
     * 寫(xiě)法 2
     *
     * @param actNo 篩選條件：活動(dòng)號(hào)
     */
    @Async
    public void test2(String actNo) {
        log.info("ResultHandler2 處理查詢(xún)結(jié)果");
        tblTestUserMapper.selectByResultHandler(actNo, new ResultHandler<TblTestUser>() {
            @Override
            public void handleResult(ResultContext<? extends TblTestUser> resultContext) {
                TblTestUser tblTestUser = resultContext.getResultObject();

                // 處理數(shù)據(jù)的邏輯
                try {
                    // 打印每行日志
                    log.info("userNo : [{}]", tblTestUser.getUserNo());
                } catch (Exception e) {
                    throw new RuntimeException(e);
                }
            }
        });
    }
}

2.游標(biāo)（Cursor）

MyBatis 3.2 以上版本支持游標(biāo)，允許逐行處理結(jié)果集。它提供了一個(gè)叫 org.apache.ibatis.cursor.Cursor 的接口類(lèi)用于流式查詢(xún)，這個(gè)接口繼承了 java.io.Closeable 和 java.lang.Iterable 接口，由此可知：

Cursor 是可關(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)單，在 Mapper 接口中，通過(guò)指定 Mapper 方法的返回值為 Cursor 類(lèi)型，MyBatis 就知道這個(gè)查詢(xún)方法一個(gè)流式查詢(xún)。

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

2.1 構(gòu)建Cursor

Mapper：

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

2.1.1 錯(cuò)誤示范

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

說(shuō)明：

上面的代碼中，fooMapper 是 @Autowired 進(jìn)來(lái)的。

注釋 1 處調(diào)用 scan 方法，得到 Cursor 對(duì)象并保證它能最后關(guān)閉；

注釋 2 處則是從 cursor 中取數(shù)據(jù)。

上面的代碼看上去沒(méi)什么問(wèn)題，但是執(zhí)行 scanFoo0() 時(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)即可。我們至少有三種方案可選。

2.1.2 正確示范

SqlSessionFactory

我們可以用 SqlSessionFactory 來(lái)手工打開(kāi)數(shù)據(jù)庫(kù)連接：

@GetMapping("foo/scan/1/{limit}")  
public void scanFoo1(@PathVariable("limit") int limit) throws Exception {  
    try (  
        SqlSession sqlSession = sqlSessionFactory.openSession();  // 1  
        Cursor 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 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 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)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: