Mybatis中sql拦截增强-AOP+interceptor实现分页和排序

简介: 基于interceptor可以实现sql的完整打印,除了实现打印之外。其实还可以实现分页和排序,下面的分页和排序基于aop+mybatis的interceptor实现。其本质还是对mappedStament的boundSql进行增强。下面的项目来源于github,通过这个我们可以很好的学习mybatis中插件interceptor的使用。

mybatis的执行的大概过程:首先需要有sqlSessionFactroy,然后通过sqlSessionFactory拿到sqlSession,然后通过sqlSession调用getMapper拿到代理的接口,然后拿到代理的接口的信息mapperInterface,从而找到需要执行的具体的方法中的sql方法,,如果执行过,同时没有发生改变的话,则直接返回结果,否则会进行更新,同时如果执行过的话,会直接返回结果,此时会看到methodCache中有我们执行过的方法。

mybatis中,如果想进行sql的拦截,需要对其基于interceptor做拦截。因为mybatis的执行中,我们需要获取它的boundSql,而获取boundSql,需要获取MappedStatement,而MappedStatement可以在StatementHandler语句处理器中找到,因此可以在此基础上获取,通过反射的方式获取,此时可以用到插件模块中的invocation对象获取,然后对其进行增强。

基于interceptor可以实现sql的完整打印,除了实现打印之外。其实还可以实现分页和排序,下面的分页和排序基于aop+mybatis的interceptor实现。其本质还是对mappedStament的boundSql进行增强。

下面的项目来源于github,通过这个我们可以很好的学习mybatis中插件interceptor的使用。

首先定义分页元注解:

/*** 自定义分页注解*/@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documentedpublic@interfaceLimit {
/*** 当前页面* * @return*/intpage() default0;
/*** 每页显示数量* * @return*/intpageSize() default10;
}

定义排序元注解:

/*** 自定义排序注解*/@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documentedpublic@interfaceOrderBy {
/*** 表的别名*/StringtableAlias() default"";
/*** 排序字段*/StringorderColumn() default"";
/*** ASC/DESC 默认倒序* @return*/booleanisAsc() defaultfalse;
}

定义基础切面处理类:

/*** @ClassName BaseAspectAbstract* @Description 基础切面处理类,每一个Spring的切面都需要去继承此抽象类* @Date**/publicabstractclassBaseAspectAbstract {
privatestaticTreeMap<Integer, SQLLanguage>CONTAINERS=newTreeMap<>();
// 放入sql 切点、sql类型、sqlpublicvoidputSQL(JoinPointpoint, SQLEnumssqlEnums, SQLLanguagesqlLanguage) {
CONTAINERS.put(sqlEnums.getId(), sqlLanguage);
// 获取方法里的参数Objectparmas=point.getArgs()[0];
Mapmap= (Map)parmas;
map.put("SQL", getSQL());
    }
publicTreeMap<Integer, SQLLanguage>getSQL() {
returnCONTAINERS;
    }
}

进行分页切面:

@Component@Aspect@Order(3) //拼接sql时的顺序publicclassLimitAspectextendsBaseAspectAbstract {
@Pointcut("@annotation(com.mybatis.interceptor.annotation.Limit)")
publicvoidlimitCut() {}
@Before("limitCut()")
publicvoidlimit(JoinPointpoint) {
StringBuilderlimitBuilder=newStringBuilder(" LIMIT ");
MethodSignaturemethodSignature= (MethodSignature)point.getSignature();
// 获得对应注解Limitlimit=methodSignature.getMethod().getAnnotation(Limit.class);
if (!StringUtils.isEmpty(limit)) {
limitBuilder.append(limit.page()).append(",").append(limit.pageSize());
putSQL(point, LIMIT, newSQLLanguage(limitBuilder.toString()));
        }
    }
}

进行排序切面:

