Eventbus3代码分析(六):SubscriberMethodFinder类


SubscriberMethodFinder类

SubscriberMethodFinder
大体就是去注册后对应的方法

其中,属性

private static final int BRIDGE = 0x40;

有对应的说明:

In newer class files, compilers may add methods. Those are called bridge or synthetic methods.
EventBus must ignore both. There modifiers are not public but defined in the Java class file format:
http://docs.oracle.com/javase/specs/jvms/se7/html/jvms-4.html#jvms-4.6-200-A.1

自己也没有研究过jvm,简单贴一下图

下面对应的变量修饰符

private static final int MODIFIERS_IGNORE = Modifier.ABSTRACT | Modifier.STATIC | BRIDGE | SYNTHETIC;

也就是,
方法上的注解,会忽略这几种修饰符的方法


属性方面

先重点看一下这2个容器


一个是 : 本类存储的容器类,用于 查找 和 存储
另一个是 :传入的引用


方法大体了解

Eventbus3

这里,我们可以发现,
除了 构造 和 findSubscriberMethods方法 是 public对外的
其他,都是 private 的
也就是,我们主要认识 findSubscriberMethods方法 即可

和EventBus 2.4 对比


EventBus 2.4

我们大体可以猜测,其他多余出来的方法,都是用于判断反射的


findSubscriberMethods方法

先一起大体过一下

List<SubscriberMethod> findSubscriberMethods(Class<?> subscriberClass) {
    List<SubscriberMethod> subscriberMethods = METHOD_CACHE.get(subscriberClass);
    if (subscriberMethods != null) {
        return subscriberMethods;
    }

    if (ignoreGeneratedIndex) {
        subscriberMethods = findUsingReflection(subscriberClass);
    } else {
        subscriberMethods = findUsingInfo(subscriberClass);
    }
    if (subscriberMethods.isEmpty()) {
        throw new EventBusException("Subscriber " + subscriberClass
                + " and its super classes have no public methods with the @Subscribe annotation");
    } else {
        METHOD_CACHE.put(subscriberClass, subscriberMethods);
        return subscriberMethods;
    }
}

这里,大体就是

  • 如果有Map缓存中有值,就直接获取
  • 如果 ignoreGeneratedIndex为true 就 findUsingReflection(subscriberClass) 通过反射获取
  • 如果 ignoreGeneratedIndex为false ,就 findUsingInfo(subscriberClass) 获取
  • 最后
    • subscriberMethods 为空,内部报异常(对外是不会提示的)
    • subscriberMethods 不空,把对应的key为 subscriberClass, value为subscriberMethods 加入到 Map缓存中

findUsingInfo方法

上面提到的
如果Map缓存中 没有值,并且 ignoreGeneratedIndex为false的时候
会调用这个方法
具体看下源码

private List<SubscriberMethod> findUsingInfo(Class<?> subscriberClass) {
    FindState findState = prepareFindState();
    findState.initForSubscriber(subscriberClass);
    while (findState.clazz != null) {
        findState.subscriberInfo = getSubscriberInfo(findState);
        if (findState.subscriberInfo != null) {
            SubscriberMethod[] array = findState.subscriberInfo.getSubscriberMethods();
            for (SubscriberMethod subscriberMethod : array) {
                if (findState.checkAdd(subscriberMethod.method, subscriberMethod.eventType)) {
                    findState.subscriberMethods.add(subscriberMethod);
                }
            }
        } else {
            findUsingReflectionInSingleClass(findState);
        }
        findState.moveToSuperclass();
    }
    return getMethodsAndRelease(findState);
}

这里通过 prepareFindState(), 获取 FindState 对象
(具体方法,见下面的方法说明)


FindState 静态内部类

这里因为上面的方法会获取这个对象
所以,我们先来看一下这个对象

static class FindState {
    final List<SubscriberMethod> subscriberMethods = new ArrayList<>();
    final Map<Class, Object> anyMethodByEventType = new HashMap<>();
    final Map<String, Class> subscriberClassByMethodKey = new HashMap<>();
    final StringBuilder methodKeyBuilder = new StringBuilder(128);

    Class<?> subscriberClass;
    Class<?> clazz;
    boolean skipSuperClasses;
    SubscriberInfo subscriberInfo;

