Mybatis-Plugin解析

首先mybatisPlugin是针对于mybatis四大组件(Statementhandler、resultsethandler、parameterHandler、executor)做增强操作的。
要使用自定义plugin首先要实现Interceptor接口,如下:

public interface Interceptor {
//执行目标方法
Object intercept(Invocation invocation) throws Throwable;
//执行pluginAll调用
Object plugin(Object target);
//xml配置的初始化参数值
void setProperties(Properties properties);
}

首先自定义一个plugin实现接口如下:

@Intercepts({
        //type表示需要拦截的类型,method+args表示需要拦截的具体方法
        @Signature(type= Executor.class,method="query",args={MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
})
public class MyPlugin implements Interceptor{
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        System.out.println("执行增强方法。。。");
        return invocation.proceed();
    }
    @Override
    public Object plugin(Object target) {
        System.out.println("执行pluginAll。。。");
        return Plugin.wrap(target,this);
    }
    @Override
    public void setProperties(Properties properties) {
        System.out.println("初始化。。。配置参数"+properties);
    }
}

第一个方法intercept里面执行了Invocarion对象的proceed方法,可以看出使用了反射执行了目标方法,这边有几个参数,分别有注释解释。

public class Invocation {
  //目标对象
  private final Object target;
  //目标方法
  private final Method method;
  //入参数
  private final Object[] args;
  //。。。构造函数、get、set方法
  public Object proceed() throws InvocationTargetException, IllegalAccessException {
    return method.invoke(target, args);
  }
}

第二个方法plugin执行了Plugin.Wrap方法,传入的参数是被代理对象,以及当前interceptor对象。Plugin对象如下:

public class Plugin implements InvocationHandler {
  //目标对象
  private final Object target;
  //interceptor对象
  private final Interceptor interceptor;
  //解析出来需要拦截的对象以及 方法
  private final Map<Class<?>, Set<Method>> signatureMap;
}

可以看出plugin实现了拦截器接口,对方法进行拦截,接下来看wrap方法做了什么:

public static Object wrap(Object target, Interceptor 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;
  }

这边具体看一下getAllInterfaces如何判断的:

private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {
    //初始化接口集合
    Set<Class<?>> interfaces = new HashSet<Class<?>>();
   //type是目标对象
    while (type != null) {
      //遍历目标对象的接口方法,如果需要拦截的方法集合中存在了方法,则将方法加入interfaces集合中
      for (Class<?> c : type.getInterfaces()) {
        if (signatureMap.containsKey(c)) {
          interfaces.add(c);
        }
      }
      //获取父类并循环
      type = type.getSuperclass();
    }
    return interfaces.toArray(new Class<?>[interfaces.size()]);
  }

接下来看Plugin对象实现的invoke方法,在执行newProxyInstance方法时传入了一个新建的Plugin对象,包含了目标对象,interceptor以及需要拦截的方法:

@Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
      //获取到本目标对象需要拦截的方法
      Set<Method> methods = signatureMap.get(method.getDeclaringClass());
      if (methods != null && methods.contains(method)) {
        //如果有则执行intercepytor的intercept方法
        return interceptor.intercept(new Invocation(target, method, args));
      }
      //如果没有则执行原方法
      return method.invoke(target, args);
    } catch (Exception e) {
      throw ExceptionUtil.unwrapThrowable(e);
    }
  }

之前介绍过了,Interceptor的intercept方法执行了invocation方法的proceed方法,而proceed方法又是反射执行原方法,所以增强是在intercept方法执行的。

接下来看一下plugin是在什么时候生效的。
pluginAll调用处

可以看出来在四大组件生成时就会执行pluginAll方法,生成对应的代理对象,每一个plugin都会执行wrap方法,对注册过需要增强的方法进行增强。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,324评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,356评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,328评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,147评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,160评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,115评论 1 296
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,025评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,867评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,307评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,528评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,688评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,409评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,001评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,657评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,811评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,685评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,573评论 2 353

推荐阅读更多精彩内容