MyBatis 分页插件的实现

本文详细介绍了如何使用MyBatis分页插件实现数据库的分页操作。内容包括分页拦截器的原理,Page对象类的设计,Dialect方言的实现,包括MySQL方言的示例,以及Dialect工厂类的用途。此外,还讲解了在Spring Boot和XML配置中注册拦截器的不同方式,并展示了在实际应用中如何结合User对象、UserMapper、UserMapper.xml、UserService和UserServiceImpl使用分页插件。文章最后探讨了为何不能在Mapper中直接返回Page对象,并提出了对Executor执行过程的理解。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

MyBatis 分页功能是有所欠缺的,需要手动也分页SQL实现;当然也不是不可以解决,比如使用插件就可以很好的解决这个

先了解下 MybatisMapper 执行过程: 我们通过映射器 Mapper 对数据库进行增删改操作时,Mapper 执行的过程是通过 ExecutorStatementHandlerParameterHandlerResultHandler 来完成对数据库的操作和返回结果

  • Executor 代表执行器,由它来调度StatementHandler、ParameterHandler、ResultHandler等来执行对应的SQL。
  • StatementHandler 的作用是使用数据库的Statement(PreparedStatement) 执行操作,是上面提到的四个对象的核心。
  • ParameterHandler 用于SQL对参数的处理。
  • ResultHandler是进行最后数据集(ResultSet)的封装返回处理的。

前提

MyBatis 拦截器知识介绍

public interface Interceptor {
   
   
    Object intercept(Invocation var1) throws Throwable;

    Object plugin(Object var1);

    void setProperties(Properties var1);
}
  • intercept方法是插件的核心方法,它有个Invocation类型的参数,通过这个参数可以反射调度原来对象的方法。
  • plugin方法的作用是给被拦截的对象生成一个代理对象并返回。
  • setProperties方法允许在plugin元素中配置所需参数。

分页拦截器

思路:在Mapper 方法中传入Page分页对象,在拦截器中根据是否有分页Page对象来判断是否进行分页

Page对象类

public class Pagination<T> {
   
   
	// 开始页(当前页)
	private int startPage;
	// 每页的记录数
	private int pageSize;
	// 总记录数
	private int totalRecord;
	// 总页数
	private int totalPage;
	// 每页的数据集合
	private List<T> content;
	
	public Pagination() {
   
   
		super();
	}
	
	public Pagination(int startPage, int pageSize) {
   
   
		super();
		this.startPage = startPage;
		this.pageSize = pageSize;
	}
	public Pagination(int startPage, int pageSize, int totalRecord, List<T> content) {
   
   
		super();
		this.startPage = startPage;
		this.pageSize = pageSize;
		this.totalRecord = totalRecord;
		this.content = content;
		this.totalPage = this.totalRecord > 0 && this.pageSize > 0 ? (this.totalRecord % this.pageSize == 0 ? this.totalRecord / this.pageSize: this.totalRecord / this.pageSize + 1) : 0;
	}


	public int getStartPage() {
   
   
		return startPage;
	}

	public int getPageSize() {
   
   
		return pageSize;
	}

	public void setPageSize(int pageSize) {
   
   
		this.pageSize = pageSize;
	}

	public int getTotalRecord() {
   
   
		return totalRecord;
	}

	public void setTotalRecord(int totalRecord) {
   
   
		this.totalPage = this.totalRecord > 0 && this.pageSize > 0 ? (this.totalRecord % this.pageSize == 0 ? this.totalRecord / this.pageSize: this.totalRecord / this.pageSize + 1) : 0;
		this.totalRecord = totalRecord;
	}

	public int getTotalPage() {
   
   
		return totalPage;
	}

	public List<T> getContent() {
   
   
		return content;
	}

	public void setContent(List<T> content) {
   
   
		this.content = content;
	}
}

Dialect 方言类

不同的数据库分页的SQL语句是不一样的,这里使用方言的形式来支持不同的数据库,只需要在配置拦截器的时候配置一个dialect参数即可

Dialect接口


public interface Dialect
### MyBatis 分页插件实现方式 MyBatis分页功能可以通过多种方式进行实现,其中最常见的方式之一是通过第三方插件 **PageHelper** 来完成高效的分页操作。以下是关于如何使用 PageHelper 插件的具体实现方法: #### 1. 添加 Maven 或 Gradle 依赖 为了在项目中集成 PageHelper 插件,首先需要将其依赖项引入到项目的构建文件中。对于基于 Maven 构建的项目,可以在 `pom.xml` 文件中添加如下依赖[^3]: ```xml <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.4.2</version> </dependency> ``` 如果使用的是 Spring Boot,则可以直接利用该 Starter 包自动配置 PageHelper。 --- #### 2. 配置 MyBatis 中的 PageHelper 插件MyBatis 的全局配置文件 `mybatis-config.xml` 中,需注册并初始化 PageHelper 插件的相关参数。具体配置如下所示[^2]: ```xml <configuration> <plugins> <plugin interceptor="com.github.pagehelper.PageInterceptor"> <!-- 数据库方言 --> <property name="helperDialect" value="mysql"/> <!-- 是否合理化分页 --> <property name="reasonable" value="true"/> </plugin> </plugins> </configuration> ``` 此部分配置指定了数据库类型以及一些高级选项(如是否启用合理的分页逻辑)。 --- #### 3. 编写代码实现分页查询 在实际开发过程中,可以借助 PageHelper 提供的方法快速实现分页查询。以下是一个典型的 Java 方法示例,展示如何结合 SQL 查询语句执行分页操作: ```java import com.github.pagehelper.PageHelper; import com.github.pagehelper.PageInfo; public List<User> getUserList(int pageNum, int pageSize) { // 设置分页参数:pageNum 表示当前页码;pageSize 表示每页显示记录数 PageHelper.startPage(pageNum, pageSize); // 执行查询操作 List<User> userList = userMapper.selectAllUsers(); // 获取分页后的详细信息 PageInfo<User> pageInfo = new PageInfo<>(userList); return userList; } ``` 在此代码片段中,调用了 `PageHelper.startPage()` 方法设置分页条件,并随后执行具体的 Mapper 层查询逻辑。最终可通过 `PageInfo` 类获取更多有关分页的信息,例如总条目数、总页数等。 --- #### 4. 替代方案——RowBounds 方式 除了使用 PageHelper 外,还可以采用 MyBatis 自带的 `RowBounds` 工具类来实现基本的分页需求[^4]。这种方式虽然简单,但在复杂场景下的灵活性较差。下面是一段演示代码: ```java int offset = (currentPage - 1) * pageSize; // 起始位置 RowBounds rowBounds = new RowBounds(offset, pageSize); // 使用 RowBounds 参数传递给 Mapper 接口中的方法 List<User> users = sqlSession.selectList("selectUser", null, rowBounds); ``` 尽管如此,在大多数情况下推荐优先选用 PageHelper 插件,因为它不仅提供了更强大的功能支持,还简化了编码过程。 --- ### 总结 综上所述,无论是通过引入外部插件还是直接运用内置工具,都可以满足不同层次上的分页需求。然而考虑到便捷性和扩展性等因素,建议开发者倾向于采纳像 PageHelper 这样的成熟解决方案[^1]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值