MyBatis分页插件—PageHelper如何使用详细（基于SSM）

2023-09-23 17:44:15

MyBatis分页插件—PageHelper的使用详解

最近在做SSM（Spring+SpringMVC+MyBatis）新闻管理系统项目，新闻添加过多导致页面太长体验不好，所以考虑进行分页操作，一开始自己手写了分页工具类和SQL语句limt控制，感觉有些麻烦，检索信息的时候发现MyBatis居然有个分页插件pagehelper，看了一会儿官方文档，没怎么看懂，相关的文章也比较少，都不是很详细，摸索了半天，来给大家上一个比较详细的步骤，

注意：这个项目不是Maven项目。

一、首先要导入插件的jar包：

需要两个jar包，一个pagehelper.jar，还需要一个sql解析包jsqlparser.jar
下载链接：https://mvnrepository.com/artifact/com.github.pagehelper/pagehelper/5.2.0
下载链接：https://mvnrepository.com/artifact/com.github.jsqlparser/jsqlparser/4.0

二、配置pagehelper

两种方式，一种是配置在Spring的配置xml中，也可以配置在Mybatis的xml配置文件中。

在mybatis配置文件mybatis-config.xml中配置：

<configuration>
	<plugins>
		<plugin interceptor="com.github.pagehelper.PageInterceptor">

			<!-- reasonable：分页合理化参数，默认值为false。
			当该参数设置为 true 时，pageNum<=0 时会查询第一页，
			 pageNum>pages（超过总数时），会查询最后一页。默认false 时，
			 直接根据参数进行查询。 -->
			 <!-- 通俗的讲就是在最后一页如果点击下一页（或者说是切换到下一页）
			 就会回到首页 -->
			<property name="reasonable" value="true"/>
			
			<!-- 使用下面的方式配置参数，后面会有所有的参数介绍，可以不写参数-->
			<!-- 这个是参数演示，不填参数需要删除-->
        	<property name="param1" value="value1"/>
        	
		</plugin>
	</plugins>
</configuration>

在Spring配置文件springmvc-config.xml中配置：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <!-- 注意其他配置 -->
  <property name="plugins">
    <array>
      <bean class="com.github.pagehelper.PageInterceptor">
        <property name="properties">
          <!--使用下面的方式配置参数，一行配置一个 -->
          <value>
            params=value1
          </value>
        </property>
      </bean>
    </array>
  </property>
</bean>

参数介绍：

下面几个参数都是针对默认 dialect 情况下的参数。使用自定义 dialect 实现时，下面的参数没有任何作用

1、helperDialect：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。你可以配置helperDialect属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值：oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby
特别注意：使用 SqlServer2012 数据库时，需要手动指定为 sqlserver2012，否则会使用 SqlServer2005 的方式进行分页。
你也可以实现 AbstractHelperDialect，然后配置该属性为实现类的全限定名称即可使用自定义的实现方法。
2、offsetAsPageNum：默认值为 false，该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为 true 时，会将 RowBounds 中的 offset 参数当成 pageNum 使用，可以用页码和页面大小两个参数进行分页。
3、rowBoundsWithCount：默认值为false，该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为true时，使用 RowBounds 分页会进行 count 查询。
4、pageSizeZero：默认值为 false，当该参数设置为 true 时，如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果（相当于没有执行分页查询，但是返回结果仍然是 Page 类型）。
5、reasonable：分页合理化参数，默认值为false。当该参数设置为 true 时，pageNum<=0 时会查询第一页， pageNum>pages（超过总数时），会查询最后一页。默认false 时，直接根据参数进行查询。
6、params：为了支持startPage(Object params)方法，增加了该参数来配置参数映射，用于从对象中根据属性名取值，可以配置 pageNum,pageSize,count,pageSizeZero,reasonable，不配置映射的用默认值，默认值为pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。
7、supportMethodsArguments：支持通过 Mapper 接口参数来传递分页参数，默认值false，分页插件会从查询方法的参数值中，自动根据上面 params 配置的字段中取值，查找到合适的值时就会自动分页。使用方法可以参考测试代码中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和 ArgumentsObjTest。
8、autoRuntimeDialect：默认值为 false。设置为 true 时，允许在运行时根据多数据源自动识别对应方言的分页（不支持自动选择sqlserver2012，只能使用sqlserver），用法和注意事项参考下面的场景五。
9、closeConn：默认值为 true。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类型时，会自动获取一个数据库连接，通过该属性来设置是否关闭获取的这个连接，默认true关闭，设置为 false 后，不会关闭获取的连接，这个参数的设置要根据自己选择的数据源来决定。

注意：当 offsetAsPageNum=false 的时候，由于 PageNum 问题，RowBounds查询的时候 reasonable 会强制为 false。使用 PageHelper.startPage 方法不受影响。

目前只用到一个已经在配置文件中注明，具体可以去看这个博主的https://www.cnblogs.com/xfdhh/p/11523050.html

三、使用分页插件

其实其他文章就是这里只有代码片段，很多自己的类看不懂。这里我会细说。

这里用一个小Demo来测试使用，这里是我的控制器，由于时测试，所以就把逻辑放在了Controller里面，最好放到Service层。

Dao层查询语句：

	<select id="findAll" resultType="User">
		select * from t_user
	</select>

	@RequestMapping(value = "/manage")//控制器访问路径
	public String ManageUser(
		Model mac, //Model用来返回数据
		@RequestParam(required = true, defaultValue = "1") Integer page,
		@RequestParam(required = false, defaultValue = "10") Integer pageSize
		//page默认值是1，pageSize默认是10，意思是从第1页开始，每页显示10条记录。) {
		
		//传入参数：当前页和每页条数
		PageHelper.startPage(page, pageSize);
		
		//调用userService，然后userService再通过dao层的findall查询所有记录
		List<User> list = userService.findAll();
		
		//将获取的list传入PageInfo进行包装分页
		PageInfo<User> pageInfo = new PageInfo<User>(list);
		
		//返回包装好的类在页面中用EL表达式${page.list}就可以取出user对象
		mac.addAttribute("page", pageInfo);
		return "manage";
	}

