EventBus 开源库学习（二）

整体流程阅读

EventBus在使用的时候基本分为以下几步：
1、注册订阅者

EventBus.getDefault().register(this);

2、订阅者解注册，否者会导致内存泄漏

EventBus.getDefault().unregister(this);

3、在订阅者中编写注解为Subscribe的事件处理函数

@Subscribe(threadMode = ThreadMode.MAIN, sticky = true, priority = 1)
public void onMsgEventReceived(MsgEvent event) {
     Toast.makeText(this, event.getMsg(), Toast.LENGTH_LONG).show();
}

4、事件发送

EventBus.getDefault().post("msg1 - coming！！！");

我们先按使用的流程大体看下源码逻辑，源码版本3.3.1：

1、注册源码逻辑

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

EventBus 使用了双重校验锁的单例设计模式，保证用到的对象是唯一的，首次使用对象为空的时候通过下面构造创建一个。

    public EventBus() {
        this(DEFAULT_BUILDER);
    }

DEFAULT_BUILDER是一个final常量，在加载的时候就进行初始化，赋一个EventBusBuilder对象如下面代码所示。

private static final EventBusBuilder DEFAULT_BUILDER = new EventBusBuilder();

EventBusBuilder是EventBus的建造类，里面参数在加载的时候进行了初始化。

public class EventBusBuilder {
    private final static ExecutorService DEFAULT_EXECUTOR_SERVICE = Executors.newCachedThreadPool();

    boolean logSubscriberExceptions = true;
    boolean logNoSubscriberMessages = true;
    boolean sendSubscriberExceptionEvent = true;
    boolean sendNoSubscriberEvent = true;
    boolean throwSubscriberException;
    boolean eventInheritance = true;
    boolean ignoreGeneratedIndex;
    boolean strictMethodVerification;
    ExecutorService executorService = DEFAULT_EXECUTOR_SERVICE;
    List> skipMethodVerificationForClasses;
    List subscriberInfoIndexes;
    Logger logger;
    MainThreadSupport mainThreadSupport;
    ...
}

如果有需要的话，我们也可以通过配置EventBusBuilder来更改EventBus的属性，在EventBus中有一个静态方法直接返回一直新的EventBusBuilder对象，设置完参数后调用build()来以新的配置来新建一个EventBus对象。

#EventBus
    public static EventBusBuilder builder() {
        return new EventBusBuilder();
    }

#EventBusBuilder
    /** Builds an EventBus based on the current configuration. */
    public EventBus build() {
        return new EventBus(this);
    }

然后通过下面的调用来设置：

EventBus.builder()
        .eventInheritance(false)
        .logSubscriberExceptions(false)
        .build()
        .register(this);

拿到EventBus对象以后，我们可以调用其register方法进行订阅者注册了。

    public void register(Object subscriber) {
        Class subscriberClass = subscriber.getClass();
        List subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);
        synchronized (this) {
            for (SubscriberMethod subscriberMethod : subscriberMethods) {
                subscribe(subscriber, subscriberMethod);
            }
        }
    }

首先获取订阅者类subscriber，然后通过findSubscriberMethods方法获取该类中以@Subscribe注解的函数，由于一个类中可能监听多个事件，因此获取的方法可能是多个，所有的方法赋值到一个List列表中，然后遍历这个列表进行注册。

    private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
        Class eventType = subscriberMethod.eventType;
        Subscription newSubscription = new Subscription(subscriber, subscriberMethod);
        CopyOnWriteArrayList subscriptions = subscriptionsByEventType.get(eventType);
        if (subscriptions == null) {
            subscriptions = new CopyOnWriteArrayList<>();
            subscriptionsByEventType.put(eventType, subscriptions);
        } else {
            if (subscriptions.contains(newSubscription)) {
                throw new EventBusException("Subscriber " + subscriber.getClass() + " already registered to event "
                        + eventType);
            }
        }

        int size = subscriptions.size();
        for (int i = 0; i <= size; i++) {
            if (i == size || subscriberMethod.priority > subscriptions.get(i).subscriberMethod.priority) {
                subscriptions.add(i, newSubscription);
                break;
            }
        }

        List> subscribedEvents = typesBySubscriber.get(subscriber);
        if (subscribedEvents == null) {
            subscribedEvents = new ArrayList<>();
            typesBySubscriber.put(subscriber, subscribedEvents);
        }
        subscribedEvents.add(eventType);

        ....
    }

