Springboot的Mybatis拦截器实现

MyBatis提供了一种插件(plugin)的功能，虽然叫做插件，其实就是拦截器功能

MyBatis 允许拦截的接口

MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)

ParameterHandler (getParameterObject, setParameters)

ResultSetHandler (handleResultSets, handleOutputParameters)

StatementHandler (prepare, parameterize, batch, update, query)

Executor接口的部分方法，比如update，query，commit，rollback等方法，还有其他接口的一些方法等。

总体概括为：

拦截执行器的方法
拦截参数的处理
拦截结果集的处理,为sql执行之后的结果拦截过滤
拦截Sql语法构建的处理,为sql执行之前的拦截进行sql封装

MyBatis拦截器的接口定义

一共有三个方法intercept 、plugin 、setProperties

`setProperties()`

方法主要是用来从配置中获取属性。

如果是使用xml式配置拦截器，可在Mybatis配置文件中添加如下节点，属性可以以如下方式传递

<plugins><plugin interceptor="tk.mybatis.simple.plugin.XXXInterceptor"><property name="propl" value="valuel" /><property name="prop2" value="value2" /></plugin>
</plugins>

如果在Spring boot中使用，则需要单独写一个配置类，如下：

@Configuration
public class MybatisInterceptorConfig {@Beanpublic String myInterceptor(SqlSessionFactory sqlSessionFactory) {ExecutorInterceptor executorInterceptor = new ExecutorInterceptor();Properties properties = new Properties();properties.setProperty("prop1","value1");executorInterceptor.setProperties(properties);return "interceptor";}
}

如果说不需要配置属性，则在spring boot中，不需要去编写配置类，只需要像我一样在拦截器上加个@Component即可。

`plugin()`

方法用于指定哪些方法可以被此拦截器拦截。

`intercept()`

方法是用来对拦截的sql进行具体的操作。

注解实现

MyBatis拦截器用到了两个注解：@Intercepts和@Signature

@Intercepts({@Signature(type = Executor.class, method = "query",args = {MappedStatement.class, Object.class,RowBounds.class, ResultHandler.class}),@Signature(type = Executor.class, method = "query",args = {MappedStatement.class, Object.class, RowBounds.class,ResultHandler.class, CacheKey.class, BoundSql.class}),}
)

type的值与类名相同，method与方法名相同，为了避免方法重载，args中指定了各个参数的类型和个数，可通过invocation.getArgs()获取参数数组。

Executor 拦截器实现