    void initForSubscriber(Class<?> subscriberClass) {
        this.subscriberClass = clazz = subscriberClass;
        skipSuperClasses = false;
        subscriberInfo = null;
    }

    void recycle() {
        subscriberMethods.clear();
        anyMethodByEventType.clear();
        subscriberClassByMethodKey.clear();
        methodKeyBuilder.setLength(0);
        subscriberClass = null;
        clazz = null;
        skipSuperClasses = false;
        subscriberInfo = null;
    }

    boolean checkAdd(Method method, Class<?> eventType) {
        // 2 level check: 1st level with event type only (fast), 2nd level with complete signature when required.
        // Usually a subscriber doesn't have methods listening to the same event type.
        Object existing = anyMethodByEventType.put(eventType, method);
        if (existing == null) {
            return true;
        } else {
            if (existing instanceof Method) {
                if (!checkAddWithMethodSignature((Method) existing, eventType)) {
                    // Paranoia check
                    throw new IllegalStateException();
                }
                // Put any non-Method object to "consume" the existing Method
                anyMethodByEventType.put(eventType, this);
            }
            return checkAddWithMethodSignature(method, eventType);
        }
    }

    private boolean checkAddWithMethodSignature(Method method, Class<?> eventType) {
        methodKeyBuilder.setLength(0);
        methodKeyBuilder.append(method.getName());
        methodKeyBuilder.append('>').append(eventType.getName());

        String methodKey = methodKeyBuilder.toString();
        Class<?> methodClass = method.getDeclaringClass();
        Class<?> methodClassOld = subscriberClassByMethodKey.put(methodKey, methodClass);
        if (methodClassOld == null || methodClassOld.isAssignableFrom(methodClass)) {
            // Only add if not already found in a sub class
            return true;
        } else {
            // Revert the put, old class is further down the class hierarchy
            subscriberClassByMethodKey.put(methodKey, methodClassOld);
            return false;
        }
    }

    void moveToSuperclass() {
        if (skipSuperClasses) {
            clazz = null;
        } else {
            clazz = clazz.getSuperclass();
            String clazzName = clazz.getName();
            /** Skip system classes, this just degrades performance. */
            if (clazzName.startsWith("java.") || clazzName.startsWith("javax.") || clazzName.startsWith("android.")) {
                clazz = null;
            }
        }
    }
}

这个代码比较长,我们大体看一下即可


  • initForSubscriber方法
    • 初始化静态内部类
    • 传递 Class<?> 对象
    • 设置 SubscriberInfo 为空
  • recycle方法
    • 所有集合都 clear , 引用对象都设置为null
    • 因为是静态的, 所以 回收后再次调用
  • checkAdd方法
    • boolean类型
    • 将对应的 key 为 eventType, value 为 Method 放入到 Map中
    • 2 level check: 1st level with event type only (fast), 2nd level with complete signature when required.
    • Usually a subscriber doesn't have methods listening to the same event type.
    • 这里有2次check, 第一次check是比较快, 第二次会再次check,通常一个subscriber不会监听2个相同的event
  • checkAddWithMethodSignature方法
    • 也就是第二次check,通过拼接一个string来作为一个key
  • moveToSuperclass方法
    • 如果 skipSuperClasses为true,或者 Superclass的startsWith对应的时候,设置 clazz = null
    • 其他时候,返回 clazz = clazz.getSuperclass().getName()

大体就是

  • 初始化对应的类属性
  • 再就是check是否已经add过了(这里是2次check)
  • 把class的属性,设置为Super的class(特殊情况设置为null)

prepareFindState方法

这里是前面 findUsingInfo方法 中用到的
也就是用来获取FindState对象的方法

private FindState prepareFindState() {
    synchronized (FIND_STATE_POOL) {
        for (int i = 0; i < POOL_SIZE; i++) {
            FindState state = FIND_STATE_POOL[i];
            if (state != null) {
                FIND_STATE_POOL[i] = null;
                return state;
            }
        }
    }
    return new FindState();
}

这里,知道这里有一个 FIND_STATE_POOL 对象池
对象个数 POOL_SIZE 为 4
具体对象为 FindState
是一个 静态内部类
for循环取值:

  • 如果不为空, 则找到对象池中 一个不为空的对象
  • 如果为空,就返回一个新的 FindState对象()

getMethodsAndRelease 方法

先看一下源码

