Mybatis框架如何使用分页插件呢？

分页插件使用的方式

• 修改 pom 文件，添加分页 jar 包依赖  
• 修改 mybatis.xml 文件
• UserDao 接口，UserMapper.xml 添加对应方法与实现 sql
• 对应 UserService 接口添加分页查询方法
• 测试分页效果

案例实操

1.修改 pom 文件，添加分页 jar 包依赖

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

2.修改 mybatis.xml 文件

<plugins>
   <!-- com.github.pagehelper 为 PageHelper 类所在包名 -->
   <plugin interceptor="com.github.pagehelper.PageHelper">
       <property name="dialect" value="mysql" />
       <!-- 该参数默认为 false -->
       <!-- 设置为 true 时，会将 RowBounds 第一个参数 offset 当成 pageNum 页码使用
       -->
       <!-- 和 startPage 中的 pageNum 效果一样 -->
       <property name="offsetAsPageNum" value="true" />
       <!-- 该参数默认为 false -->
       <!-- 设置为 true 时，使用 RowBounds 分页会进行 count 查询 -->
       <property name="rowBoundsWithCount" value="true" />
       <!-- 设置为 true 时，如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全
       部的结果 -->
       <!-- （相当于没有执行分页查询，但是返回结果仍然是 Page 类型） -->
       <property name="pageSizeZero" value="true" />
       <!-- 3.3.0 版本可用 - 分页参数合理化，默认 false 禁用 -->
       <!-- 启用合理化时，如果 pageNum<1 会查询第一页，如果 pageNum>pages 会查询
       最后一页 -->
       <!-- 禁用合理化时，如果 pageNum<1 或 pageNum>pages 会返回空数据 -->
       <property name="reasonable" value="true" />
       <!-- 3.5.0 版本可用 - 为了支持 startPage(Object params)方法 -->
       <!-- 增加了一个params参数来配置参数映射，用于从 Map 或 ServletRequest
       中取值 -->
       <!-- 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射
       的用默认值 -->
       <property name="params"
       value="pageNum=start;pageSize=limit;pageSizeZero=zero;reasonable=heli;count=cou
       ntsql" />
   </plugin>
</plugins>

3.UserDao 接口，UserMapper.xml 添加对应方法与实现 sql

UserDao 接口:

public interface UserDao {
public User queryUserById(int id);
public List<User> queryUsers();
}

UserMapper.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="com.mage.dao.UserDao">
   <select id="queryUserById" parameterType="int" resultType="user">
    select id,userName,userPwd from user where id=#{id}  
   </select>
   <select id="queryUsers" resultType="user">
    select id,userName,userPwd from user  
   </select>
</mapper>

4.对应 UserService 接口添加分页查询方法

public interface UserService {
public User queryUserById();
   /**
   * 分页方法定义
   * @param pageNum 当前页号
   * @param pageSize 设置每页显示数量
   * @return
   */
public PageInfo<User> queryUsers(int pageNum,int pageSize);
}

UserServiceImpl 实现方法:

@Service
public class UserServiceImpl implements UserService{
   @Resource
   private UserDao userDao;
   public User queryUserById(){
    return userDao.queryUserById(7);  
   }
   @Override
   public PageInfo<User> queryUsers(int pageNum, int pageSize) {
       /**
       * PageHelper 类设置分页页号与每页大小
       */
       PageHelper.startPage(pageNum, pageSize);
       List<User> list=userDao.queryUsers();
       PageInfo<User> pageInfo=new PageInfo<User>(list);
       return pageInfo;
   }
}

5.测试分页效果

数据库原始记录

测试

第一次 PageNum =1 pageSize=1

@Test
public void testQueryUsers() {
   PageInfo<User> pageInfo= userService.queryUsers(1, 1);
       for(User user:pageInfo.getList()){
        System.out.println("user:"+user);
   }  
}

结果：

第二次 pageNum=2 pageSize=1

@Test
public void testQueryUsers() {
   PageInfo<User> pageInfo= userService.queryUsers(2, 1);
   for(User user:pageInfo.getList()){
    System.out.println("user:"+user);
   }  
}

结果

备注:分页插件 如果传入的页码 操作记录总页数 此时我们得到的是最后一页的记录

第三次测试 PageNum=3 pageSize=1

@Test
public void testQueryUsers() {
   PageInfo<User> pageInfo= userService.queryUsers(3, 1);
   for(User user:pageInfo.getList()){
    System.out.println("user:"+user);
   }  
}

结果:

扩展

分页插件压缩版

解压即可使用，和之前配置一样去配置好 config.xml，再运行 run.bat 即可