MyBatis流式查询两种实现方式

2025-08-09 21:50

本文主要是介绍MyBatis流式查询两种实现方式,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《MyBatis流式查询两种实现方式》本文详解MyBatis流式查询,通过ResultHandler和Cursor实现边读边处理,避免内存溢出,ResultHandler逐条回调,Cursor支持迭代...

MyBatis 流式查询详解:ResultHandler 与 Cursor

在业务中,如果一次性查询出百万级数据并返回 List,很容易造成 OOM长时间 GC
MyBatis 提供了 流式查询(Streaming Query) 能力,让我们可以边读边处理,极大降低内存压力。

1. 什么是流式查询?

普通查询:一次性将全部结果加载到内存,然后再处理。
流式查询:数据库返回一个游标(Cursor)应用端一批一批地从游标读取数据,边读边处理,避免占用大量内存。

适用场景

  • 导出大批量数据(CSV、Excel)
  • 批量处理(数据同步、数据迁移)
  • 实时计算

2. MyBatis 流式查询的两种实现方式

2.1 使用 ResultHandler

ResultHandler 是 MyBatis 提供的经典方式,查询结果不会一次性放到android内存,而是每读取一条就调用一次回调方法。

不带参数示例
@Mapper
public interface UserMapper {
    @Select("SELECT id, name, age FROM user")
    void scanAlhttp://www.chinasem.cnlUsers(ResultHandler<User> handler);
}

调用:

@Autowired
private UserMapper userMapper;
public void processUsersNoParam() {
    userMapper.scanAllUsers(ctx -> {
        User user = ctx.getResultObject();
        System.out.println(user);
    });
}
带参数示例
@Mapper
public interface UserMapper {
    @Select("SELECT id, name, age FROM user WHERE age > #{age}")
    void scanUsersByAge(@Param("age") int age, ResultHandler<User> handler);
}

调用:

public void processUsersWithParam(int minAge) {
    userMapper.scanUsersByAge(minAge, ctx -> {
        User user = ctx.getResultObject();
        System.out.println(user);
    });
}

特点

  • 边查边处理,不占用过多内存
  • 处理逻辑和查询绑定在一起
  • 适合流式消费(文件写入、推送消息)
  • 如果收集成 List,内存压力和普通查询差不多

2.2 使用 Cursor(推荐 MyBatis 3.4+)

Cursor 提供了更接近 JDBC ResultSet 的方式,支持 Iterable 迭代。

不带参数示例
@Mapper
public interface UserMapper {
    @Select("SELECT id, name, age FROM user")
    @Options(fetchSize = Integer.MIN_VALUE) // mysql 开启流式
    Cursor<User> scanAllUsers();
}

调用:

@Transactional
@Transactional
public void getUsersAsList() throws IOException {
    try (Cursor<User> cursor = userMapper.scanAllUsers()) {
        for (User user : cursor) {
            System.out.println(user);
        }
    }
}
带参数示例
@Mapper
public interface UserMapper {
    @Select("SELECT id, name, age FROM user WHERE age > #{age}")
    @Options(fetchSize = Integer.MIN_VALUE)
    Cursor<User> scanUsersByAge(@Param("age") inhttp://www.chinasem.cnt age);
}

调用:

@Transactional
@Transactional
public void getUsersByAge(int minAge) throws IOException {
    try (Cursor<User> cursor = userMapper.scanUsersByAge(minAge)) {
        for (User http://www.chinasem.cnuser : cursor) {
            System.out.println(user);
        }
    }
}

3. Cursor 踩坑:A Cursor is already closed

很多人在用 Cursor 时会遇到:

A Cursor is already closed.

原因

  • Cursor 是延迟加载的,必须在 同一个 SqlSession 存活期间 迭代
  • 如果你在 mapper 方法中返回 Cursor,却在外部再去遍历,此时 SqlSession 已经被 MyBatis 关闭,Cursor 自然不可用

错误示例

Cursor<User> cursor = userMapper.scanAllUsers(); // 此时 SQLSession 会在方法返回后关闭
for (User user : cursor) { // 这里会报错
    ...
}

解决办法