可能有人会问这里为什么是${page.list}，这个类是插件里面的，我们来看看PageInfo类就知道了

/**
 * 对Page<E>结果进行包装
 * <p/>
 * 新增分页的多项属性，主要参考:http://bbs.csdn.net/topics/360010907
 *
 * @author liuzh/abel533/isea533
 * @version 3.3.0
 * @since 3.2.2
 * 项目地址 : http://git.oschina.net/free/Mybatis_PageHelper
 */
@SuppressWarnings({"rawtypes", "unchecked"})
public class PageInfo<T> extends PageSerializable<T> {
    public static final int DEFAULT_NAVIGATE_PAGES = 8;
    //当前页
    private int pageNum;
    //每页的数量
    private int pageSize;
    //当前页的数量
    private int size;

    //由于startRow和endRow不常用，这里说个具体的用法
    //可以在页面中"显示startRow到endRow 共size条数据"

    //当前页面第一个元素在数据库中的行号
    private long startRow;
    //当前页面最后一个元素在数据库中的行号
    private long endRow;
    //总页数
    private int pages;

    //前一页
    private int prePage;
    //下一页
    private int nextPage;

    //是否为第一页
    private boolean isFirstPage = false;
    //是否为最后一页
    private boolean isLastPage = false;
    //是否有前一页
    private boolean hasPreviousPage = false;
    //是否有下一页
    private boolean hasNextPage = false;
    //导航页码数
    private int navigatePages;
    //所有导航页号
    private int[] navigatepageNums;
    //导航条上的第一页
    private int navigateFirstPage;
    //导航条上的最后一页
    private int navigateLastPage;
	...
	}

这里继承了PageSerializable类

public class PageInfo<T> extends PageSerializable<T>
//PageSerializable类里有个list
public class PageSerializable<T> implements Serializable {
    private static final long serialVersionUID = 1L;
    //总记录数
    protected long    total;
    //结果集
    protected List<T> list;

其他参数都是可以在网页上用el表达式进行判断操作的
例如：

<thead>
                <tr>
                    <th>
						全选<input type="checkbox" id="cbAll" />
                    </th>
                    <th>ID</th>
                    <th>用户名</th>
                    <th>管理</th>
                </tr>
            </thead>
            <tbody id="tb">
            
            <!-- ${page.list}取出user，用forEach进行循环 -->
            <c:forEach items="${page.list}" var="user">
                <tr>
                    <td>
                        <input type="checkbox" name="id" value="${user.id }"/>
                    </td>
                    <td>${user.id }</td>
                    <td>${user.username }</td>
                    <td>
                    	<a class="edit" href="${pageContext.request.contextPath }/toedituser?id=${user.id}" title="修改">
                    		修改
                    	</a>
                    </td>
                </tr>
            </c:forEach>
            </tbody>
        </table>
        <p style="text-align:center;">
        	<!-- 四个参数对应pageinfo里面的类 -->
        	<!-- pageSize 每页的数量 -->
        	<!-- total 总记录数 -->
        	<!-- pageNum 当前页 -->
        	<!-- pages 总页数 -->
        	每页${page.pageSize }条/共有${page.total }条记录，第${page.pageNum }页、共${page.pages }页，
        	<c:choose>
        		<!-- isFirstPage 是否为第一页 -->
        		<c:when test="${page.isFirstPage }">
        			首页&nbsp;&nbsp;
        			上一页&nbsp;&nbsp;
        		</c:when>
        		<c:otherwise>
        			<!-- page接收参数第几页，对应控制器参数 -->
        			<!-- navigateFirstPage 导航条上的首页 -->
        			<a href="manage?page=${page.navigateFirstPage }">首页</a>&nbsp;&nbsp;
        			<!-- prePage 上一页
        			<a href="manage?page=${page.prePage }">上一页</a>&nbsp;&nbsp;
        		</c:otherwise>
        	</c:choose>
        	<c:choose>
        		<!-- isLastPage 是否为最后一页 -->
        		<c:when test="${page.isLastPage }">
        			下一页&nbsp;&nbsp;
        			尾页&nbsp;&nbsp;
        		</c:when>
        		<c:otherwise>
        			<!-- nextPage 是否有下一页 -->
        			<a href="manage?page=${page.nextPage }">下一页</a>&nbsp;&nbsp;
        			<!-- navigateLastPage 导航条上的最后一页 -->
        			<a href="manage?page=${page.navigateLastPage }">尾页</a>&nbsp;&nbsp;
        		</c:otherwise>
        	</c:choose>
        	</p>

四、效果

感谢：
https://www.cnblogs.com/xfdhh/p/11523050.html

https://www.cnblogs.com/kitor/p/11009434.html

https://blog.csdn.net/wxr15732623310/article/details/79242760

https://blog.csdn.net/u012728960/article/details/50791343?utm_medium=distribute.pc_relevant.none-task-blog-2%7Edefault%7EBlogCommendFromMachineLearnPai2%7Edefault-4.control&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2%7Edefault%7EBlogCommendFromMachineLearnPai2%7Edefault-4.control

https://blog.csdn.net/qq_37759106/article/details/80035106

码农公寓

MyBatis分页插件—PageHelper的使用详解

一、首先要导入插件的jar包：

二、配置pagehelper

三、使用分页插件

四、效果

相关文章