Spring Mybatis 分页插件使用教程

2023-09-16 05:06:05 55

Mybatis分页切入点

Mybatis内部有个plugins(插件)概念，本质上属于拦截器的思想。具体的解析可见他文MyBatis拦截器原理探究。本文将在此基础上直接展示实际项目的实现代码和其他的相关解析

分页具体代码实现

首先我们可以定义方言抽象类，用于实现分页AbstractDialect.java

publicabstractclassAbstractDialect{
/**
*是否支持limit和偏移量
*@return
*/
publicabstractbooleansupportsLimitOffset();
/**
*是否支持limit
*@return
*/
publicabstractbooleansupportsLimit();
/**
*获取增加了分页属性之后的SQL
*@paramsql
*@paramoffset
*@paramlimit
*@return
*/
publicabstractStringgetLimitString(Stringsql,intoffset,intlimit);
}

再而我们就以Oracle与Mysql数据库的分页技术作下分别的实现

MySQLDialect.java-Mysql分页方言

publicclassMySQLDialectextendsAbstractDialect{
publicbooleansupportsLimitOffset(){
returntrue;
}
publicbooleansupportsLimit(){
returntrue;
}
publicStringgetLimitString(Stringsql,intoffset,intlimit){
if(offset>0){
returnsql+"limit"+offset+","+limit;
}else{
returnsql+"limit"+limit;
}
}
}

OracleDialect.java-Oracle方言实现

publicclassOracleDialectextendsADialect{
@Override
publicbooleansupportsLimitOffset(){
returnfalse;
}
@Override
publicbooleansupportsLimit(){
returnfalse;
}
@Override
publicStringgetLimitString(Stringsql,intstart,intlimit){
if(start<0){
start=0;
}
if(limit<0){
limit=10;
}
StringBuilderpageSql=newStringBuilder(100);
pageSql.append("select*from(selecttemp.*,rownumrow_idfrom(");
pageSql.append(sql);
pageSql.append(")tempwhererownum<=").append(start+limit);
pageSql.append(")whererow_id>").append(start);
returnpageSql.toString();
}
}

对应的Mybatis插件拦截器实现如下，拦截StatementHandler#prepare(Connectioncon)创建SQL语句对象方法

PaginationInterceptor.java

@Intercepts({@Signature(type=StatementHandler.class,method="prepare",args={Connection.class})})
publicfinalclassPaginationInterceptorimplementsInterceptor{
privatefinalstaticLoggerlog=LoggerFactory
.getLogger(PaginationInterceptor.class);
privateADialectdialect;
publicvoidsetDialect(ADialectdialect){
this.dialect=dialect;
}
@Override
publicObjectintercept(Invocationinvocation)throwsThrowable{
//直接获取拦截的对象，其实现类RoutingStatementHandler
StatementHandlerstatementHandler=(StatementHandler)invocation
.getTarget();
BoundSqlboundSql=statementHandler.getBoundSql();
//获取元对象，主要用于获取statementHandler所关联的对象及属性
MetaObjectmetaStatementHandler=MetaObject.forObject(
statementHandler,newDefaultObjectFactory(),
newDefaultObjectWrapperFactory());
MappedStatementmappedStmt=(MappedStatement)metaStatementHandler
.getValue("delegate.mappedStatement".intern());
//只对queryPagination()方法进行分页操作
if(mappedStmt.getId().indexOf("queryPagination")==-1){
returninvocation.proceed();
}
//重新构造分页的sql
StringoriginalSql=(String)metaStatementHandler
.getValue("delegate.boundSql.sql".intern());
metaStatementHandler.setValue("delegate.boundSql.sql".intern(),dialect
.getLimitString(originalSql,rowBounds.getOffset(),
rowBounds.getLimit()));
metaStatementHandler.setValue("delegate.rowBounds.offset".intern(),
RowBounds.NO_ROW_OFFSET);
metaStatementHandler.setValue("delegate.rowBounds.limit".intern(),
RowBounds.NO_ROW_LIMIT);
log.debug("pagesql:"+boundSql.getSql());
returninvocation.proceed();
}
//拦截对象
@Override
publicObjectplugin(Objecttarget){
returnPlugin.wrap(target,this);
}
@Override
publicvoidsetProperties(Propertiesproperties){
}
}

