SSM整合之分页功能的实现

分页

 有两种方式：使用mybatis的插件pagehelper，或者自己写一个分页类

1、使用插件形式

　　第一步：引入jar包，或导入依赖

　　　　jar包地址：https://oss.sonatype.org/content/repositories/releases/com/github/pagehelper/pagehelper/

　　　　导入依赖

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

　　第二步：配置拦截器插件

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

 　　在spring配置文件中配置拦截器插件

<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 方法不受影响。

　　第三步：分页插件的使用

 //分页插件的使用
    public PageInfo<User> select2(QueryBean queryBean) {
        //传入参数：当前页和每页条数
        PageHelper.startPage(queryBean.getCurrentPage(),queryBean.getPageSize());
        //写在startPage下的第一次查询会默认被插件使用分页查询
        List<User> list = userMapper.select(queryBean);
        //通过包装获取分页所需的其他值
        PageInfo<User> pageInfo = new PageInfo<>(list);
        //返回分页对象，此时查询到的结果被封装到分页对象的list属性中
        return pageInfo;
}

2、使用自定义分页工具

　　1、第一步：写一个分页工具类，封装需要用到的属性，提供setter和getter方法

@Setter@Getter@ToString
public class PageUtils {
    //前台传入
    //当前页
    private Integer pageNum;
    //每页的条数
    private Integer pageSize;

    //数据库查询得到
    //总条数
    private Integer total;
    //查询结果
    private List list;

    //计算得到
    //总页数
    private Integer pages;
    //上一页
    private Integer prePage;
    //下一页
    private Integer nextPage;
}

　　2、第二步：在UserMapper和UserMapper.xml中配置需要用到的方法，即查询总条数和条件分页查询方法

//手动实现分页需要用到的方法
    Integer selectCount(QueryBean queryBean);
    List<User> selectAll(QueryBean queryBean);

