PageHelper
在编写Web后台代码时,分页是必不可少的,当然最通常的思路是在Sql中使用分页关键字来进行分页。在实际开发中,更多的是使用分页插件来减少代码冗杂,使编码更加清晰
思路:分页控制的代码写在拦截器中,从而不影响本来的业务逻辑代码(以PageHelper为例来讲述)
1、 引入分页插件
引入分页插件有下面2种方式,推荐使用 Maven 方式。
1). 引入 Jar 包
你可以从下面的地址中下载最新版本的 jar 包
https://oss.sonatype.org/content/repositories/releases/com/github/pagehelper/pagehelper/
http://repo1.maven.org/maven2/com/github/pagehelper/pagehelper/
由于使用了sql 解析工具,你还需要下载 jsqlparser.jar:
http://repo1.maven.org/maven2/com/github/jsqlparser/jsqlparser/0.9.5/
2). 使用 Maven
在 pom.xml 中添加如下依赖:
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>最新版本</version>
</dependency>
2、 配置拦截器插件
特别注意,新版拦截器是com.github.pagehelper.PageInterceptor。 com.github.pagehelper.PageHelper 现在是一个特殊的 dialect 实现类,是分页插件的默认实现类,提供了和以前相同的用法。
1. 在 MyBatis 配置 xml 中配置拦截器插件
<!--
plugins在配置文件中的位置必须符合要求,否则会报错,顺序如下:
properties?, settings?,
typeAliases?, typeHandlers?,
objectFactory?,objectWrapperFactory?,
plugins?,
environments?, databaseIdProvider?, mappers?
-->
<plugins>
<!-- com.github.pagehelper为PageHelper类所在包名 -->
<plugin interceptor="com.github.pagehelper.PageInterceptor">
<!-- 使用下面的方式配置参数,后面会有所有的参数介绍 -->
<property name="param1" value="value1"/>
</plugin>
</plugins>
2. 在 Spring 配置文件中配置拦截器插件
使用 spring 的属性配置方式,可以使用 plugins 属性像下面这样配置:
<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>
3. 分页插件参数介绍
分页插件提供了多个可选参数,这些参数使用时,按照上面两种配置方式中的示例配置即可。
分页插件可选参数如下:
dialect:默认情况下会使用 PageHelper 方式进行分页,如果想要实现自己的分页逻辑,可以实现 Dialect(com.github.pagehelper.Dialect) 接口,然后配置该属性为实现类的全限定名称。
下面几个参数都是针对默认 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 方法不受影响。
pom.xml(引入jar包)
<!-- pagehelper插件 -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>5.1.8</version>
</dependency>
mybatis-config.xml(配置相关属性)
<plugins>
<!-- com.github.pagehelper为PageHelper类所在包名 -->
<plugin interceptor="com.github.pagehelper.PageInterceptor">
<!-- 使用下面的方式配置参数,后面会有所有的参数介绍 -->
<property name="helperDialect" value="mysql"/>
<property name="reasonable" value="true"/>
</plugin>
</plugins>
mapper.xml(mybatis映射文件)
<select id="findAll" resultType="com.hqyj.bean.sys.SysUser">
select * from sys_user
</select>
dao.java(调用方法)
public List<SysUser> findAll(SysUser user);
service.java(调用方法)
public List<SysUser> findAll(int currentpage,int pagesize){
PageHelper.startPage(currentpage, pagesize);
return dao.findAll();
}
action.java(控制层)
//分页数据
@RequestMapping("/userlist")
public String userlist(
@RequestParam(value ="currentpage",required=false)String currentpage,
@RequestParam(value="pagesize",required=false)String pagesize,
Map map) {
int c_page;
int p_size;
if(currentpage ==null || "".equals(currentpage) ) {
c_page=1;
}else {
c_page=Integer.parseInt(currentpage);
}
if(pagesize==null || "".equals(pagesize)) {
p_size=5;
}else {
p_size=Integer.parseInt(pagesize);
}
List<SysUser> users = service.findAll(c_page, p_size);
PageInfo info = new PageInfo(users);
map.put("users", users);
map.put("page", info);
return "sys/userlist";
}
jsp文件(显示数据)
<c:forEach items="${users}" var="user">
<tr>
<td>${user.id }</td>
<td>${user.username }</td>
<td>${user.email }</td>
<td>${user.password }</td>
<td>
</td>
</tr>
</c:forEach>
jsp文件(页码)
<li>
<a href="userlist?currentpage=1&pagesize=5" class="btn btn-active alink" >首页</a>
</li>
<c:if test="${page.hasPreviousPage}">
<li>
<a href="userlist?currentpage=${page.prePage}&pagesize=5" class="btn btn-active alink" >上一页</a>
</li>
</c:if>
<c:forEach items="${page.navigatepageNums}" var="i">
<li>
<a href="userlist?currentpage=${i}&pagesize=5" class="btn btn-active alink" >${i}</a>
</li>
</c:forEach>
<c:if test="${page.hasNextPage}">
<li>
<a href="userlist?currentpage=${page.nextPage}&pagesize=5" class="btn btn-active alink" >下一页</a>
</li>
</c:if>
<li>
<a href="userlist?currentpage=${page.pages}&pagesize=5" class="btn btn-active alink" >尾页</a>
</li>