Mybatis中流式查詢的實現(xiàn)示例
1.ResultHandler結果集處理
1.1 ResultHandler 簡介
Mybatis 中的 ResultHandler 相當于數(shù)據(jù)結果集的處理器，它是一個回調(diào)函數(shù)（Callback），用來處理每一行數(shù)據(jù)的結果，這個回調(diào)函數(shù)可以在查詢結果處理到一定量時觸發(fā)，對結果集數(shù)據(jù)進行定制化處理。
ResultHandler 的使用可以大幅提升數(shù)據(jù)處理的效率，當我們需要處理大量的數(shù)據(jù)時，一般會使用 ResultHandler 來進行結果的處理，避免一次查詢就全部返回結果，浪費內(nèi)存資源或造成 OOM。
ResultHandler 接口只有一個方法 handleResult，我們可以實現(xiàn)這個方法去處理每一條 SQL 查詢返回的數(shù)據(jù)。
1.2 ResultHandler 實現(xiàn)結果流式輸出（兩種寫法）
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，所以我們并沒有接收這個返回值。所以不會產(chǎn)生大對象
// 方法中的第一個參數(shù)是查詢時的限制條件，第二個是結果處理器
void selectByResultHandler(@Param(value = "actNo") String actNo,
ResultHandler resultHandler);
}
實現(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;
/**
* 寫法 1
*
* @param actNo 篩選條件：活動號
*/
@Async
public void test1(String actNo) {
log.info("ResultHandler1 處理查詢結果");
TestResultHandler testResultHandler = new TestResultHandler();
tblTestUserMapper.selectByResultHandler(actNo, testResultHandler);
}
/**
* 寫法 2
*
* @param actNo 篩選條件：活動號
*/
@Async
public void test2(String actNo) {
log.info("ResultHandler2 處理查詢結果");
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.游標（Cursor）
MyBatis 3.2 以上版本支持游標，允許逐行處理結果集。它提供了一個叫 org.apache.ibatis.cursor.Cursor 的接口類用于流式查詢，這個接口繼承了 java.io.Closeable 和 java.lang.Iterable 接口，由此可知：
Cursor 是可關閉的；
Cursor 是可遍歷的。
除此之外，Cursor 還提供了三個方法：
isOpen()：用于在取數(shù)據(jù)之前判斷 Cursor 對象是否是打開狀態(tài)。只有當打開時 Cursor 才能取數(shù)據(jù)；isConsumed()：用于判斷查詢結果是否全部取完。getCurrentIndex()：返回已經(jīng)獲取了多少條數(shù)據(jù)
因為 Cursor 實現(xiàn)了迭代器接口，因此在實際使用當中，從 Cursor 取數(shù)據(jù)非常簡單， 在 Mapper 接口中，通過指定 Mapper 方法的返回值為 Cursor 類型，MyBatis 就知道這個查詢方法一個流式查詢。
cursor.forEach(rowObject -> {...}); 2.1 構建Cursor
Mapper：
@Mapper
public interface FooMapper {
@Select("select * from foo limit #{limit}")
Cursor scan(@Param("limit") int limit);
}2.1.1 錯誤示范
@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
}
} 說明：
上面的代碼中，fooMapper 是 @Autowired 進來的。
注釋 1 處調(diào)用 scan 方法，得到 Cursor 對象并保證它能最后關閉；
注釋 2 處則是從 cursor 中取數(shù)據(jù)。
上面的代碼看上去沒什么問題，但是執(zhí)行 scanFoo0() 時會報錯：
java.lang.IllegalStateException: A Cursor is already closed.
這是因為我們前面說了在取數(shù)據(jù)的過程中需要保持數(shù)據(jù)庫連接，而 Mapper 方法通常在執(zhí)行完后連接就關閉了，因此 Cusor 也一并關閉了。
所以，解決這個問題的思路不復雜，保持數(shù)據(jù)庫連接打開即可。我們至少有三種方案可選。
2.1.2 正確示范
SqlSessionFactory
我們可以用 SqlSessionFactory 來手工打開數(shù)據(jù)庫連接：
@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 處我們開啟了一個 SqlSession （實際上也代表了一個數(shù)據(jù)庫連接），并保證它最后能關閉；2 處我們使用 SqlSession 來獲得 Mapper 對象。這樣才能保證得到的 Cursor 對象是打開狀態(tài)的。
TransactionTemplate
在 Spring 中，我們可以用 TransactionTemplate 來執(zhí)行一個數(shù)據(jù)庫事務，這個過程中數(shù)據(jù)庫連接同樣是打開的：
@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)建了一個 TransactionTemplate 對象（此處 transactionManager 是怎么來的不用多解釋，本文假設讀者對 Spring 數(shù)據(jù)庫事務的使用比較熟悉了），2 處執(zhí)行數(shù)據(jù)庫事務，而數(shù)據(jù)庫事務的內(nèi)容則是調(diào)用 Mapper 對象的流式查詢。注意這里的 Mapper 對象無需通過 SqlSession 創(chuàng)建。
@Transactional 注解
這個本質(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 -> { });
}
}它僅僅是在原來方法上面加了個 @Transactional 注解。這個方案看上去最簡潔，但請注意 Spring 框架當中注解使用的坑：只在外部調(diào)用時生效。在當前類中調(diào)用這個方法，依舊會報錯。
到此這篇關于Mybatis中流式查詢的實現(xiàn)示例的文章就介紹到這了,更多相關Mybatis 流式查詢內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
通過 ThreadPoolExecutor 可以實現(xiàn)各式各樣的自定義線程池,而 ScheduledThreadPoolExecutor 類則在自定義線程池的基礎上增加了周期性執(zhí)行任務的功能,這篇文章主要介紹了SpringBoot整合定時任務,需要的朋友可以參考下2024-05-05
Springboot+Jackson自定義注解數(shù)據(jù)脫敏的項目實踐
數(shù)據(jù)脫敏可以對敏感數(shù)據(jù)比如 手機號、銀行卡號等信息進行轉換或者修改，本文主要介紹了Springboot+Jackson?自定義注解數(shù)據(jù)脫敏，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-08-08
Comparator是個接口，可重寫compare()及equals()這兩個方法,接下來通過本文給大家介紹Java中Collections.sort排序，需要的的朋友參考下吧2017-04-04
這篇文章主要介紹了Java語言求解完美數(shù)代碼分析，具有一定參考價值，需要的朋友可以了解下。2017-12-12
IDEA Maven Mybatis generator 自動生成代碼(實例講解)
下面小編就為大家分享一篇IDEA Maven Mybatis generator 自動生成代碼的實例講解，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2017-12-12
這篇文章主要介紹了Java 線程的生命周期,結合完整實例形式分析了java線程周期相關的加鎖、釋放鎖、阻塞、同步等原理與操作技巧,需要的朋友可以參考下2019-10-10
JavaEE組件commons-fileupload實現(xiàn)文件上傳、下載
這篇文章主要介紹了JavaEE組件commons-fileupload實現(xiàn)文件上傳、下載,具有一定的參考價值，感興趣的小伙伴們可以參考一下2016-10-10
如果使用Get請求,直接使用對象接收,則可以使用@DateTimeFormat注解進行格式化,本文重點給大家介紹springboot接收日期類型參數(shù)的方法,感興趣的朋友一起看看吧2024-02-02
這篇文章主要為大家詳細介紹了Java實現(xiàn)并查集，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2020-07-07
這篇文章主要介紹了在Spring中如何注入動態(tài)代理Bean問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2025-03-03