Mybatis自定义拦截器与插件开发
共 26935字,需浏览 54分钟
·
2021-06-17 20:50
在Spring中我们经常会使用到拦截器,在登录验证、日志记录、性能监控等场景中,通过使用拦截器允许我们在不改动业务代码的情况下,执行拦截器的方法来增强现有的逻辑。在mybatis中,同样也有这样的业务场景,有时候需要我们在不侵入原有业务代码的情况下拦截sql,执行特定的某些逻辑。那么这个过程应该怎么实现呢,同样,在mybatis中也为开发者预留了拦截器接口,通过实现自定义拦截器这一功能,可以实现我们自己的插件,允许用户在不改动mybatis的原有逻辑的条件下,实现自己的逻辑扩展。
本文将按下面的结构进行mybatis拦截器学习:
本文结构
1、拦截器核心对象
2、工作流程
3、拦截器能实现什么
4、插件定义与注册
5、拦截器使用示例
6、总结
拦截器核心对象
在实现拦截器之前,我们首先看一下拦截器的拦截目标对象是什么,以及拦截器的工作流程是怎样的。mybatis拦截器可以对下面4种对象进行拦截:
1、Executor
:mybatis的内部执行器,作为调度核心负责调用StatementHandler
操作数据库,并把结果集通过ResultSetHandler
进行自动映射
2、StatementHandler
: 封装了JDBC Statement
操作,是sql语法的构建器,负责和数据库进行交互执行sql语句
3、ParameterHandler
:作为处理sql参数设置的对象,主要实现读取参数和对PreparedStatement
的参数进行赋值
4、ResultSetHandler
:处理Statement
执行完成后返回结果集的接口对象,mybatis通过它把ResultSet
集合映射成实体对象
工作流程
在mybatis中提供了一个Interceptor
接口,通过实现该接口就能够自定义拦截器,接口中定义了3个方法:
public interface Interceptor {
Object intercept(Invocation invocation) throws Throwable;
default Object plugin(Object target) {
return Plugin.wrap(target, this);
}
default void setProperties(Properties properties) {
// NOP
}
}
intercept
:在拦截目标对象的方法时,实际执行的增强逻辑,我们一般在该方法中实现自定义逻辑plugin
:用于返回原生目标对象或它的代理对象,当返回的是代理对象的时候,会调用intercept
方法setProperties
:可以用于读取配置文件中通过property
标签配置的一些属性,设置一些属性变量
看一下plugin
方法中的wrap
方法源码:
public static Object wrap(Object target, Interceptor interceptor) {
Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
Class<?> type = target.getClass();
Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
if (interfaces.length > 0) {
return Proxy.newProxyInstance(
type.getClassLoader(),
interfaces,
new Plugin(target, interceptor, signatureMap));
}
return target;
}
可以看到,在wrap
方法中,通过使用jdk动态代理的方式,生成了目标对象的代理对象,在执行实际方法前,先执行代理对象中的逻辑,来实现的逻辑增强。以拦截Executor
的query
方法为例,在实际执行前会执行拦截器中的intercept
方法:
![](https://filescdn.proginn.com/8b0c7eca9a47866f60ecd0abec2ca56a/7621fe56835d57bb85bbafbc45eaf061.webp)
在mybatis中,不同类型的拦截器按照下面的顺序执行:
Executor -> StatementHandler -> ParameterHandler -> ResultSetHandler
以执行query
方法为例对流程进行梳理,整体流程如下:
1、Executor
执行query()
方法,创建一个StatementHandler
对象
2、StatementHandler
调用ParameterHandler
对象的setParameters()
方法
3、StatementHandler
调用 Statement
对象的execute()
方法
4、StatementHandler
调用ResultSetHandler
对象的handleResultSets()
方法,返回最终结果
拦截器能实现什么
在对mybatis拦截器有了初步的认识后,来看一下拦截器被普遍应用在哪些方面:
sql 语句执行监控
可以拦截执行的sql方法,可以打印执行的sql语句、参数等信息,并且还能够记录执行的总耗时,可供后期的sql分析时使用
sql 分页查询
mybatis中使用的
RowBounds
使用的内存分页,在分页前会查询所有符合条件的数据,在数据量大的情况下性能较差。通过拦截器,可以做到在查询前修改sql语句,提前加上需要的分页参数公共字段的赋值
在数据库中通常会有
createTime
,updateTime
等公共字段,这类字段可以通过拦截统一对参数进行的赋值,从而省去手工通过set
方法赋值的繁琐过程数据权限过滤
在很多系统中,不同的用户可能拥有不同的数据访问权限,例如在多租户的系统中,要做到租户间的数据隔离,每个租户只能访问到自己的数据,通过拦截器改写sql语句及参数,能够实现对数据的自动过滤
除此之外,拦截器通过对上述的4个阶段的介入,结合我们的实际业务场景,还能够实现很多其他功能。
插件定义与注册
在我们自定义的拦截器类实现了Interceptor
接口后,还需要在类上添加@Intercepts
注解,标识该类是一个拦截器类。注解中的内容是一个@Signature
对象的数组,指明自定义拦截器要拦截哪一个类型的哪一个具体方法。其中type
指明拦截对象的类型,method
是拦截的方法,args
是method
执行的参数。通过这里可以了解到 mybatis 拦截器的作用目标是在方法级别
上进行拦截,例如要拦截Executor
的query
方法,就在类上添加:
@Intercepts({
@Signature(type = Executor.class,method = "query", args = { MappedStatement.class, Object.class,
RowBounds.class, ResultHandler.class })
})
如果要拦截多个方法,可以继续以数组的形式往后追加。这里通过添加参数可以确定唯一的拦截方法,例如在Executor
中存在两个query
方法,通过上面的参数可以确定要拦截的是下面的第2个方法:
<E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey cacheKey, BoundSql boundSql);
<E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler);
当编写完成我们自己的插件后,需要向mybatis中注册插件,有两种方式可以使用,第一种直接在SqlSessionFactory
中配置:
@Bean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
sqlSessionFactoryBean.setDataSource(dataSource);
sqlSessionFactoryBean.setPlugins(new Interceptor[]{new ExecutorPlugin()});
return sqlSessionFactoryBean.getObject();
}
第2种是在mybatis-config.xml
中对自定义插件进行注册:
<configuration>
<plugins>
<plugin interceptor="com.cn.plugin.interceptor.MyPlugin">
<property name="text" value="hello"/>
</plugin>
<plugin interceptor="com.cn.plugin.interceptor.MyPlugin2"></plugin>
<plugin interceptor="com.cn.plugin.interceptor.MyPlugin3"></plugin>
</plugins>
</configuration>
在前面我们了解了不同类型拦截器执行的固定顺序,那么对于同样类型的多个自定义拦截器,它们的执行顺序是怎样的呢?分别在plugin
方法和intercept
中添加输出语句,运行结果如下:
![](https://filescdn.proginn.com/7d3c586b5c9ee4ca812d9275e437916c/30e24f54c3cde260587b1b079c2ddf3b.webp)
从结果可以看到,拦截顺序是按照注册顺序执行的,但代理逻辑的执行顺序正好相反,最后注册的会被最先执行。这是因为在mybatis中有一个类InterceptorChain
,在它的pluginAll()
方法中,会对原生对象target
进行代理,如果有多个拦截器的话,会对代理类再次进行代理,最终实现一层层的增强target
对象,因此靠后被注册的拦截器的增强逻辑会被优先执行。从下面的图中可以直观的看出代理的嵌套关系:
![](https://filescdn.proginn.com/34c24e32771a7b0525904652f371288f/409385f846d4e3ca8d57739fc8adf2f6.webp)
在xml
中注册完成后,在application.yml
中启用配置文件,这样插件就可以正常运行了:
mybatis:
config-location: classpath:mybatis-config.xml
在了解了插件的基础概念与运行流程之后,通过代码看一下应用不同的拦截器能够实现什么功能。
拦截器使用示例
Executor
通过拦截Executor
的query
和update
方法实现对sql的监控,在拦截方法中,打印sql语句、执行参数、实际执行时间:
@Intercepts({
@Signature(type = Executor.class,method = "update", args = {MappedStatement.class, Object.class}),
@Signature(type = Executor.class,method = "query", args = { MappedStatement.class, Object.class,
RowBounds.class, ResultHandler.class })})
public class ExecutorPlugin implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
System.out.println("Executor Plugin 拦截 :"+invocation.getMethod());
Object[] queryArgs = invocation.getArgs();
MappedStatement mappedStatement = (MappedStatement) queryArgs[0];
//获取 ParamMap
MapperMethod.ParamMap paramMap = (MapperMethod.ParamMap) queryArgs[1];
// 获取SQL
BoundSql boundSql = mappedStatement.getBoundSql(paramMap);
String sql = boundSql.getSql();
log.info("==> ORIGIN SQL: "+sql);
long startTime = System.currentTimeMillis();
Configuration configuration = mappedStatement.getConfiguration();
String sqlId = mappedStatement.getId();
Object proceed = invocation.proceed();
long endTime=System.currentTimeMillis();
long time = endTime - startTime;
printSqlLog(configuration,boundSql,sqlId,time);
return proceed;
}
public static void printSqlLog(Configuration configuration, BoundSql boundSql, String sqlId, long time){
Object parameterObject = boundSql.getParameterObject();
List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
String sql= boundSql.getSql().replaceAll("[\\s]+", " ");
StringBuffer sb=new StringBuffer("==> PARAM:");
if (parameterMappings.size()>0 && parameterObject!=null){
TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
sql = sql.replaceFirst("\\?", parameterObject.toString());
} else {
MetaObject metaObject = configuration.newMetaObject(parameterObject);
for (ParameterMapping parameterMapping : parameterMappings) {
String propertyName = parameterMapping.getProperty();
if (metaObject.hasGetter(propertyName)) {
Object obj = metaObject.getValue(propertyName);
String parameterValue = obj.toString();
sql = sql.replaceFirst("\\?", parameterValue);
sb.append(parameterValue).append("(").append(obj.getClass().getSimpleName()).append("),");
} else if (boundSql.hasAdditionalParameter(propertyName)) {
Object obj = boundSql.getAdditionalParameter(propertyName);
String parameterValue = obj.toString();
sql = sql.replaceFirst("\\?", parameterValue);
sb.append(parameterValue).append("(").append(obj.getClass().getSimpleName()).append("),");
}
}
}
sb.deleteCharAt(sb.length()-1);
}
log.info("==> SQL:"+sql);
log.info(sb.toString());
log.info("==> SQL TIME:"+time+" ms");
}
}
执行代码,日志输出如下:
![](https://filescdn.proginn.com/d1c17cea19e08023d57cd2b183d55828/8b52a91c281da23c0b8f628b67073577.webp)
在上面的代码中,通过Executor
拦截器获取到了BoundSql
对象,进一步获取到sql的执行参数,从而实现了对sql执行的监控与统计。
StatementHandler
下面的例子中,通过改变StatementHandler
对象的属性,动态修改sql语句的分页:
@Intercepts({
@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})})
public class StatementPlugin implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
MetaObject metaObject = SystemMetaObject.forObject(statementHandler);
metaObject.setValue("delegate.rowBounds.offset", 0);
metaObject.setValue("delegate.rowBounds.limit", 2);
return invocation.proceed();
}
}
MetaObject
是mybatis提供的一个用于方便、优雅访问对象属性的对象,通过将实例对象作为参数传递给它,就可以通过属性名称获取对应的属性值。虽然说我们也可以通过反射拿到属性的值,但是反射过程中需要对各种异常做出处理,会使代码中堆满难看的try/catch
,通过MetaObject
可以在很大程度上简化我们的代码,并且它支持对Bean
、Collection
、Map
三种类型对象的操作。
对比执行前后:
![](https://filescdn.proginn.com/3dcbeff93f4a20dd71fe5a1656519eb6/7aba22fd9313a152b5267540632947e7.webp)
可以看到这里通过改变了分页对象RowBounds
的属性,动态的修改了分页参数。
ResultSetHandler
ResultSetHandler
会负责映射sql语句查询得到的结果集,如果在生产环境中存在一些保密数据,不想在外部系统中展示,那么可能就需要在查询到结果后做一下数据的脱敏处理,这时候就可以使用ResultSetHandler
对结果集进行改写。
@Intercepts({
@Signature(type= ResultSetHandler.class,method = "handleResultSets",args = {Statement.class})})
public class ResultSetPlugin implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
System.out.println("Result Plugin 拦截 :"+invocation.getMethod());
Object result = invocation.proceed();
if (result instanceof Collection) {
Collection<Object> objList= (Collection) result;
List<Object> resultList=new ArrayList<>();
for (Object obj : objList) {
resultList.add(desensitize(obj));
}
return resultList;
}else {
return desensitize(result);
}
}
//脱敏方法,将加密字段变为星号
private Object desensitize(Object object) throws InvocationTargetException, IllegalAccessException {
Field[] fields = object.getClass().getDeclaredFields();
for (Field field : fields) {
Confidential confidential = field.getAnnotation(Confidential.class);
if (confidential==null){
continue;
}
PropertyDescriptor ps = BeanUtils.getPropertyDescriptor(object.getClass(), field.getName());
if (ps.getReadMethod() == null || ps.getWriteMethod() == null) {
continue;
}
Object value = ps.getReadMethod().invoke(object);
if (value != null) {
ps.getWriteMethod().invoke(object, "***");
}
}
return object;
}
}
运行上面的代码,查看执行结果:
{"id":1358041517788299266,"orderNumber":"***","money":122.0,"status":3,"tenantId":2}
在上面的例子中,在执行完sql语句得到结果对象后,通过反射扫描结果对象中的属性,如果实体的属性上带有自定义的@Confidential
注解,那么在脱敏方法中将它转化为星号再返回结果,从而实现了数据的脱敏处理。
ParameterHandler
mybatis可以拦截ParameterHandler
注入参数,下面的例子中我们将结合前面介绍的其他种类的对象,通过组合拦截器的方式,实现一个简单的多租户拦截器插件,实现多租户下的查询逻辑。
@Intercepts({
@Signature(type = Executor.class,method = "query", args = { MappedStatement.class, Object.class,RowBounds.class, ResultHandler.class }),
@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class}),
@Signature(type = ParameterHandler.class, method = "setParameters", args = PreparedStatement.class),
})
public class TenantPlugin implements Interceptor {
private static final String TENANT_ID = "tenantId";
@Override
public Object intercept(Invocation invocation) throws Throwable {
Object target = invocation.getTarget();
String methodName = invocation.getMethod().getName();
if (target instanceof Executor && methodName.equals("query") && invocation.getArgs().length==4) {
return doQuery(invocation);
}
if (target instanceof StatementHandler){
return changeBoundSql(invocation);
}
if (target instanceof ParameterHandler){
return doSetParameter(invocation);
}
return null;
}
private Object doQuery(Invocation invocation) throws Exception{
Executor executor = (Executor) invocation.getTarget();
MappedStatement ms= (MappedStatement) invocation.getArgs()[0];
Object paramObj = invocation.getArgs()[1];
RowBounds rowBounds = (RowBounds) invocation.getArgs()[2];
if (paramObj instanceof Map){
MapperMethod.ParamMap paramMap= (MapperMethod.ParamMap) paramObj;
if (!paramMap.containsKey(TENANT_ID)){
Long tenantId=1L;
paramMap.put("param"+(paramMap.size()/2+1),tenantId);
paramMap.put(TENANT_ID,tenantId);
paramObj=paramMap;
}
}
//直接执行query,不用proceed()方法
return executor.query(ms, paramObj,rowBounds,null);
}
private Object changeBoundSql(Invocation invocation) throws Exception {
StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
MetaObject metaObject = SystemMetaObject.forObject(statementHandler);
PreparedStatementHandler preparedStatementHandler = (PreparedStatementHandler) metaObject.getValue("delegate");
String originalSql = (String) metaObject.getValue("delegate.boundSql.sql");
metaObject.setValue("delegate.boundSql.sql",originalSql+ " and tenant_id=?");
return invocation.proceed();
}
private Object doSetParameter(Invocation invocation) throws Exception {
ParameterHandler parameterHandler = (ParameterHandler) invocation.getTarget();
PreparedStatement ps = (PreparedStatement) invocation.getArgs()[0];
MetaObject metaObject = SystemMetaObject.forObject(parameterHandler);
BoundSql boundSql= (BoundSql) metaObject.getValue("boundSql");
List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
boolean hasTenantId=false;
for (ParameterMapping parameterMapping : parameterMappings) {
if (parameterMapping.getProperty().equals(TENANT_ID)) {
hasTenantId=true;
}
}
//添加参数
if (!hasTenantId){
Configuration conf= (Configuration) metaObject.getValue("configuration");
ParameterMapping parameterMapping= new ParameterMapping.Builder(conf,TENANT_ID,Long.class).build();
parameterMappings.add(parameterMapping);
}
parameterHandler.setParameters(ps);
return null;
}
}
在上面的过程中,拦截了sql执行的三个阶段,来实现多租户的逻辑,逻辑分工如下:
拦截 Executor
的query
方法,在查询的参数Map
中添加租户的属性值,这里只是简单的对Map
的情况作了判断,没有对Bean
的情况进行设置拦截 StatementHandler
的prepare
方法,改写sql语句对象BoundSql
,在sql语句中拼接租户字段的查询条件拦截 ParameterHandler
的setParameters
方法,动态设置参数,将租户id添加到要设置到参数列表中
最终通过拦截不同执行阶段的组合,实现了基于租户的条件拦截。
总结
总的来说,mybatis拦截器通过对Executor
、StatementHandler
、ParameterHandler
、ResultSetHandler
这4种接口中的方法进行拦截,并生成代理对象,在执行方法前先执行代理对象的逻辑,来实现我们自定义的逻辑增强。从上面的例子中,可以看到通过灵活使用mybatis拦截器开发插件能够帮助我们解决很多问题,但是同样它也是一把双刃剑,在实际工作中也不要滥用插件、定义过多的拦截器,因为通过学习我们知道mybatis插件在执行中使用到了代理模式和责任链模式,在执行sql语句前会经过层层代理,如果代理次数过多将会消耗额外的性能,并增加响应时间。
PS:如果觉得我的分享不错,欢迎大家随手点赞、转发。
—————END————— 推荐阅读: 再见!收费的 XShell,我改用这款国产良心工具! 一个帮你轻松搞定第三方登陆的 Java 开源组件 拒绝 ! = null ,大神有更好的方法! 一个低级错误,生产数据库崩溃了将近半个小时..... 重磅推荐:一套开源的网校系统,附源码! IDEA 2021.1 的 Win 和 Mac 快捷键大全! 最近面试BAT,整理一份面试资料《Java面试BAT通关手册》,覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。 获取方式:关注公众号并回复 java 领取,更多内容陆续奉上。 明天见(。・ω・。)ノ♡