mybatis的插件机制示例详解

前言

mybatis作为一个应用广泛的优秀的orm框架，已经成了javaweb世界近乎标配的部分，这个框架具有强大的灵活性，在四大组件（executor、statementhandler、parameterhandler、resultsethandler）处提供了简单易用的插件扩展机制。mybatis对持久层的操作就是借助于四大核心对象。mybatis支持用插件对四大核心对象进行拦截，对mybatis来说插件就是拦截器，用来增强核心对象的功能，增强功能本质上是借助于底层的动态代理实现的，换句话说，mybatis中的四大对象都是代理对象。

四大核心对象简介

mybatis 四大核心对象

parameterhandler：处理sql的参数对象

resultsethandler：处理sql的返回结果集

statementhandler：数据库的处理对象，用于执行sql语句

executor：mybatis的执行器，用于执行增删改查操作

mybatis插件原理

1. mybatis的插件借助于责任链的模式进行对拦截的处理
2. 使用动态代理对目标对象进行包装，达到拦截的目的
3. 作用于mybatis的作用域对象之上

拦截

插件具体是如何拦截并附加额外的功能的呢？

以parameterhandler 来说

 public parameterhandler newparameterhandler(mappedstatement mappedstatement, object object, boundsql sql, interceptorchain interceptorchain){
 parameterhandler parameterhandler = mappedstatement.getlang().createparameterhandler(mappedstatement,object,sql);
 parameterhandler = (parameterhandler) interceptorchain.pluginall(parameterhandler);
 return parameterhandler;
 }
public object pluginall(object target) {
 for (interceptor interceptor : interceptors) {
 target = interceptor.plugin(target);
 }
 return target;
 }

interceptorchain 保存了所有的拦截器(interceptors)，是mybatis初始化的时候创建的。调用拦截器链中的拦截器依次的对目标进行拦截或增强。interceptor.plugin(target)中的target就可以理解为mybatis中的四大对象。返回的target是被重重代理后的对象。

插件接口

mybatis插件接口-interceptor

1.intercept方法，插件的核心方法

2.plugin方法，生成target的代理对象

3.setproperties方法，传递插件所需参数

插件实例

插件开发需要以下步骤

1. 自定义插件需要实现上述接口
2. 增加@intercepts注解（声明是哪个核心组件的插件，以及对哪些方法进行扩展）
3. 在xml文件中配置插件

/** 插件签名，告诉mybatis单钱插件用来拦截那个对象的哪个方法 **/
@intercepts({@signature(type = resultsethandler.class,method ="handleresultsets",args = statement.class)})
public class myfirstinterceptor implements interceptor {

 /** @description 拦截目标对象的目标方法 **/
 @override
 public object intercept(invocation invocation) throws throwable {
 system.out.println("拦截的目标对象："+invocation.gettarget());
 object object = invocation.proceed();
 return object;
 }
 /**
 * @description 包装目标对象 为目标对象创建代理对象
 * @param target为要拦截的对象
 * @return 代理对象
 */
 @override
 public object plugin(object target) {
 system.out.println("将要包装的目标对象："+target);
 return plugin.wrap(target,this);
 }
 /** 获取配置文件的属性 **/
 @override
 public void setproperties(properties properties) {
 system.out.println("插件配置的初始化参数："+properties);
 }
}

在mybatis.xml中配置插件

<!-- 自定义插件 -->
 <plugins>
  <plugin interceptor="mybatis.interceptor.myfirstinterceptor">
   <!--配置参数-->
   <property name="name" value="bob"/>
  </plugin>
 </plugins>

调用查询方法，查询方法会返回resultset

public class mybatistest {
 public static sqlsessionfactory sqlsessionfactory = null;

 public static sqlsessionfactory getsqlsessionfactory() {
  if (sqlsessionfactory == null) {
   string resource = "mybatis-config.xml";
   try {
    reader reader = resources.getresourceasreader(resource);
    sqlsessionfactory = new sqlsessionfactorybuilder().build(reader);
   } catch (ioexception e) {
    e.printstacktrace();
   }
  }
  return sqlsessionfactory;
 }

 public void testgetbyid()
 {
  sqlsession sqlsession = this.getsqlsessionfactory().opensession();
  personmapper personmapper = sqlsession.getmapper(personmapper.class);
  person person=personmapper.getbyid(2001);
  system.out.println(person.tostring());
 }

public static void main(string[] args) {
  new mybatistest().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', , gender='f'}

多插件开发过程

1.创建代理对象时，按照插件配置的顺序进行包装

2.执行目标方法后，是按照代理的逆向进行执行

总结

1.遵循插件尽量不使用的原则，因为会修改底层设计
2.插件是生成的层层代理对象的责任链模式，使用反射机制实现
3.插件的编写要考虑全面，特别是多个插件层层代理的时候

好了，以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对的支持。