  1. 在同一个方法中迭代,不要把 Cursor 返回到方法外
  2. 加 @Transactional 保证 SqlSession 在方法执行期间不关闭
  3. 用 try-with-resources 及时关闭 Cursor

正确示例

@Transactional
public void processCursor() {
    try (Cursor<User> cursor = userMapper.scanAllUsers()) {
        for (User user : cursor) {
            // 处理数据
        }
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
}

4. 注意事项

  1. MySQL 必须设置 @Options(fetchSize = Integer.MIN_VALUE) 才能真正流式
  2. 事务控制:Cursor 必须在事务或 SqlSession 存活期间消费
  3. 大事务风险:流式处理可能导致事务时间长,要权衡
  4. 网络延迟:流式每次批量取数,可能比一次性查询多几毫秒,但内存安全
  5. 收集成 List 慎用:这样会失去流式查询的内存优势

5. 区别

ResultHandler(回调模式):

  • 基于观察者模式/回调模式
  • MyBatis 主动推送数据给你的处理器
  • 你提供一个处理函数,MyBatis 逐条调用

Cursor(迭代器模式):

  • 基于迭代器模式
  • 你主动从 Cursor 中拉取数据
  • 更符合 Java 集合框架的使用习惯

ResultHandler 更适合:

  • 简单的逐条处理场景
  • 不需要复杂控制流程的情况
  • 希望 MyBatis 完全管理资源的场景

Cursor 更适合:

  • 需要复杂处理逻辑的场景
  • 需要灵活控制处理流程
  • 习惯使用 Java 8 Stream API 的开发者
  • 需要与现有迭代处理代码集成

选择 ResultHandler 当:

  • 处理逻辑简单直接
  • 不需要复杂的流程控制
  • 希望代码更紧凑
  • 不希望手动管理资源

选择 Cursor 当:

  • 需要灵活的流程控制
  • 处理逻辑复杂,需要分步骤
  • 团队熟悉迭代器模式
  • 需要与其他基于迭代器的代码集成
  • 希望有更好的异常处理控制

6. 总结

  • ResultHandler:更灵活,回调式消费,适合不需要一次性得到全部结果
  • Cursor:可迭代,语法直观,但必须在 SqlSession 存活期间消费,否则就会遇到 A Cursor is already closed
  • 带参数查询:ResultHandler 和 Cursor 都支持,只需在 mapper 方法加参数
  • 实战建议
    • 大批量导出、批量同步 → Cursor
    • 条件过滤、部分收集 → ResultHandler
    • 不需要流式直接用普通 List 查询即可

到此这篇关于MyBatis流式查询两种实现方式的文章就介绍到这了,更多相关mybatis流式查询内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程China编程(www.chinasem.cn)!

这篇关于MyBatis流式查询两种实现方式的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1155657

相关文章

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流(parallelStream)的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS

C++中unordered_set哈希集合的实现

《C++中unordered_set哈希集合的实现》std::unordered_set是C++标准库中的无序关联容器,基于哈希表实现,具有元素唯一性和无序性特点,本文就来详细的介绍一下unorder... 目录一、概述二、头文件与命名空间三、常用方法与示例1. 构造与析构2. 迭代器与遍历3. 容量相关4

C++中悬垂引用(Dangling Reference) 的实现

《C++中悬垂引用(DanglingReference)的实现》C++中的悬垂引用指引用绑定的对象被销毁后引用仍存在的情况,会导致访问无效内存,下面就来详细的介绍一下产生的原因以及如何避免,感兴趣... 目录悬垂引用的产生原因1. 引用绑定到局部变量,变量超出作用域后销毁2. 引用绑定到动态分配的对象,对象

MyBatis常用XML语法详解

《MyBatis常用XML语法详解》文章介绍了MyBatis常用XML语法,包括结果映射、查询语句、插入语句、更新语句、删除语句、动态SQL标签以及ehcache.xml文件的使用,感兴趣的朋友跟随小... 目录1、定义结果映射2、查询语句3、插入语句4、更新语句5、删除语句6、动态 SQL 标签7、ehc

SpringBoot基于注解实现数据库字段回填的完整方案

《SpringBoot基于注解实现数据库字段回填的完整方案》这篇文章主要为大家详细介绍了SpringBoot如何基于注解实现数据库字段回填的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解... 目录数据库表pom.XMLRelationFieldRelationFieldMapping基础的一些代

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述:HashMap的宏观结构二、核心数据结构解析1. 数组(桶数组)2. 链表节点(Node

Java AOP面向切面编程的概念和实现方式

《JavaAOP面向切面编程的概念和实现方式》AOP是面向切面编程,通过动态代理将横切关注点(如日志、事务)与核心业务逻辑分离,提升代码复用性和可维护性,本文给大家介绍JavaAOP面向切面编程的概... 目录一、AOP 是什么?二、AOP 的核心概念与实现方式核心概念实现方式三、Spring AOP 的关

Python实现字典转字符串的五种方法

《Python实现字典转字符串的五种方法》本文介绍了在Python中如何将字典数据结构转换为字符串格式的多种方法,首先可以通过内置的str()函数进行简单转换;其次利用ison.dumps()函数能够... 目录1、使用json模块的dumps方法:2、使用str方法:3、使用循环和字符串拼接:4、使用字符

MyBatis延迟加载与多级缓存全解析

《MyBatis延迟加载与多级缓存全解析》文章介绍MyBatis的延迟加载与多级缓存机制,延迟加载按需加载关联数据提升性能,一级缓存会话级默认开启,二级缓存工厂级支持跨会话共享,增删改操作会清空对应缓... 目录MyBATis延迟加载策略一对多示例一对多示例MyBatis框架的缓存一级缓存二级缓存MyBat

Linux下利用select实现串口数据读取过程

《Linux下利用select实现串口数据读取过程》文章介绍Linux中使用select、poll或epoll实现串口数据读取,通过I/O多路复用机制在数据到达时触发读取,避免持续轮询,示例代码展示设... 目录示例代码(使用select实现)代码解释总结在 linux 系统里,我们可以借助 select、