穿插一个 MyBatis 分页插件 PageHelper 使用的 Demo

原创

mb5fdcae3079e89 2021-01-15 11:08:12 ©著作权

文章标签 java 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mb5fdcae3079e89的原创作品，请联系作者获取转载授权，否则将追究法律责任

前面说了一题 MyBatis 有哪些分页的方式？其原理是什么？，后面还有一题 MyBatis 插件的运行原理是什么？

为了方便调试，梳理出步骤与原理，先整一个 MyBatis-PageHelper 的使用 Demo。

1、Maven 依赖，mysql 驱动 + MyBatis + pagehelper

<project xmlns="http:///POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http:///POM/4.0.0 http:///xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>constxiong</groupId>
        <artifactId>demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <artifactId>mybatis-pageHelper</artifactId>

    <dependencies>
        <!-- MySQL 8.0.21 驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.21</version>
        </dependency>

        <!-- MyBatis -->
        <dependency>
          <groupId>org.mybatis</groupId>
          <artifactId>mybatis</artifactId>
          <version>3.5.5</version>
        </dependency>

        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.2.0</version>
        </dependency>

    </dependencies>

    <build>

    </build>
</project>

2、MyBatis 配置文件 mybatis-config.xml

<?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>
    <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            <property name="helperDialect" value="mysql"/>
        </plugin>
    </plugins>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://172.31.32.184:3306/constxiong?serverTimezone=UTC&amp;useSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value="constxiong@123"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="constxiong/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

3、写 SQL 的 mapper xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="constxiong.mapper.UserMapper">

    <select id="selectUsers" resultType="constxiong.po.User">
        select * from user
    </select>

    <insert id="insertUser" parameterType="constxiong.po.User">
        insert into user values(#{id}, #{name})
    </insert>

    <delete id="deleteUsers">
      delete from user
    </delete>

</mapper>

4、Mapper 接口类

package constxiong.mapper;

import constxiong.po.User;

import java.util.List;

/**
 * UserMapper 接口，映射对数据库的操作
 */
public interface UserMapper {

    List<User> selectUsers();

    int insertUser(User user);

    int deleteUsers();
}

5、User PO 模型

package constxiong.po;

/**
 * 用户表模型
 */
public class User {
    private Integer id;

    private String name;

    private String mc;

    public User(Integer id, String name) {
        this.id = id;
        this.name = name;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getMc() {
        return mc;
    }

    public void setMc(String mc) {
        this.mc = mc;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", mc='" + mc + '\'' +
                '}';
    }
}

6、测试代码

package constxiong;

import com.github.pagehelper.ISelect;
import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import constxiong.mapper.UserMapper;
import constxiong.po.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

/**
 * 测试 Mybatis 分页插件
 */
public class Test {

    public static void main(String[] args) throws IOException {
        testXmlConfigAndPager();
    }

    /**
     * 测试 xml 配置方式分页
     */
    private static void testXmlConfigAndPager() throws IOException {
        String resource = "mybatis-config.xml";//xml配置文件路径
        InputStream inputStream = Resources.getResourceAsStream(resource);//读取配置
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);//构建 SqlSessionFactory
        SqlSession sqlSession = sqlSessionFactory.openSession(true);//通过 SqlSessionfactory 获取 SqlSession

        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);//通过 SqlSession 获取 Mapper 接口

        //删除 user
        userMapper.deleteUsers();

        //插入 user
        for (int i = 1; i <= 35; i++) {
            userMapper.insertUser(new User(i, "ConstXiong" + i));
        }

        //查询所有 user
        List<User> users = userMapper.selectUsers();
        System.out.println(users);

        //未打开 mybatis-config.xml 中 plugins 标签使用内存分页；打开标签使用插件的物理分页
        int pageNo = 2;
        int pageSize = 10;
        users = sqlSession.selectList("constxiong.mapper.UserMapper.selectUsers", null, new RowBounds((pageNo - 1) * pageSize, pageSize));
        System.out.println(users);

        //使用静态方法 startPage
        PageHelper.startPage(pageNo, pageSize);
        users = userMapper.selectUsers();
        System.out.println(users);

        //使用静态方法 offsetPage
        PageHelper.offsetPage(pageNo, pageSize);
        users = userMapper.selectUsers();
        System.out.println(users);

        //匿名类
        Page<User> page = PageHelper.startPage(pageNo, pageSize).doSelectPage(new ISelect() {
            @Override
            public void doSelect() {
                userMapper.selectUsers();
            }
        });
        System.out.println(page);
        // lambda
        page = PageHelper.startPage(pageNo, pageSize).doSelectPage(() -> {
            userMapper.selectUsers();
        });
        System.out.println(page);

        //仅合计
        long count = PageHelper.count(new ISelect() {
            @Override
            public void doSelect() {
                userMapper.selectUsers();
            }
        });
        System.out.println(count);
        //lambda
        count = PageHelper.count(() -> {
            userMapper.selectUsers();
        });
        System.out.println(count);

        //关闭 SqlSession
        sqlSession.close();
    }

}

7、运行结果

