MyBatis拦截器实现分页功能的实现方法

mybatis拦截器实现分页功能的实现方法

前言：

首先说下实现原理。使用拦截器拦截原始的sql，然后加上分页查询的关键字和属性，拼装成新的sql语句再交给mybatis去执行。

除了业务代码之外，需要写的东西不多，提几个关键的：

1、分页对象page类。给该对象设置一个当前页数（前端给）、总记录数（拦截器内赋值）2个参数，他就能帮你计算出分页sql语句用的2个参数。

/**
 * 分页对应的实体类
 */
public class page {
  /**
   * 总条数
   */
  private int totalnumber;
  /**
   * 当前第几页
   */
  private int currentpage;
  /**
   * 总页数
   */
  private int totalpage;
  /**
   * 每页显示条数
   */
  private int pagenumber = 5;
  /**
   * 数据库中limit的参数，从第几条开始取
   */
  private int dbindex;
  /**
   * 数据库中limit的参数，一共取多少条
   */
  private int dbnumber;

  /**
   * 根据当前对象中属性值计算并设置相关属性值
   */
  public void count() {
    // 计算总页数
    int totalpagetemp = this.totalnumber / this.pagenumber;
    int plus = (this.totalnumber % this.pagenumber) == 0 ? 0 : 1;
    totalpagetemp = totalpagetemp + plus;
    if(totalpagetemp <= 0) {
      totalpagetemp = 1;
    }
    this.totalpage = totalpagetemp;

    // 设置当前页数
    // 总页数小于当前页数，应将当前页数设置为总页数
    if(this.totalpage < this.currentpage) {
      this.currentpage = this.totalpage;
    }
    // 当前页数小于1设置为1
    if(this.currentpage < 1) {
      this.currentpage = 1;
    }

    // 设置limit的参数
    this.dbindex = (this.currentpage - 1) * this.pagenumber;
    this.dbnumber = this.pagenumber;
  }

  public int gettotalnumber() {
    return totalnumber;
  }

  public void settotalnumber(int totalnumber) {
    this.totalnumber = totalnumber;
    this.count();
  }

  public int getcurrentpage() {
    return currentpage;
  }

  public void setcurrentpage(int currentpage) {
    this.currentpage = currentpage;
  }

  public int gettotalpage() {
    return totalpage;
  }

  public void settotalpage(int totalpage) {
    this.totalpage = totalpage;
  }

  public int getpagenumber() {
    return pagenumber;
  }

  public void setpagenumber(int pagenumber) {
    this.pagenumber = pagenumber;
    this.count();
  }

  public int getdbindex() {
    return dbindex;
  }

  public void setdbindex(int dbindex) {
    this.dbindex = dbindex;
  }

  public int getdbnumber() {
    return dbnumber;
  }

  public void setdbnumber(int dbnumber) {
    this.dbnumber = dbnumber;
  }
}

2、关键的拦截器实现

package com.imooc.interceptor;

import java.sql.connection;
import java.sql.preparedstatement;
import java.sql.resultset;
import java.util.map;
import java.util.properties;

import org.apache.ibatis.executor.parameter.parameterhandler;
import org.apache.ibatis.executor.statement.statementhandler;
import org.apache.ibatis.mapping.boundsql;
import org.apache.ibatis.mapping.mappedstatement;
import org.apache.ibatis.plugin.interceptor;
import org.apache.ibatis.plugin.intercepts;
import org.apache.ibatis.plugin.invocation;
import org.apache.ibatis.plugin.plugin;
import org.apache.ibatis.plugin.signature;
import org.apache.ibatis.reflection.defaultreflectorfactory;
import org.apache.ibatis.reflection.metaobject;
import org.apache.ibatis.reflection.systemmetaobject;

import com.imooc.entity.page;

/**
 * 分页拦截器
 * 
 * @author skye
 *
 */
@intercepts({
    @signature(type = statementhandler.class, method = "prepare", args = { connection.class, integer.class }) })
public class pageinterceptor implements interceptor {

