插件实战：手写MyBatis分页插件

PageHelper

想必大家都使用过或听说过 MyBatis 的 分页插件 PageHelper，通过这个插件我们根本就不需要将分页的 SQL 或者条件写在 SQL 语句中，只需要在调用 Dao 的时候先定义一下分页的设置。MyBatis 的 PageHelper 是一个非常实用的分页插件，它可以帮助简化在 MyBatis 中进行分页查询的操作。使用 PageHelper 插件，你可以不需要手动编写分页查询的 SQL 语句，而是通过简单的配置来实现分页功能。

特性

• 简单易用: PageHelper 提供了简单的配置方式，可以轻松地在 MyBatis 中启用分页功能。
• 支持多种数据库: PageHelper 支持多种数据库，包括 MySQL、Oracle、PostgreSQL、SQL Server 等。
• 丰富的功能: PageHelper 提供了丰富的功能，包括基本的分页查询、排序、物理分页、内存分页等。
• 可定制化: PageHelper 提供了丰富的配置选项，可以根据实际需求进行定制。

使用步骤

1. 引入 PageHelper 依赖：在 Maven 或者 Gradle 项目中引入 PageHelper 的依赖。
2. 配置 PageHelper：在 MyBatis 的配置文件中配置 PageHelper 插件，指定数据库类型和方言。
3. 分页查询：在需要进行分页查询的方法中，使用 PageHelper.startPage 方法指定分页参数。
4. 获取分页结果：通过 PageHelper 提供的 PageInfo 类来获取分页结果。

示例

以下是一个简单的示例，演示了如何在 MyBatis 中使用 PageHelper 进行分页查询：

// 引入 PageHelper 依赖
<!-- 在 pom.xml 中 -->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>{version}</version>
</dependency>

// 在 MyBatis 的配置文件中配置 PageHelper 插件
<plugins>
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <!-- 指定数据库类型 -->
        <property name="dialect" value="mysql"/>
    </plugin>
</plugins>

// 在需要进行分页查询的方法中使用 PageHelper.startPage 方法
public List<User> getUsers(int pageNum, int pageSize) {
    // 在方法调用前调用 PageHelper.startPage 方法
    PageHelper.startPage(pageNum, pageSize);
    // 执行查询操作
    List<User> userList = userMapper.selectUsers();
    // 获取分页信息
    PageInfo<User> pageInfo = new PageInfo<>(userList);
    // 返回分页结果
    return pageInfo.getList();
}

本篇文章不是来介绍 PageHelper 的使用细节，而是通过我们前面学习到的插件知识，自己动手实现一个自己的 PageHelper！

我直接贴出我的代码，实现的思路和细节可以直接查看代码。

分页与结果实体

package world.xuewei.plugin.page;

/**
 * 分页信息
 *
 * @author 薛伟
 */
public class Page {

    /**
     * 当前页
     */
    protected Integer pageNum;

    /**
     * 页面大小
     */
    protected Integer pageSize;

    public Page(Integer pageNum, Integer pageSize) {
        this.pageNum = pageNum;
        this.pageSize = pageSize;
    }

  	// 省略 Get/Set 方法和 toString
}

package world.xuewei.plugin.page;

/**
 * 分页结果
 *
 * @author 薛伟
 */
public class PageResult extends Page {

    /**
     * 总页数
     */
    private Integer totalPage;

    /**
     * 总记录数
     */
    private Integer totalRecord;

    public PageResult(Page page, Integer totalPage, Integer totalRecord) {
        super(page.getPageNum(), page.getPageSize());
        this.totalPage = totalPage;
        this.totalRecord = totalRecord;
    }
    
    // 省略 Get/Set 方法和 toString
}

分页工具类（PageHelper）

注意这里要用 ThreadLocal 来将分页的信息存储在当前的线程中，并且要注意及时清理，否则容易造成内存泄漏。

package world.xuewei.plugin.page;

/**
 * 分页配置器
 *
 * @author 薛伟
 */
public class PageHelper {

    /**
     * 存储分页信息
     */
    private static final ThreadLocal<Page> page = new ThreadLocal<>();

    /**
     * 分页结果
     */
    private static final ThreadLocal<Page> pageResult = new ThreadLocal<>();

    /**
     * 开始分页
     *
     * @param pageNum  当前页
     * @param pageSize 页面大小
     */
    public static void startPage(Integer pageNum, Integer pageSize) {
        pageNum = pageNum == null ? 1 : pageNum;
        pageSize = pageSize == null ? Integer.MAX_VALUE : pageSize;
        if (pageNum <= 0 || pageSize <= 0) {
            throw new IllegalArgumentException("pageNum and pageSize must be greater than 0");
        }
        page.set(new Page(pageNum, pageSize));
    }

    /**
     * 清空分页
     */
    public static void clearPage() {
        if (page.get() != null) page.remove();
    }

    /**
     * 获取分页
     */
    public static Page getPage() {
        return page.get();
    }

    /**
     * 设置分页结果
     */
    public static void setPageResult(PageResult result) {
        pageResult.set(result);
    }