Spring对应的xml配置可如下，以oracle分页为例子

使用以上的代码以及配置即可完成对oracle数据库以及mysql数据库的分页操作。并且博主对其中的某个点作下解析

Mybatis#MetaObject-元数据对象解析

以上的代码博主之前在使用的时候，对其中的MetaObject这个类很费解，其直接通过getValue()方法便可以将所代理的对象的所关联的属性全都拿取到。我们可以跟随源码深入了解下

MetaObject#forObject()

代理对象均通过此静态方法进入

publicstaticMetaObjectforObject(Objectobject,ObjectFactoryobjectFactory,ObjectWrapperFactoryobjectWrapperFactory){
if(object==null){
returnSystemMetaObject.NULL_META_OBJECT;
}else{
returnnewMetaObject(object,objectFactory,objectWrapperFactory);
}
}

我们可以直接观察其中的构造函数，玄机就在此处

privateMetaObject(Objectobject,ObjectFactoryobjectFactory,ObjectWrapperFactoryobjectWrapperFactory){
this.originalObject=object;
this.objectFactory=objectFactory;
this.objectWrapperFactory=objectWrapperFactory;
//所有的属性获取均通过objectWrapper类来获取，此处主要对所代理的object对象类型进行判断
if(objectinstanceofObjectWrapper){
this.objectWrapper=(ObjectWrapper)object;
}elseif(objectWrapperFactory.hasWrapperFor(object)){
this.objectWrapper=objectWrapperFactory.getWrapperFor(this,object);
}elseif(objectinstanceofMap){
this.objectWrapper=newMapWrapper(this,(Map)object);
}elseif(objectinstanceofCollection){
this.objectWrapper=newCollectionWrapper(this,(Collection)object);
}else{
//我们常用的便是BeanWrapper
this.objectWrapper=newBeanWrapper(this,object);
}
}

为了理解的更为渗透，我们继续跟进，最后我们得知其会调用Reflector类的构造函数

privateReflector(Classclazz){
type=clazz;
//获取构造类
addDefaultConstructor(clazz);
//获取get方法集合
addGetMethods(clazz);
//获取set方法集合
addSetMethods(clazz);
//获取内部属性集合
addFields(clazz);
readablePropertyNames=getMethods.keySet().toArray(newString[getMethods.keySet().size()]);
writeablePropertyNames=setMethods.keySet().toArray(newString[setMethods.keySet().size()]);
for(StringpropName:readablePropertyNames){
caseInsensitivePropertyMap.put(propName.toUpperCase(Locale.ENGLISH),propName);
}
for(StringpropName:writeablePropertyNames){
caseInsensitivePropertyMap.put(propName.toUpperCase(Locale.ENGLISH),propName);
}
}

由此我们便可知使用Reflector代理类以及MetaObject便可以遍历代理被代理类的所关联的所有属性，就拿RoutingStatementHandler类来说，经过上述操作后其便可以访问内部属性delegate以及delegate的内部属性configuration/objectFactory/typeHandlerRegistry/resultSetHandler/parameterHandler/mappedStatement等属性

MetaObject#getValue()

上述阐述的是如何代理被代理类的内部属性，我们也简单的看下是如何正确的调用

publicObjectgetValue(Stringname){
//PropertyTokenizer与StringTokenizer类似，只是前者写死以.为分隔符
PropertyTokenizerprop=newPropertyTokenizer(name);
if(prop.hasNext()){
MetaObjectmetaValue=metaObjectForProperty(prop.getIndexedName());
if(metaValue==SystemMetaObject.NULL_META_OBJECT){
returnnull;
}else{
returnmetaValue.getValue(prop.getChildren());
}
}else{
returnobjectWrapper.get(prop);
}
}

具体的解析就不在此阐述了，如何用户想获取StatementHandler所拥有的sql字符串，可通过getValue("delegate.boundSql.sql")其中以.为分隔符并其中的属性必须是内部属性(区分大小写)。

MetaObject#setValue()

原理同MetaObject#getValue()方法

总结

以上所述是小编给大家介绍的SpringMybatis分页插件使用教程，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对毛票票网站的支持！

Spring Mybatis 分页插件使用教程

热门推荐

随机推荐