private List<SubscriberMethod> getMethodsAndRelease(FindState findState) {
    List<SubscriberMethod> subscriberMethods = new ArrayList<>(findState.subscriberMethods);
    findState.recycle();
    synchronized (FIND_STATE_POOL) {
        for (int i = 0; i < POOL_SIZE; i++) {
            if (FIND_STATE_POOL[i] == null) {
                FIND_STATE_POOL[i] = findState;
                break;
            }
        }
    }
    return subscriberMethods;
}

这里大体就是获取 FindState中的List<SubscriberMethod>类型的对象subscriberMethods
将对应的FindState对象放入对象池中
最后返回List<SubscriberMethod>的值


getSubscriberInfo方法

也先看一下源码

private SubscriberInfo getSubscriberInfo(FindState findState) {
    if (findState.subscriberInfo != null && findState.subscriberInfo.getSuperSubscriberInfo() != null) {
        SubscriberInfo superclassInfo = findState.subscriberInfo.getSuperSubscriberInfo();
        if (findState.clazz == superclassInfo.getSubscriberClass()) {
            return superclassInfo;
        }
    }
    if (subscriberInfoIndexes != null) {
        for (SubscriberInfoIndex index : subscriberInfoIndexes) {
            SubscriberInfo info = index.getSubscriberInfo(findState.clazz);
            if (info != null) {
                return info;
            }
        }
    }
    return null;
}

也就是如果传入的findState对象不空,并且有SubscriberInfo的值
(这块自己感觉没有赋值的地方,应该为null,具体先不纠结)
或者对应的值,并且SubscriberInfo不为空,Class相同的时候,
返回对应的SubscriberInfo对象

如果上面不符合,会取从构造传进来的subscriberInfoIndexes对象中
for循环,获取第一个 SubscriberInfo 对象


findUsingReflection方法

这里就不贴代码了
大体为:

  • 先通过 prepareFindState方法,获得内部静态类的FindState对象
  • 再while (findState.clazz != null)循环
    • 通过findUsingReflectionInSingleClass方法
    • 每次获取一个类后,通过 FindState的moveToSuperclass()方法,设置class引用
      • 如果有父类,设置为class=class.getSuperclass()
      • 如果没有父类,赋值class=null,从而让findUsingReflection中,离开while循环

findUsingReflectionInSingleClass方法

上面用到的
大体为:

  • 获取每个SingleClass的方法,
  • 在除去其他修饰的方法后,获取 注解的 Subscribe对象,
  • 放入FindState对象的subscriberMethods容器中

简单总结

对外,就2个方法

  • 一个是构造,传入 List<SubscriberInfoIndex> subscriberInfoIndexes 等变量
  • 一个是 findSubscriberMethods, 去找对应的注册者Subscriber的方法

对应的方法,会存入
Map<Class<?>, List<SubscriberMethod>> METHOD_CACHE = new ConcurrentHashMap<>()
容器中

  • 如果容器中有,会从容器中获取 List<SubscriberMethod>
  • 如果容器中没有
    • ignoreGeneratedIndex 为 true,则通过反射去拿具体的类中获取
    • ignoreGeneratedIndex 为 false,则 通过 findUsingInfo方法获取
      • FindState对象池中,获取对象
      • 通过while循环(这里后面的方法会设置对象,确定可以跳出循环)
      • 遍历,获取 List<SubscriberMethod> 对象
        • 如果FindState 对象池 中有,则直接获取
        • 如果 FindState 对象池中没有,则 从构造传入的subscriberInfoIndexes对象中获取
  • 其实,最终也就获取 List<SubscriberMethod>
    • 通过传进来的Class<?> 对象
    • 也就是在 Activity或者Fragment中注册的Class
    • 获取@Subscriber 进行注解的方法 们

(其实,自己不太理解,这里为什么用一个容器存储,为什么要这样写结构 等等,只是简单的叙述了下流程,等有时间,再考虑一下)

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,598评论 18 139
  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,678评论 0 9
  • 一:java概述:1,JDK:Java Development Kit,java的开发和运行环境,java的开发工...
    ZaneInTheSun阅读 2,629评论 0 11
  • 喝酒,没喝多,低调低调,一切安好,晚安!
    何时再出发阅读 91评论 1 0
  • 相遇在海面 你遨游九天 我沉于深渊
    花败不开阅读 139评论 0 0