EventBus源码解析 源码阅读记录

EventBus源码阅读记录

repo地址:
greenrobot/EventBus

EventBus的构造

双重加锁的单例.

static volatile EventBus defaultInstance;
public static EventBus getDefault() {
    if (defaultInstance == null) {
        synchronized (EventBus.class) {
            if (defaultInstance == null) {
                defaultInstance = new EventBus();
            }
        }
    }
    return defaultInstance;
}

但是仍然开放了构造函数,用于构造其他别的对象.

Builder模式: EventBusBuilder.
有一个DEFAULT_BUILDER.

注册

注册即添加订阅者,调用register()方法:
方法参数最全时共有三个参数:

private synchronized void register(Object subscriber, boolean sticky, int priority) {
    List subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriber.getClass());
    for (SubscriberMethod subscriberMethod : subscriberMethods) {
        subscribe(subscriber, subscriberMethod, sticky, priority);
    }
}

其中subscriber(订阅者)传入的是一个对象,用到了它的class.
SubscriberMethodFinder会去找这个类中的方法.
被找到的方法最后会被缓存到一个map里,key是class, value是ArrayList().

寻找方法

在一个类(class)中寻找方法的过程, 首先是拿出方法:
在循环中skip了一些系统的类, 因为我们不可能在这些类里加入方法.

while (clazz != null) {
    String name = clazz.getName();
    if (name.startsWith("java.") || name.startsWith("javax.") || name.startsWith("android.")) {
        // Skip system classes, this just degrades performance
        break;
    }

    // Starting with EventBus 2.2 we enforced methods to be public (might change with annotations again)
    try {
        // This is faster than getMethods, especially when subscribers a fat classes like Activities
        Method[] methods = clazz.getDeclaredMethods();
        filterSubscriberMethods(subscriberMethods, eventTypesFound, methodKeyBuilder, methods);
    } catch (Throwable th) {
        // Workaround for java.lang.NoClassDefFoundError, see https://github.com/greenrobot/EventBus/issues/149
        Method[] methods = subscriberClass.getMethods();
        subscriberMethods.clear();
        eventTypesFound.clear();
        filterSubscriberMethods(subscriberMethods, eventTypesFound, methodKeyBuilder, methods);
        break;
    }
    clazz = clazz.getSuperclass();
}

反射

关于反射的性能讨论, 代码中有说:

// This is faster than getMethods, especially when subscribers a fat classes like Activities
Method[] methods = clazz.getDeclaredMethods();

为什么呢?
getMethods()返回了所有的public方法,包含从所有基类继承的,也即包含了从Object类中继承的public方法.
getDeclaredMethods()返回了该类中声明的所有方法,包括各种访问级别的,但是只包含本类中的,不包括基类中的方法.

相关DOC:

反射package-summary
getDeclaredMethods()
getMethods()

Issue of NoClassDefFoundError

这里有一个try catch主要是为了解决这个issue: https://github.com/greenrobot/EventBus/issues/149
本来的流程是:

1. 从自己的class开始,每次都getDeclaredMethods(), 即提取自己类中的方法,不取基类.
2. 取完之后, getSuperclass(),获取基类的class,重新进入while循环.直到进入java包或者android包才退出.

但是getDeclaredMethods()会检查一些参数和返回值, 如果找不到类型则抛出NoClassDefFoundError.
getMethods()却不检查.

什么样的情况会抛出这个Error呢?

Android代码里可能会有一些方法标明了@TargetApi,表明是更高级的sdk上才会有的.
这样在低版本的机器上遇到了这些代码,就无法解析出它们的类了.

只要你的作为subscriber的class里含有这种东西,就会出现问题.

为了解决这个崩溃, 所以代码里catch了一把,然后采用第二种方案getMethods(),一次性get所有基类中的方法,这种效率虽然低,但是不会抛异常.
需要把之前的map都清理一把.

筛选方法

得到了所有的方法之后,开始筛选方法:

private void filterSubscriberMethods(List subscriberMethods, HashMap eventTypesFound, 
StringBuilder methodKeyBuilder, Method[] methods)

这里第一个参数会作为最后的返回值,即我们方法选择的结果.