@Intercepts({@Signature(type= Executor.class,method = "query",args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})
})
@Slf4j
@Component
public class ExecutorInterceptor implements Interceptor {@Overridepublic Object intercept(Invocation invocation) throws Throwable {String sql = ExecutorPluginUtils.getSqlByInvocation(invocation);//可以对sql重写log.error("拦截器ExecutorInterceptor:"+sql);//sql = "SELECT id from BUS_RECEIVER where id = ? ";ExecutorPluginUtils.resetSql2Invocation( invocation,  sql);return invocation.proceed();}@Overridepublic Object plugin(Object o) {return Plugin.wrap(o, this);}@Overridepublic void setProperties(Properties properties) {}}

ParameterHandler 拦截器实现

/*** @Author: ynz* @Date: 2018/12/23/023 12:07*/
@Intercepts({@Signature(type = ParameterHandler.class, method = "setParameters", args = PreparedStatement.class),
})
@Component
@Slf4j
public class ParamInterceptor  implements Interceptor {@Overridepublic Object intercept(Invocation invocation) throws Throwable {log.error("拦截器ParamInterceptor");//拦截 ParameterHandler 的 setParameters 方法 动态设置参数if (invocation.getTarget() instanceof ParameterHandler) {ParameterHandler parameterHandler = (ParameterHandler) invocation.getTarget();PreparedStatement ps = (PreparedStatement) invocation.getArgs()[0];// 反射获取 BoundSql 对象，此对象包含生成的sql和sql的参数map映射Field boundSqlField = parameterHandler.getClass().getDeclaredField("boundSql");boundSqlField.setAccessible(true);BoundSql boundSql = (BoundSql) boundSqlField.get(parameterHandler);// 反射获取 参数对像Field parameterField = parameterHandler.getClass().getDeclaredField("parameterObject");parameterField.setAccessible(true);Object parameterObject = parameterField.get(parameterHandler);if (parameterObject instanceof Map) {//将参数中的name值改为2((Map) parameterObject).put("name","2");}// 改写的参数设置到原parameterHandler对象parameterField.set(parameterHandler, parameterObject);parameterHandler.setParameters(ps);log.error(JSON.toJSONString(boundSql.getParameterMappings()));log.error(JSON.toJSONString(parameterObject));}return invocation.proceed();}@Overridepublic Object plugin(Object o) {return Plugin.wrap(o, this);}@Overridepublic void setProperties(Properties properties) {}
}

ResultSetHandler 拦截器实现

@Intercepts({@Signature(type = ResultSetHandler.class, method = "handleResultSets", args={Statement.class})
})
@Component
@Slf4j
public class ResultInterceptor implements Interceptor {@Overridepublic Object intercept(Invocation invocation) throws Throwable {log.error("拦截器ResultInterceptor");// ResultSetHandler resultSetHandler1 = (ResultSetHandler) invocation.getTarget();//通过java反射获得mappedStatement属性值//可以获得mybatis里的resultypeObject result = invocation.proceed();if (result instanceof ArrayList) {ArrayList resultList = (ArrayList) result;for (int i = 0; i < resultList.size(); i++) {Object oi = resultList.get(i);Class c = oi.getClass();Class[] types = {String.class};Method method = c.getMethod("setAddress", types);// 调用obj对象的 method 方法method.invoke(oi, "china");}}return result;}@Overridepublic Object plugin(Object target) {return Plugin.wrap(target, this);}@Overridepublic void setProperties(Properties properties) {}
}

StatementHandler 拦截器实现

/*** @Author: ynz* @Date: 2018/12/23/023 14:22*/
@Intercepts({@Signature(type = StatementHandler.class,method = "prepare",args = {Connection.class, Integer.class})})
@Component
@Slf4j
public class StatementInterceptor implements Interceptor {@Overridepublic Object intercept(Invocation invocation) throws Throwable {StatementHandler statementHandler = (StatementHandler) PluginUtils.realTarget(invocation.getTarget());MetaObject metaStatementHandler = SystemMetaObject.forObject(statementHandler);MappedStatement mappedStatement = (MappedStatement) metaStatementHandler.getValue("delegate.mappedStatement");//只拦截select方法if (!SqlCommandType.SELECT.equals(mappedStatement.getSqlCommandType())) {return invocation.proceed();}BoundSql boundSql = (BoundSql) metaStatementHandler.getValue("delegate.boundSql");//获取到sqlString originalSql = boundSql.getSql();//可以对originalSql进行改写log.error("拦截器StatementInterceptor:"+originalSql);metaStatementHandler.setValue("delegate.boundSql.sql", originalSql);Object parameterObject = boundSql.getParameterObject();return invocation.proceed();}@Overridepublic Object plugin(Object target) {return Plugin.wrap(target, this);}@Overridepublic void setProperties(Properties properties) {}
}

Spring Boot整合

方法1：手写一个配置类

@Configuration
public class MybatisInterceptorConfig {@Beanpublic String myInterceptor(SqlSessionFactory sqlSessionFactory) {ExecutorInterceptor executorInterceptor = new ExecutorInterceptor();Properties properties = new Properties();properties.setProperty("prop1","value1");executorInterceptor.setProperties(properties);sqlSessionFactory.getConfiguration().addInterceptor(executorInterceptor);sqlSessionFactory.getConfiguration().addInterceptor(new ParamInterceptor());sqlSessionFactory.getConfiguration().addInterceptor(new ResultInterceptor());return "interceptor";}
}

方法2：在拦截器上加`@Component`注解

Springboot的Mybatis拦截器实现相关推荐

Springboot 自定义mybatis 拦截器，实现我们要的扩展
前言相信大家对拦截器并不陌生,对mybatis也不陌生. 有用过pagehelper的,那么对mybatis拦截器也不陌生了,按照使用的规则触发sql拦截,帮我们自动添加分页参数 . 那么今天,我们 ...
SpringBoot集成mybatis拦截器的实现
①创建SpringBoot工程项目目录: ②导入jar包  <dependency><groupId>or ...
面试官：你能说说MyBatis拦截器原理吗？
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试资料作者:Format cnblogs.com/fangjian042 ...
mybatis拦截器添加额外参数
上一篇中讲了mybatis拦截器的实现这一篇扩展mybatis在拦截器中添加额外参数在mybatis的mapper.xml文件中,我们可以使用#{}或${}的方式获取到参数,这些参数都需要提前我们 ...
Mybatis拦截器安全加解密MySQL数据实战
需求背景公司为了通过一些金融安全指标(政策问题)和防止数据泄漏,需要对用户敏感数据进行加密,所以在公司项目中所有存储了用户信息的数据库都需要进行数据加密改造.包括Mysql.redis.mongod ...
Mybatis拦截器的使用及其源码详解
Mybatis拦截器的使用及其源码详解 Mybatis相关全览一.简介执行与添加顺序拦截器生效入口二.使用例子三.原理加载入口生成代理遍历拦截器匹配&生成代理四.实践例子 ...
MySQL拦截器获取xml id_关于mybatis拦截器，有谁知道怎么对结果集进行拦截，将指定字段查询结果进行格式化...
用MyBatis结果集拦截器做过这样一个需求: 由于项目需求经常变动,项目MySQL数据库都是存放JSON字符串,例如:用户的基本信息随着版本升级可能会有变动数据表 CREATE TABLE `ac ...
list mybatis 接收类型_基于mybatis拦截器实现的一款简易影子表自动切换插件
近期因工作需要,小编基于mybatis拦截器开发了一款简易影子表自动切换插件,可以根据配置实现动态修改表名,即将对原source table表的操作自动切换到对target table表的操作.该插件 ...
犯罪心理解读Mybatis拦截器
原文链接:"犯罪心理"解读Mybatis拦截器 Mybatis拦截器执行过程解析文章写过之后,我觉得 "Mybatis 拦截器案件"背后一定还隐藏着某种设计动 ...
MyBatis拦截器原理探究MyBatis拦截器原理探究
MyBatis拦截器介绍 MyBatis提供了一种插件(plugin)的功能,虽然叫做插件,但其实这是拦截器功能.那么拦截器拦截MyBatis中的哪些内容呢? 我们进入官网看一看: MyBatis拦截 ...

Springboot的Mybatis拦截器实现

MyBatis提供了一种插件(plugin)的功能，虽然叫做插件，其实就是拦截器功能

MyBatis 允许拦截的接口

MyBatis拦截器的接口定义

`setProperties()`

`plugin()`

`intercept()`

注解实现

Executor 拦截器实现

ParameterHandler 拦截器实现

ResultSetHandler 拦截器实现

StatementHandler 拦截器实现

Spring Boot整合

方法1：手写一个配置类

方法2：在拦截器上加`@Component`注解

Springboot的Mybatis拦截器实现相关推荐

最新文章

热门文章

Springboot的Mybatis拦截器实现

MyBatis提供了一种插件(plugin)的功能，虽然叫做插件，其实就是拦截器功能

MyBatis 允许拦截的接口

MyBatis拦截器的接口定义

setProperties()

plugin()

intercept()

注解实现

Executor 拦截器实现

ParameterHandler 拦截器实现

ResultSetHandler 拦截器实现

StatementHandler 拦截器实现

Spring Boot整合

方法1：手写一个配置类

方法2：在拦截器上加@Component注解

Springboot的Mybatis拦截器实现相关推荐

最新文章

热门文章

`setProperties()`

`plugin()`

`intercept()`

方法2：在拦截器上加`@Component`注解