前言
Mybatis作为一个应用广泛的优秀的ORM框架，已经成了JavaWeb世界近乎标配的部分，这个框架具有强大的灵活性，在四大组件（Executor、StatementHandler、ParameterHandler、ResultSetHandler）处提供了简单易用的插件扩展机制。Mybatis对持久层的操作就是借助于四大核心对象。MyBatis支持用插件对四大核心对象进行拦截，对mybatis来说插件就是拦截器，用来增强核心对象的功能，增强功能本质上是借助于底层的动态代理实现的，换句话说，MyBatis中的四大对象都是代理对象。
四大核心对象简介
MyBatis四大核心对象
ParameterHandler：处理SQL的参数对象
ResultSetHandler：处理SQL的返回结果集
StatementHandler：数据库的处理对象，用于执行SQL语句
Executor：MyBatis的执行器，用于执行增删改查操作
Mybatis插件原理
- Mybatis的插件借助于责任链的模式进行对拦截的处理
- 使用动态代理对目标对象进行包装，达到拦截的目的
- 作用于Mybatis的作用域对象之上
拦截
插件具体是如何拦截并附加额外的功能的呢？
以ParameterHandler来说
publicParameterHandlernewParameterHandler(MappedStatementmappedStatement,Objectobject,BoundSqlsql,InterceptorChaininterceptorChain){
ParameterHandlerparameterHandler=mappedStatement.getLang().createParameterHandler(mappedStatement,object,sql);
parameterHandler=(ParameterHandler)interceptorChain.pluginAll(parameterHandler);
returnparameterHandler;
}
publicObjectpluginAll(Objecttarget){
for(Interceptorinterceptor:interceptors){
target=interceptor.plugin(target);
}
returntarget;
}
interceptorChain保存了所有的拦截器(interceptors)，是mybatis初始化的时候创建的。调用拦截器链中的拦截器依次的对目标进行拦截或增强。interceptor.plugin(target)中的target就可以理解为mybatis中的四大对象。返回的target是被重重代理后的对象。
插件接口
Mybatis插件接口-Interceptor
1.Intercept方法，插件的核心方法
2.plugin方法，生成target的代理对象
3.setProperties方法，传递插件所需参数
插件实例
插件开发需要以下步骤
- 自定义插件需要实现上述接口
- 增加@Intercepts注解（声明是哪个核心组件的插件，以及对哪些方法进行扩展）
- 在xml文件中配置插件
/**插件签名，告诉mybatis单钱插件用来拦截那个对象的哪个方法**/
@Intercepts({@Signature(type=ResultSetHandler.class,method="handleResultSets",args=Statement.class)})
publicclassMyFirstInterceptorimplementsInterceptor{
/**@Description拦截目标对象的目标方法**/
@Override
publicObjectintercept(Invocationinvocation)throwsThrowable{
System.out.println("拦截的目标对象："+invocation.getTarget());
Objectobject=invocation.proceed();
returnobject;
}
/**
*@Description包装目标对象为目标对象创建代理对象
*@Paramtarget为要拦截的对象
*@Return代理对象
*/
@Override
publicObjectplugin(Objecttarget){
System.out.println("将要包装的目标对象："+target);
returnPlugin.wrap(target,this);
}
/**获取配置文件的属性**/
@Override
publicvoidsetProperties(Propertiesproperties){
System.out.println("插件配置的初始化参数："+properties);
}
}
在mybatis.xml中配置插件
<!--自定义插件-->
<plugins>
<plugininterceptor="mybatis.interceptor.MyFirstInterceptor">
<!--配置参数-->
<propertyname="name"value="Bob"/>
</plugin>
</plugins>
调用查询方法，查询方法会返回ResultSet
publicclassMyBatisTest{
publicstaticSqlSessionFactorysqlSessionFactory=null;
publicstaticSqlSessionFactorygetSqlSessionFactory(){
if(sqlSessionFactory==null){
Stringresource="mybatis-config.xml";
try{
Readerreader=Resources.getResourceAsReader(resource);
sqlSessionFactory=newSqlSessionFactoryBuilder().build(reader);
}catch(IOExceptione){
e.printStackTrace();
}
}
returnsqlSessionFactory;
}
publicvoidtestGetById()
{
SqlSessionsqlSession=this.getSqlSessionFactory().openSession();
PersonMapperpersonMapper=sqlSession.getMapper(PersonMapper.class);
Personperson=personMapper.getById(2001);
System.out.println(person.toString());
}
publicstaticvoidmain(String[]args){
newMyBatisTest().testGetById();
}
}
输出结果
插件配置的初始化参数：{name=Bob}
将要包装的目标对象：org.apache.ibatis.executor.CachingExecutor@754ba872
将要包装的目标对象：org.apache.ibatis.scripting.defaults.DefaultParameterHandler@192b07fd
将要包装的目标对象：org.apache.ibatis.executor.resultset.DefaultResultSetHandler@7e0b0338
将要包装的目标对象：org.apache.ibatis.executor.statement.RoutingStatementHandler@1e127982
拦截的目标对象：org.apache.ibatis.executor.resultset.DefaultResultSetHandler@7e0b0338
Person{id=2001,username='Tom',email='email@0',gender='F'}
多插件开发过程
1.创建代理对象时，按照插件配置的顺序进行包装
2.执行目标方法后，是按照代理的逆向进行执行
总结
1.遵循插件尽量不使用的原则，因为会修改底层设计
2.插件是生成的层层代理对象的责任链模式，使用反射机制实现
3.插件的编写要考虑全面，特别是多个插件层层代理的时候
网友评论