上面就是注册最主要的代码，步骤解析如下：

• 根据注解方法获取监听事件的类型eventType，并对订阅者subscriber和订阅函数subscriberMethod建立一个订阅关系对象newSubscription；

• 根据eventType在subscriptionsByEventType（HashMap）中获取所有该事件类型的订阅关系列表subscriptions；

• 如果订阅关系列表subscriptions为空就新建一个，然后以key为eventType，value为newSubscription添加进去；

• 如果订阅关系列表subscriptions不为空，判断是否存在newSubscription，如果存在，说明之前已经注册过，抛出异常；

• 如果订阅关系列表subscriptions不为空，列表页没有订阅关系newSubscription，我们遍历添加进去，这里通过订阅函数的priority 来决定存放在列表中的位置，从这里也能看出priority越大，存放位置越靠前，和上一篇中分析的：值越大，优先级越高，越优先接收到事件。我们可以猜出是通过遍历这个表来进行事件发送的，在表里的位置越靠前，越先收到事件。

• 然后通过订阅者subscriber在另一个HashMap - typesBySubscriber中获取该订阅者订阅的所有事件，因为一个订阅者可以订阅多个不同的事件，因此获取的是个List列表subscribedEvents；

• 首先判断subscribedEvents列表是不是空的，如果是空说明以前没有订阅过任何事件，新建一个List，然后以key为subscriber，value为subscribedEvents添加到typesBySubscriber；

• 然后在新建的subscribedEvents中添加我们订阅的事件eventType。

这里出现了两个HashMap：subscriptionsByEventType与typesBySubscriber，通过上面的解析可以知道：
subscriptionsByEventType：一个事件可能有多个订阅者，key是事件，value是所有订阅该事件的所有的订阅者；
typesBySubscriber：一个订阅者可能订阅多个事件，key是订阅者，value是订阅者订阅的所有事件；
看命名就知道By后面的是key值，前面的是value值，一个好的命名就是这样吧。

2、解注册源码逻辑
在使用EventBus时，注册完后我习惯接着去写解注册的代码，怕后面会忘，因此按照写代码习惯在讲下解注册的源码实现。

    /** Unregisters the given subscriber from all event classes. */
    public synchronized void unregister(Object subscriber) {
        List> subscribedTypes = typesBySubscriber.get(subscriber);
        if (subscribedTypes != null) {
            for (Class eventType : subscribedTypes) {
                unsubscribeByEventType(subscriber, eventType);
            }
            typesBySubscriber.remove(subscriber);
        } else {
            logger.log(Level.WARNING, "Subscriber to unregister was not registered before: " + subscriber.getClass());
        }
    }

如果是我们自己写这部分代码，根据前面注册的过程，我们肯定是要把添加到两个HashMap中的值移除掉。好了，看上面源码，首先在typesBySubscriber中获取该订阅者订阅的事件列表subscribedTypes；

如果为空说明该订阅者没有订阅任何事件，无任何操作；如果不为空，遍历所有事件调用unsubscribeByEventType方法进行解注册，然后在typesBySubscriber中移除这个订阅者subscriber。

    /** Only updates subscriptionsByEventType, not typesBySubscriber! Caller must update typesBySubscriber. */
    private void unsubscribeByEventType(Object subscriber, Class eventType) {
        List subscriptions = subscriptionsByEventType.get(eventType);
        if (subscriptions != null) {
            int size = subscriptions.size();
            for (int i = 0; i < size; i++) {
                Subscription subscription = subscriptions.get(i);
                if (subscription.subscriber == subscriber) {
                    subscription.active = false;
                    subscriptions.remove(i);
                    i--;
                    size--;
                }
            }
        }
    }

在上一个方法中，已经把typesBySubscriber这个订阅者移除了，那么unsubscribeByEventType函数就是遍历事件所有的订阅者，然后把解注册的订阅者在subscriptionsByEventType中给移除掉。上面的逻辑就是干这个事情。不过一边遍历一边移除是有风险的，这个大家要注意，index需要也跟着进行减少。

总结下：注册和解注册就是往两个HashMap添加和移除数据的过程。

3、事件发送post源码逻辑

    /** Posts the given event to the event bus. */
    public void post(Object event) {
        PostingThreadState postingState = currentPostingThreadState.get();
        List