    /**
     * 获取分页结果
     */
    public static Page getPageResult() {
        Page result = pageResult.get();
        // 获取过后就及时清空
        pageResult.remove();
        return result;
    }
}

分页拦截器

package world.xuewei.plugin.page;

import org.apache.ibatis.binding.MapperMethod;
import org.apache.ibatis.executor.parameter.ParameterHandler;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.SqlCommandType;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.SystemMetaObject;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Properties;

/**
 * 分页拦截器
 *
 * @author 薛伟
 */
@Intercepts(@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class}))
public class PagePlugin implements Interceptor {

    /**
     * 执行的拦截逻辑
     */
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        MetaObject metaObject = SystemMetaObject.forObject(invocation);
        String sql = (String) metaObject.getValue("target.boundSql.sql");
        SqlCommandType commandType = (SqlCommandType) metaObject.getValue("target.delegate.mappedStatement.sqlCommandType");
        if (commandType != SqlCommandType.SELECT) {
            // 跳过非查询类方法
            return invocation.proceed();
        }
        Page page = PageHelper.getPage();
        if (page == null) {
            // 未设置分页
            return invocation.proceed();
        }
        Integer pageNum = page.getPageNum();
        Integer pageSize = page.getPageSize();
        String pageSql = String.format("%s limit %d, %d", sql, (pageNum - 1) * pageSize, pageSize);
        metaObject.setValue("target.boundSql.sql", pageSql);
        PageHelper.clearPage();
        // 保存分页结果
        savePageResult(invocation, metaObject, sql, page);
        return invocation.proceed();
    }

    /**
     * 保存分页结果（传统 JDBC 编程）
     *
     * @param invocation 调用对象
     * @param metaObject 反射对象
     * @param querySql   查询 SQl
     */
    public void savePageResult(Invocation invocation, MetaObject metaObject, String querySql, Page page) throws Throwable {
        // 获取 JDBC 连接对象
        Connection connection = (Connection) invocation.getArgs()[0];
        Integer pageNum = page.getPageNum();
        Integer pageSize = page.getPageSize();
        // 查询总记录数
        String countSql = String.format("select count(*) %s", querySql.substring(querySql.indexOf("from")));
        PreparedStatement preparedStatement = connection.prepareStatement(countSql);
        // 进行参数赋值
        ParameterHandler parameterHandler = (ParameterHandler) metaObject.getValue("target.delegate.parameterHandler");
        parameterHandler.setParameters(preparedStatement);
        ResultSet resultSet = preparedStatement.executeQuery();
        int totalCount = 0;
        if (resultSet.next()) {
            totalCount = resultSet.getInt(1);
        }
        // 计算总页数
        int totalPage = totalCount % pageSize == 0 ? totalCount / pageSize : totalCount / pageSize + 1;
        PageHelper.setPageResult(new PageResult(page, totalPage, totalCount));
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
    }
}

MyBatis 配置文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

    <typeAliases>
        <typeAlias type="world.xuewei.mybatis.entity.Account" alias="Account"/>
    </typeAliases>

    <plugins>
        <plugin interceptor="world.xuewei.plugin.page.PagePlugin"/>
    </plugins>

    <environments default="default">
        <environment id="default">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url"
                          value="jdbc:mysql://*.*.*.*/learn?useSSL=false&amp;characterEncoding=utf8"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="mappers/AccountMapper.xml"/>
    </mappers>

</configuration>

测试程序

package world.xuewei;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import world.xuewei.mybatis.dao.AccountDao;
import world.xuewei.plugin.page.PageHelper;

import java.io.IOException;
import java.io.InputStream;

/**
 * 分页插件测试
 *
 * @author 薛伟
 * @since 2023/9/14 20:51
 */
public class PageTest {

    private SqlSession sqlSession;

    @Before
    public void before() throws IOException {
        InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        sqlSession = sessionFactory.openSession();
    }

    @After
    public void after() {
        sqlSession.commit();
    }

    @Test
    public void testGetAll() {
        AccountDao accountDao = sqlSession.getMapper(AccountDao.class);
        PageHelper.startPage(1, 3);
        System.out.println("查询结果：" + accountDao.getAll());
        System.out.println("分页结果：" + PageHelper.getPageResult());
        System.out.println("============================================");
        PageHelper.startPage(2, 3);
        System.out.println("查询结果：" + accountDao.getAll());
        System.out.println("分页结果：" + PageHelper.getPageResult());
    }

    @Test
    public void testGetBySex() {
        AccountDao accountDao = sqlSession.getMapper(AccountDao.class);
        PageHelper.startPage(1, 4);
        System.out.println("查询结果：" + accountDao.getBySex("男"));
        System.out.println("分页结果：" + PageHelper.getPageResult());
        System.out.println("============================================");
        PageHelper.startPage(1, 2);
        System.out.println("查询结果：" + accountDao.getBySex("女"));
        System.out.println("分页结果：" + PageHelper.getPageResult());
    }
}