MyBatis拦截器实现分页功能的实现方法
MyBatis拦截器实现分页功能的实现方法
前言：
首先说下实现原理。使用拦截器拦截原始的sql，然后加上分页查询的关键字和属性，拼装成新的sql语句再交给mybatis去执行。
除了业务代码之外，需要写的东西不多，提几个关键的：
1、分页对象Page类。给该对象设置一个当前页数（前端给）、总记录数（拦截器内赋值）2个参数，他就能帮你计算出分页sql语句用的2个参数。
/**
*分页对应的实体类
*/
publicclassPage{
/**
*总条数
*/
privateinttotalNumber;
/**
*当前第几页
*/
privateintcurrentPage;
/**
*总页数
*/
privateinttotalPage;
/**
*每页显示条数
*/
privateintpageNumber=5;
/**
*数据库中limit的参数，从第几条开始取
*/
privateintdbIndex;
/**
*数据库中limit的参数，一共取多少条
*/
privateintdbNumber;
/**
*根据当前对象中属性值计算并设置相关属性值
*/
publicvoidcount(){
//计算总页数
inttotalPageTemp=this.totalNumber/this.pageNumber;
intplus=(this.totalNumber%this.pageNumber)==0?0:1;
totalPageTemp=totalPageTemp+plus;
if(totalPageTemp<=0){
totalPageTemp=1;
}
this.totalPage=totalPageTemp;
//设置当前页数
//总页数小于当前页数，应将当前页数设置为总页数
if(this.totalPage
2、关键的拦截器实现
packagecom.imooc.interceptor;
importjava.sql.Connection;
importjava.sql.PreparedStatement;
importjava.sql.ResultSet;
importjava.util.Map;
importjava.util.Properties;
importorg.apache.ibatis.executor.parameter.ParameterHandler;
importorg.apache.ibatis.executor.statement.StatementHandler;
importorg.apache.ibatis.mapping.BoundSql;
importorg.apache.ibatis.mapping.MappedStatement;
importorg.apache.ibatis.plugin.Interceptor;
importorg.apache.ibatis.plugin.Intercepts;
importorg.apache.ibatis.plugin.Invocation;
importorg.apache.ibatis.plugin.Plugin;
importorg.apache.ibatis.plugin.Signature;
importorg.apache.ibatis.reflection.DefaultReflectorFactory;
importorg.apache.ibatis.reflection.MetaObject;
importorg.apache.ibatis.reflection.SystemMetaObject;
importcom.imooc.entity.Page;
/**
*分页拦截器
*
*@authorSkye
*
*/
@Intercepts({
@Signature(type=StatementHandler.class,method="prepare",args={Connection.class,Integer.class})})
publicclassPageInterceptorimplementsInterceptor{
publicObjectintercept(Invocationinvocation)throwsThrowable{
StatementHandlerstatementHandler=(StatementHandler)invocation.getTarget();
MetaObjectmetaObject=MetaObject.forObject(statementHandler,SystemMetaObject.DEFAULT_OBJECT_FACTORY,
SystemMetaObject.DEFAULT_OBJECT_WRAPPER_FACTORY,newDefaultReflectorFactory());
MappedStatementmappedStatement=(MappedStatement)metaObject.getValue("delegate.mappedStatement");
//通过MetaObject元数据取得方法名id：com.XXX.queryMessageListByPage
Stringid=mappedStatement.getId();
//匹配在mybatis中定义的与分页有关的查询id
if(id.matches(".+ByPage$")){
//BoundSql中有原始的sql语句和对应的查询参数
BoundSqlboundSql=statementHandler.getBoundSql();
Mapparams=(Map)boundSql.getParameterObject();
Pagepage=(Page)params.get("page");
Stringsql=boundSql.getSql();
StringcountSql="selectcount(*)from("+sql+")a";
Connectionconnection=(Connection)invocation.getArgs()[0];
PreparedStatementcountStatement=connection.prepareStatement(countSql);
ParameterHandlerparameterHandler=(ParameterHandler)metaObject.getValue("delegate.parameterHandler");
parameterHandler.setParameters(countStatement);
ResultSetrs=countStatement.executeQuery();
if(rs.next()){
//为什么是getInt（1）?因为数据表的列是从1开始计数
page.setTotalNumber(rs.getInt(1));
System.out.println("拦截器得知page的记录总数为："+page.getTotalNumber());
}
StringpageSql=sql+"limit"+page.getDbIndex()+","+page.getDbNumber();
metaObject.setValue("delegate.boundSql.sql",pageSql);
}
returninvocation.proceed();
}
/**
*@paramtarget
*被拦截的对象
*/
publicObjectplugin(Objecttarget){
//如果将拦截器类比喻为代购票的公司，那this就是代购业务员（进入方法前是无代理购票能力业务员，进入后成为有代理能力的业务员）
//通过注解获取拦截目标的信息，如果不符合拦截要求就返回原目标，如果符合则使用动态代理生成代理对象
returnPlugin.wrap(target,this);
}
publicvoidsetProperties(Propertiesproperties){
//TODOAuto-generatedmethodstub
}
}
3、mybatis-config.xml里面注册自己写的拦截器
Dao层相关的mapper.xml里面的sql语句不用做改动。
4、前端需要给后端一个显示哪一页的参数，通过service层组装查询参数之后交给MyBatis去查分页数据，我定义的分页DAO接口返回的数据是一个list，包含了分页查询结果。前端可以用jquery_pagination插件去实现分页的展示，具体去官方github看怎么设置吧。
<%
//获取请求的上下文
Stringcontext=request.getContextPath();
%>
//点击分页按钮以后触发的动作
functionhandlePaginationClick(new_page_index,pagination_container){
$("#stuForm").attr("action","你定义的分页查询url/"+(new_page_index+1));
$("#stuForm").submit();
returnfalse;
}
$(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//防止页面一直刷新(这条非常重要！)
});
});
写这篇总结的目的是希望形成一个分页功能的整体解决方案（前端+后端都涵盖到）。4月17、18日开始我会写一个小系统将前段时间所学都用上，完了之后会回来更新这篇文章里面不正确的地方。
如有疑问请留言或者到本站社区交流讨论，感谢阅读，希望能帮助到大家，谢谢大家对本站的支持!