  public object intercept(invocation invocation) throws throwable {
    statementhandler statementhandler = (statementhandler) invocation.gettarget();
    metaobject metaobject = metaobject.forobject(statementhandler, systemmetaobject.default_object_factory,
        systemmetaobject.default_object_wrapper_factory, new defaultreflectorfactory());
    mappedstatement mappedstatement = (mappedstatement) metaobject.getvalue("delegate.mappedstatement");
    //通过metaobject元数据取得方法名id：com.xxx.querymessagelistbypage
    string id = mappedstatement.getid();
    //匹配在mybatis中定义的与分页有关的查询id
    if (id.matches(".+bypage$")) {
      //boundsql中有原始的sql语句和对应的查询参数
      boundsql boundsql = statementhandler.getboundsql();
      map<string, object> params = (map<string, object>) boundsql.getparameterobject();
      page page = (page) params.get("page");
      string sql = boundsql.getsql();
      string countsql = "select count(*)from (" + sql + ")a";
      connection connection = (connection) invocation.getargs()[0];
      preparedstatement countstatement = connection.preparestatement(countsql);
      parameterhandler parameterhandler = (parameterhandler) metaobject.getvalue("delegate.parameterhandler");
      parameterhandler.setparameters(countstatement);
      resultset rs = countstatement.executequery();
      if (rs.next()) {
        //为什么是getint（1）? 因为数据表的列是从1开始计数
        page.settotalnumber(rs.getint(1));
        system.out.println("拦截器得知page的记录总数为：" + page.gettotalnumber());
      }
      string pagesql = sql + " limit " + page.getdbindex() + "," + page.getdbnumber();
      metaobject.setvalue("delegate.boundsql.sql", pagesql);
    }
    return invocation.proceed();
  }

  /**
   * @param target
   * 被拦截的对象
   */
  public object plugin(object target) {
    // 如果将拦截器类比喻为代购票的公司，那this就是代购业务员（进入方法前是无代理购票能力业务员，进入后成为有代理能力的业务员）
    // 通过注解获取拦截目标的信息，如果不符合拦截要求就返回原目标，如果符合则使用动态代理生成代理对象
    return plugin.wrap(target, this);
  }

  public void setproperties(properties properties) {
    // todo auto-generated method stub

  }

}

3、mybatis-config.xml里面注册自己写的拦截器

 <!-- 自定义的分页拦截器 -->
  <plugins>
    <plugin interceptor="你写的拦截器全类名">
    </plugin>
  </plugins>

dao层相关的mapper.xml里面的sql语句不用做改动。

4、前端需要给后端一个显示哪一页的参数，通过service层组装查询参数之后交给mybatis去查分页数据，我定义的分页dao接口返回的数据是一个list，包含了分页查询结果。前端可以用jquery_pagination插件去实现分页的展示，具体去官方github看怎么设置吧。

<!--pagination需要的脚本-->
<%
  // 获取请求的上下文
  string context = request.getcontextpath();
%>
<link href="../css/pagination.css" rel="external nofollow" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../js/jquery-1.11.3.js"></script>
<script type="text/javascript" src="../js/jquery.pagination.js"></script>
<script type="text/javascript">

// 点击分页按钮以后触发的动作
function handlepaginationclick(new_page_index, pagination_container) {
<!--从stuform表单提交当前页的参数.可以使用restful方式，让springmvc使用@pathvariable关键字定义的形参去接。这2个参数是分页控件自己提供的，不需要我们去自己找，但是计数从0开始，而我们后台分页计数从1开始，因此要手动加1。 -->
  $("#stuform").attr("action", "你定义的分页查询url/"+(new_page_index+1));
  $("#stuform").submit();
  return false;
}

$(function(){
  $("#news-pagination").pagination(${result.totalrecord}, {
    items_per_page:${result.pagesize}, // 每页显示多少条记录
    current_page:${result.currentpage} - 1, // 当前显示第几页数据
    num_display_entries:8, // 分页显示的条目数
    next_text:"下一页",
    prev_text:"上一页",
    num_edge_entries:2, // 连接分页主体，显示的条目数
    callback:handlepaginationclick(当前页，分页div的id), //执行的回调函数
    load_first_page:false //防止页面一直刷新( 这条非常重要！)
  });
});
</script>
<!-- 这部分用c:foreach标签打印查询结果的表格-->
<!--分页控件名称-->
<div id="news-pagination"></div>

写这篇总结的目的是希望形成一个分页功能的整体解决方案（前端+后端都涵盖到）。4月17、18日开始我会写一个小系统将前段时间所学都用上，完了之后会回来更新这篇文章里面不正确的地方。

如有疑问请留言或者到本站社区交流讨论，感谢阅读，希望能帮助到大家，谢谢大家对本站的支持!