筛选的过程, 遍历所有找到的方法:

1. 看它是以”onEvent”开头,即为我们要找的目标方法.

2. 然后getModifiers()看它是一个public的方法,并且不是我们要忽略的方法.
   注意这里用到了位操作&来比较. 结果不为零表示满足,为零表示不满足.
   默认的忽略方法是static, bridge, synthetic方法.
   后两个词指的其实是同一种东东,但是这是什么东东呢?
   是编译器生成的方法, 见参考链接:
   https://javax0.wordpress.com/2014/02/26/syntethic-and-bridge-methods/
   https://docs.oracle.com/javase/tutorial/java/generics/bridgeMethods.html
   从上面的例子中可以看出,编译器生成bridge方法主要是为了保证多态的顺利进行.它和基类的签名一样,但是实现去调用了子类的方法.自己偷偷完成了其中的类型转换.

3. 获取参数类型:必须是一个参数.

4. 获取ThreadMode: 即看方法名中onEvent之后还是什么,一共有四种Mode,对应四种方法名:
   onEvent(), onEventMainThread(), onEventBackgroundThread(), onEventAsync()
   如果获取不到ThreadMode,则continue;即这个方法不是我们要找的方法.

5. 用StringBuilder组成一个key: method name>parameterType class name.
   注意这里StringBuilder的清理方式是setLength(0).
   然后放进了一个eventTypesFound的HashMap, String是key, Class是value,这里放的是method.getDeclaringClass();即方法声明的那个类的类型.

注意这里还利用了put()方法的返回值,如果map里之前有这个key对应的值,那么老的value会作为返回值返回.
文档:
HashMap.put()

这里还用了这个一个方法: isAssignableFrom
判断是否自己的class是参数的基类或接口.如果传入的参数是当前对象的子类或自身,则返回true.

如果有old class存在,并且old class和新的class不能互相转换, 后者old是new的子类, 那么eventTypesFound这个map里还是保存老的值.

如果存在old class,但是old class是新加class的父类,会把新的class加进eventTypesFound的map,取代前者,即这个map中尽量放继承体系下层中更具体的类.
这里虽然父类没有被放进eventTypesFound,但是父类的方法仍然会被加进最后返回的methods的map.

筛选结束后,我们就获取到了所有的目标方法.
把它们都存在了一个cache map里面,以免同一个类下次我们又要重新筛选一遍:

private static final Map, List> methodCache = new HashMap, List>();

订阅

得到了方法的list(List)之后,我们要对每一个成员调用
private void subscribe(Object subscriber, SubscriberMethod subscriberMethod, boolean sticky, int priority) 方法.

里面有一个新的数据类型CopyOnWriteArrayList:
CopyOnWriteArrayList Java doc
CopyOnWriteArrayList android doc

类说明: A thread-safe variant of ArrayList in which all mutative operations (add, set, and so on) are implemented by making a fresh copy of the underlying array.

这个数据类型是一个ArrayList,但是它在每次进行变异操作之前都拷贝一份新的.它底层的数组是volatile的.
这种数据类型的写操作代价很高.

subscribe()方法中主要是给这两个字段放数据:

1. private final Map, CopyOnWriteArrayList> subscriptionsByEventType;
   key是eventType的Class, value是Subscription这种数据类型的数组:
   Subscription newSubscription = new Subscription(subscriber, subscriberMethod, priority);

2. private final Map>> typesBySubscriber;
   key是subscriber,即订阅者的类的对象,value是eventType的class,即事件类.

注销

unregister()的时候, 传入subscriber:
首先从typesBySubscriber获取到事件的List,然后遍历这个List, 从subscriptionsByEventType中移除该eventType,并且subscriber是当前subscriber的Subscription.
遍历完成之后,从typesBySubscriber移除该subscriber.

事件触发

好了,注册和反注册到这里就结束了,看起来也就是找到一些方法和类型,放在一些map里面,注销的时候再从map里面拿出来而已.
真正做事情的代码呢?

首先看事件的触发: post()方法, 这里传入的参数是事件类对象.

public void post(Object event) {
    PostingThreadState postingState = currentPostingThreadState.get();
    List