MyBatis分页插件PageHelper的使用

前期准备工作

数据库表

dp.properties

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/netshop?useSSL=true&useUnicode=true&characterEncoding=utf-8
username=root
password=123

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">

<!--
    编写第一个MyBatis程序
        1、编写MyBatis核心配置文件
        2、编写MyBatis工具类
 -->


<!-- configuration核心配置文件 -->
<configuration>

    <!-- 引入db.properties配置文件 -->
    <properties resource="db.properties" />

    <!-- 配置日志 -->
    <settings>
        <!-- 配置标准输出日志STDOUT_LOGGING -->
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>
    
    <!-- 给实体类起别名 -->
    <typeAliases>
        <package name="com.lzp.pojo"/>
    </typeAliases>

    <!-- 在mybatis-config.xml中定义 -->
    <plugins>
        <!-- com.github.pagehelper为PageHelper类所在包名 -->
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            <!-- 使用MySQL方言的分页 -->
            <property name="helperDialect" value="mysql"/><!--如果使用mysql，这里value为mysql-->
            <property name="pageSizeZero" value="true"/>
        </plugin>
    </plugins>

    <!-- 环境配置 -->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>

    <!-- 注册所有mapper.xml文件 这里特别要注意的是，XML配置文件的全路径要把点改成/-->
    <mappers>
       <mapper class="com.lzp.mapper.GoodsMapper"/>
    </mappers>
</configuration>

mapper接口

 1 package com.lzp.mapper;
 2 
 3 import com.lzp.pojo.Goods;
 4 
 5 import java.util.List;
 6 import java.util.Map;
 7 
 8 /**
 9  * 商品业务接口
10  */
11 public interface GoodsMapper {
12 
13     public List<Goods> listGoods();
14 
15 }

mapper映射文件

 1 <?xml version="1.0" encoding="UTF-8" ?>
 2 <!DOCTYPE mapper
 3         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
 4         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
 5 <mapper namespace="com.lzp.mapper.GoodsMapper">
 6 
 7     <select id="listGoods" resultType="goods">
 8         select * from tb_goods
 9     </select>
10 
11 </mapper>

首先、要使用PageHelper插件就要先引入其依赖

<dependencies>
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.0.0</version>
        </dependency>
    </dependencies>

然后、在mybatis-config.xml配置文件中定义pageHelper

<!-- 在mybatis-config.xml中定义 -->
    <plugins>
        <!-- com.github.pagehelper为PageHelper类所在包名 -->
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            <!-- 使用MySQL方言的分页 -->
            <property name="helperDialect" value="mysql"/><!--如果使用mysql，这里value为mysql-->
            <property name="pageSizeZero" value="true"/>
        </plugin>
    </plugins>

最后、测试

package com.lzp.test;

import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.lzp.mapper.GoodsMapper;
import com.lzp.pojo.Goods;
import com.lzp.util.MyBatisUtil;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import java.util.List;

/**
 * @Author LZP
 * @Date 2021/6/22 20:21
 * @Version 1.0
 */
public class GoodsTest {

    @Test
    public void listGoods() {
        SqlSession sqlSession = MyBatisUtil.getSqlSession();
        GoodsMapper mapper = sqlSession.getMapper(GoodsMapper.class);
//       分页开始
        PageHelper.startPage(1, 5);
        PageInfo<Goods> pageInfo = new PageInfo<>(mapper.listGoods());
        List<Goods> list = pageInfo.getList();
        for (Goods g : list) {
            System.out.println(g);
        }
    }

}

控制台打印结果如下：