@Component@Aspect@Order(2)
publicclassOrderByAspectextendsBaseAspectAbstract {
// 切点:对注解中的特定注解进行拦截,进行增强@Pointcut("@annotation(com.mybatis.interceptor.annotation.OrderBy)")
publicvoidorderByCut() {}
// 执行切点操作,将其进行增强,放入排序@Before("orderByCut()")
publicvoidorderBy(JoinPointpoint) {
StringBuilderorderByBuilder=newStringBuilder(" ORDER BY ");
MethodSignaturemethodSignature= (MethodSignature)point.getSignature();
// 获得对应注解OrderByorderBy=methodSignature.getMethod().getAnnotation(OrderBy.class);
if (!StringUtils.isEmpty(orderBy)) {
Stringsort=orderBy.isAsc() ?" asc " : " desc";
orderByBuilder.append(orderBy.orderColumn()).append(sort);
putSQL(point, ORDERBY, newSQLLanguage(orderByBuilder.toString()));
        }
    }
}

枚举sql顺序:

/*** sql类型枚举*/publicenumSQLEnums {
/*** 数字越靠前 则拼接SQL语句越靠前执行,目前拼接顺序为* SELECT * FROM table GROUP BY ORDER BY xxx LIMIT 0, 10*/LIKE(1, "LIKE"), GROUPBY(2, "GROUP BY"), ORDERBY(3, "ORDER BY"), LIMIT(4, "LIMIT");
privateintid;
privateStringcondition;
SQLEnums(intid, Stringcondition) {
this.id=id;
this.condition=condition;
    }
publicintgetId() {
returnid;
    }
publicvoidsetId(intid) {
this.id=id;
    }
publicStringgetCondition() {
returncondition;
    }
publicvoidsetCondition(Stringcondition) {
this.condition=condition;
    }
}

执行sql增强的注解放置在serviceImpl里面:

@RequestMapping("/nba")
publicclassPlayController {
@AutowiredprivatePlayerServiceplayerService;
@RequestMapping("/player")
publicList<Player>getList(Map<String, Object>params) {
List<Player>players=playerService.getList(params);
returnplayers;
    }
}

执行sql增强:

@ServicepublicclassPlayerServiceImplimplementsPlayerService {
@AutowiredprivatePlayerMapperplayerMapper;
// 加入自定义注解,方便切点进行增强@OrderBy(orderColumn="height")
@Limit()
@OverridepublicList<Player>getList(Map<String, Object>params) {
returnplayerMapper.getList(params);
    }
}

执行到这里会执行动态代理,然后执行sql拦截。

执行sql拦截:

@Intercepts(@Signature(type=StatementHandler.class, method="prepare", args= {Connection.class, Integer.class}))
@ComponentpublicclassDataFilterInterceptorextendsAbstractSqlParserHandlerimplementsInterceptor {
// 拦截器@OverridepublicObjectintercept(Invocationinvocation) throwsThrowable {
StatementHandlerstatementHandler=PluginUtils.realTarget(invocation.getTarget());
MetaObjectmetaObject=SystemMetaObject.forObject(statementHandler);
// SQLLanguage 解析sqlParser(metaObject);
// 非查询操作MappedStatementmappedStatement= (MappedStatement)metaObject.getValue("delegate.mappedStatement");
if (!SqlCommandType.SELECT.equals(mappedStatement.getSqlCommandType())) {
returninvocation.proceed();
        }
// 取出原始SQL 取出参数BoundSqlboundSql= (BoundSql)metaObject.getValue("delegate.boundSql");
StringdataSql=boundSql.getSql();
ObjectparamObj=boundSql.getParameterObject();
Mapmap= (Map)paramObj;
StringsqlLanguage=getSQLLanguage(map);
Stringsql=dataSql+sqlLanguage;
// 重写sqlmetaObject.setValue("delegate.boundSql.sql", sql);
returninvocation.proceed();
    }
// 插件@OverridepublicObjectplugin(Objecttarget) {
if (targetinstanceofStatementHandler) {
returnPlugin.wrap(target, this);
        }
returntarget;
    }
@OverridepublicvoidsetProperties(Propertiesproperties) {
    }
// 获取sql语句privateStringgetSQLLanguage(Map<String, Object>map) {
TreeMap<Integer, SQLLanguage>sqlMap= (TreeMap)map.get("SQL");
StringBuildersqlBuilder=newStringBuilder();
for (Map.EntrytreeMap : sqlMap.entrySet()) {
SQLLanguagesql= (SQLLanguage)treeMap.getValue();
if (null!=sql) {
sqlBuilder.append(sql);
            }
        }