<!--手动实现分页需要用到的查询，查询总条数-->
    <select id="selectCount" resultType="integer">
        select count(*) from users
        <where>
            <if test="username!=null">
                and username like concat('%',#{username},'%')
            </if>
            <if test="date!=null">
                and date like concat('%',#{date},'%')
            </if>
        </where>
    </select>
    <!--手动实现分页需要用到的查询，条件查询，
    下面的start每页开始的条数利用封装在参数类中的get方法直接得到-->
    <select id="selectAll" resultMap="myResultMap">
        select * from users
        <where>
            <if test="username!=null">
                and username like concat('%',#{username},'%')
            </if>
            <if test="date!=null">
                and date like concat('%',#{date},'%')
            </if>
        </where>
        limit #{start},#{pageSize}
    </select>

　　3、第三步：在实现类中使用此插件

public PageUtils select3(QueryBean queryBean) {
        Integer total = userMapper.selectCount(queryBean);
        PageUtils pageUtils = new PageUtils();
        //从前台取出的数据赋值
        pageUtils.setPageNum(queryBean.getCurrentPage());
        pageUtils.setPageSize(queryBean.getPageSize());
        //从数据库中查询出的数据赋值
        pageUtils.setList(userMapper.selectAll(queryBean));
        pageUtils.setTotal(total);
        //经过计算得到的数据赋值
        int pages = Double.valueOf(Math.ceil(pageUtils.getTotal()*1.0/pageUtils.getPageSize())).intValue();
        pageUtils.setPages(pages);
        Integer nextPage;//判断是否已经到了最后一页，如果是，则下一次跳转到第一页
        if(queryBean.getCurrentPage()==pageUtils.getPages()){
            nextPage=1;
        }else{
            nextPage=queryBean.getCurrentPage()+1;
        }
        pageUtils.setNextPage(nextPage);
        Integer prePage;//判断是否已经到了第一页，如果是，则下一次跳转到最后一页
        if(queryBean.getCurrentPage()==1){
            prePage=pageUtils.getPages();
        }else{
            prePage=queryBean.getCurrentPage()-1;
        }
        pageUtils.setPrePage(prePage);

        return pageUtils;
}

　　4、第四步：可以看到实现类中代码复杂度很高，可以利用封装分页工具中构造方法的方式减少代码

　　分页工具类中的构造方法

@Setter@Getter@ToString
public class PageUtils {
    //前台传入
    //当前页
    private Integer pageNum;
    //每页的条数
    private Integer pageSize;

    //数据库查询得到
    //总条数
    private Integer total;
    //查询结果
    private List list;

    //计算得到
    //总页数
    private Integer pages;
    //上一页
    private Integer prePage;
    //下一页
    private Integer nextPage;

    public PageUtils(Integer pageNum,Integer pageSize,List list,Integer total){
        this.pageNum=pageNum;
        this.pageSize=pageSize;

        this.list=list;
        this.total=total;

        this.pages =Double.valueOf(Math.ceil(total*1.0/pageSize)).intValue();
        this.prePage= this.pageNum==1?this.pages:pageNum-1;
        this.nextPage=this.pageNum==this.pages?1:this.pageNum+1;
    }
}

　　分页工具的使用

public PageUtils select3(QueryBean queryBean) {
        Integer total = userMapper.selectCount(queryBean);
        if(total==0){
            //可以减少一次查询，提高效率
            return new PageUtils(queryBean.getCurrentPage(),queryBean.getPageSize(),null,total);
        }
        List<User> list = userMapper.selectAll(queryBean);
        return new PageUtils(queryBean.getCurrentPage(),queryBean.getPageSize(),list,total);
}

　　可以看出实现类中代码少了很多

此时的前端页面

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<html>
<head>
    <title>Title</title>
    <script type="text/javascript">
        function goPage(page) {
            //设置当前页的值
            document.getElementById("currentPage").value = page;
            //提交表单
            var form = document.getElementById("f1");
            form.submit();   //提交表单
        }
    </script>
</head>
<body>
<div style="text-align: center;">
    <h1>用户列表</h1>

    <%--使用了对象进行参数接受的时候，在参数封装的同时会将对象加入到作用域中 --%>
    <form id="f1" action="/select3.do" method="post">

        用户姓名：<input type="text" name="username" value="${queryBean.username}"/>
        注册日期：<input type="text" name="date" value="${queryBean.date}"/>
        <input type="submit" value="查询"/>
        <input type="button" onclick="location.href='/edit.do'" value="增加" style="width: 40px;text-align: center"/>
        <table border="1px" width="60%" style="text-align: center;margin: 0 auto;">
            <tr>
                <th>编号</th>
                <th>姓名</th>
                <th>密码</th>
                <th>注册日期</th>
                <th>操作</th>
            </tr>
            <c:forEach items="${page.list}" var="user" varStatus="index">
                <tr>
                    <td>${index.count}</td>
                    <td>${user.username}</td>
                    <td>${user.pwd}</td>
                    <td>${user.date}</td>
                    <td><a href="/edit.do?id=${user.id}">修改</a>|<a href="/delete.do?id=${user.id}">删除</a></td>
                </tr>
            </c:forEach>

            <tr>
                <td colspan="5">
                    <a href="javascript:void(0);" onclick="goPage(1)">首页</a>
                    <a href="javascript:void(0);" onclick="goPage(${page.prePage})">上一页</a>
                    <a href="javascript:void(0);" onclick="goPage(${page.nextPage})">下一页</a>
                    <a href="javascript:void(0);" onclick="goPage(${page.pages})">尾页</a>
                    <input type="text" name="currentPage" id="currentPage"/>
                    <input type="submit" value="跳转"/>
                    每页显示：
                    <select name="pageSize" onchange="goPage(1)">
                        <option value="3" ${queryBean.pageSize==3?'selected':''}>3</option>
                        <option value="4" ${queryBean.pageSize==4?'selected':''}>4</option>
                        <option value="5" ${queryBean.pageSize==5?'selected':''}>5</option>
                    </select>
                    当前${page.pageNum}页/共${page.pages}页/共${page.total}条记录
                </td>
            </tr>
        </table>
    </form>
</div>
</body>
</html>