[User{id=1, name='ConstXiong1', mc='null'}, User{id=2, name='ConstXiong2', mc='null'}, User{id=3, name='ConstXiong3', mc='null'}, User{id=4, name='ConstXiong4', mc='null'}, User{id=5, name='ConstXiong5', mc='null'}, User{id=6, name='ConstXiong6', mc='null'}, User{id=7, name='ConstXiong7', mc='null'}, User{id=8, name='ConstXiong8', mc='null'}, User{id=9, name='ConstXiong9', mc='null'}, User{id=10, name='ConstXiong10', mc='null'}, User{id=11, name='ConstXiong11', mc='null'}, User{id=12, name='ConstXiong12', mc='null'}, User{id=13, name='ConstXiong13', mc='null'}, User{id=14, name='ConstXiong14', mc='null'}, User{id=15, name='ConstXiong15', mc='null'}, User{id=16, name='ConstXiong16', mc='null'}, User{id=17, name='ConstXiong17', mc='null'}, User{id=18, name='ConstXiong18', mc='null'}, User{id=19, name='ConstXiong19', mc='null'}, User{id=20, name='ConstXiong20', mc='null'}, User{id=21, name='ConstXiong21', mc='null'}, User{id=22, name='ConstXiong22', mc='null'}, User{id=23, name='ConstXiong23', mc='null'}, User{id=24, name='ConstXiong24', mc='null'}, User{id=25, name='ConstXiong25', mc='null'}, User{id=26, name='ConstXiong26', mc='null'}, User{id=27, name='ConstXiong27', mc='null'}, User{id=28, name='ConstXiong28', mc='null'}, User{id=29, name='ConstXiong29', mc='null'}, User{id=30, name='ConstXiong30', mc='null'}, User{id=31, name='ConstXiong31', mc='null'}, User{id=32, name='ConstXiong32', mc='null'}, User{id=33, name='ConstXiong33', mc='null'}, User{id=34, name='ConstXiong34', mc='null'}, User{id=35, name='ConstXiong35', mc='null'}]
Page{count=false, pageNum=2, pageSize=10, startRow=10, endRow=20, total=-1, pages=1, reasonable=false, pageSizeZero=false}[User{id=11, name='ConstXiong11', mc='null'}, User{id=12, name='ConstXiong12', mc='null'}, User{id=13, name='ConstXiong13', mc='null'}, User{id=14, name='ConstXiong14', mc='null'}, User{id=15, name='ConstXiong15', mc='null'}, User{id=16, name='ConstXiong16', mc='null'}, User{id=17, name='ConstXiong17', mc='null'}, User{id=18, name='ConstXiong18', mc='null'}, User{id=19, name='ConstXiong19', mc='null'}, User{id=20, name='ConstXiong20', mc='null'}]
Page{count=true, pageNum=2, pageSize=10, startRow=10, endRow=20, total=35, pages=4, reasonable=false, pageSizeZero=false}[User{id=11, name='ConstXiong11', mc='null'}, User{id=12, name='ConstXiong12', mc='null'}, User{id=13, name='ConstXiong13', mc='null'}, User{id=14, name='ConstXiong14', mc='null'}, User{id=15, name='ConstXiong15', mc='null'}, User{id=16, name='ConstXiong16', mc='null'}, User{id=17, name='ConstXiong17', mc='null'}, User{id=18, name='ConstXiong18', mc='null'}, User{id=19, name='ConstXiong19', mc='null'}, User{id=20, name='ConstXiong20', mc='null'}]
Page{count=true, pageNum=2, pageSize=10, startRow=2, endRow=12, total=35, pages=4, reasonable=false, pageSizeZero=false}[User{id=3, name='ConstXiong3', mc='null'}, User{id=4, name='ConstXiong4', mc='null'}, User{id=5, name='ConstXiong5', mc='null'}, User{id=6, name='ConstXiong6', mc='null'}, User{id=7, name='ConstXiong7', mc='null'}, User{id=8, name='ConstXiong8', mc='null'}, User{id=9, name='ConstXiong9', mc='null'}, User{id=10, name='ConstXiong10', mc='null'}, User{id=11, name='ConstXiong11', mc='null'}, User{id=12, name='ConstXiong12', mc='null'}]
Page{count=true, pageNum=2, pageSize=10, startRow=10, endRow=20, total=35, pages=4, reasonable=false, pageSizeZero=false}[User{id=11, name='ConstXiong11', mc='null'}, User{id=12, name='ConstXiong12', mc='null'}, User{id=13, name='ConstXiong13', mc='null'}, User{id=14, name='ConstXiong14', mc='null'}, User{id=15, name='ConstXiong15', mc='null'}, User{id=16, name='ConstXiong16', mc='null'}, User{id=17, name='ConstXiong17', mc='null'}, User{id=18, name='ConstXiong18', mc='null'}, User{id=19, name='ConstXiong19', mc='null'}, User{id=20, name='ConstXiong20', mc='null'}]
Page{count=true, pageNum=2, pageSize=10, startRow=10, endRow=20, total=35, pages=4, reasonable=false, pageSizeZero=false}[User{id=11, name='ConstXiong11', mc='null'}, User{id=12, name='ConstXiong12', mc='null'}, User{id=13, name='ConstXiong13', mc='null'}, User{id=14, name='ConstXiong14', mc='null'}, User{id=15, name='ConstXiong15', mc='null'}, User{id=16, name='ConstXiong16', mc='null'}, User{id=17, name='ConstXiong17', mc='null'}, User{id=18, name='ConstXiong18', mc='null'}, User{id=19, name='ConstXiong19', mc='null'}, User{id=20, name='ConstXiong20', mc='null'}]
35
35

8、结论

启用分页插件的方式：

查询使用 RowBounds 参数
使用静态方法 PageHelper.startPage
使用静态方法 PageHelper.offsetPage
PageHelper.startPage、PageHelper.offsetPage 返回的 Page 对象调用 doSelectPage 方法传入 ISelect 的实现类或 Lambda

官方文档给出说明，只要是正常使用以上方法都是线程安全的。

被分页插件处理过的查询结果，返回的是 com.github.pagehelper.Page 类的对象。

PageHelper.count 方法支持仅获取统计结果。