returnsqlBuilder.toString();
    }
}


目录
相关文章
|
7天前
|
SQL XML Java
mybatis实现动态sql
MyBatis的动态SQL功能为开发人员提供了强大的工具来应对复杂的查询需求。通过使用 `<if>`、`<choose>`、`<foreach>`等标签,可以根据不同的条件动态生成SQL语句,从而提高代码的灵活性和可维护性。本文详细介绍了动态SQL的基本用法和实际应用示例,希望对您在实际项目中使用MyBatis有所帮助。
28 11
|
1月前
|
SQL 缓存 Java
【详细实用のMyBatis教程】获取参数值和结果的各种情况、自定义映射、动态SQL、多级缓存、逆向工程、分页插件
本文详细介绍了MyBatis的各种常见用法MyBatis多级缓存、逆向工程、分页插件 包括获取参数值和结果的各种情况、自定义映射resultMap、动态SQL
【详细实用のMyBatis教程】获取参数值和结果的各种情况、自定义映射、动态SQL、多级缓存、逆向工程、分页插件
|
1月前
|
SQL 关系型数据库 MySQL
SQL中,可以使用 `ORDER BY` 子句来实现排序功能
【10月更文挑战第26天】SQL中,可以使用 `ORDER BY` 子句来实现排序功能
116 6
|
28天前
|
SQL Java 数据库连接
canal-starter 监听解析 storeValue 不一样,同样的sql 一个在mybatis执行 一个在数据库操作,导致解析不出正确对象
canal-starter 监听解析 storeValue 不一样,同样的sql 一个在mybatis执行 一个在数据库操作,导致解析不出正确对象
|
2月前
|
SQL Java 数据库连接
mybatis使用四:dao接口参数与mapper 接口中SQL的对应和对应方式的总结,MyBatis的parameterType传入参数类型
这篇文章是关于MyBatis中DAO接口参数与Mapper接口中SQL的对应关系,以及如何使用parameterType传入参数类型的详细总结。
54 10
|
3月前
|
SQL XML Java
mybatis复习03,动态SQL,if,choose,where,set,trim标签及foreach标签的用法
文章介绍了MyBatis中动态SQL的用法,包括if、choose、where、set和trim标签,以及foreach标签的详细使用。通过实际代码示例,展示了如何根据条件动态构建查询、更新和批量插入操作的SQL语句。
mybatis复习03,动态SQL,if,choose,where,set,trim标签及foreach标签的用法
|
3月前
|
SQL XML Java
mybatis :sqlmapconfig.xml配置 ++++Mapper XML 文件(sql/insert/delete/update/select)(增删改查)用法
当然,这些仅是MyBatis功能的初步介绍。MyBatis还提供了高级特性,如动态SQL、类型处理器、插件等,可以进一步提供对数据库交互的强大支持和灵活性。希望上述内容对您理解MyBatis的基本操作有所帮助。在实际使用中,您可能还需要根据具体的业务要求调整和优化SQL语句和配置。
69 1
|
4月前
|
SQL Java 数据库连接
Mybatis系列之 动态SQL
文章详细介绍了Mybatis中的动态SQL用法,包括`<if>`、`<choose>`、`<when>`、`<otherwise>`、`<trim>`和`<foreach>`等元素的应用,并通过实际代码示例展示了如何根据不同条件动态生成SQL语句。
|
4月前
|
SQL Java 关系型数据库
SpringBoot 系列之 MyBatis输出SQL日志
这篇文章介绍了如何在SpringBoot项目中通过MyBatis配置输出SQL日志,具体方法是在`application.yml`或`application.properties`中设置MyBatis的日志实现为`org.apache.ibatis.logging.stdout.StdOutImpl`来直接在控制台打印SQL日志。
SpringBoot 系列之 MyBatis输出SQL日志
|
2月前
|
Java 数据库连接 Maven
mybatis使用一:springboot整合mybatis、mybatis generator,使用逆向工程生成java代码。
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和MyBatis Generator,使用逆向工程来自动生成Java代码,包括实体类、Mapper文件和Example文件,以提高开发效率。
146 2
mybatis使用一:springboot整合mybatis、mybatis generator,使用逆向工程生成java代码。