EventBus源码学习随笔

EventBus是什么？

简介

EventBus是Android和Java的开源库，它使用发布者/订阅者模式进行松散耦合。EventBus使用了总线控制，能够用几行代码解耦类及简化代码，消除依赖关系，加速应用程序开发。

下图为官方示例图：

官方示例图

官网网址：EventBus官网

Github地址:Github

特点

• 简化组件之间的通信
• 发送者和接收者高度解耦
• 性能高效，社区活跃
• 库文件很小（<50KB）
• 具有简便配置线程、优先级等高级特性

EventBus怎么用？

1、gradle引入

implementation 'org.greenrobot:eventbus:3.1.1'

2、注册与取消注册

//注册
EventBus.getDefault().register(this);

//取消注册
EventBus.getDefault().unregister(this);

3、事件定义与发送

//定义
public class MessageEvent {
}
//发送
EventBus.getDefault().post(new MessageEvent());

4、事件接收

 @Subscribe(threadMode = ThreadMode.POSTING)
    public void onEventMainThread(MessageEvent event) {
        // doSomeThing()；
    };

EventBus核心执行流程是怎样？

EventBus的使用包含注册、取消注册、事件定义发送及事件接收。当用户进行注册时，会通过反射获取实例中定义事件方法集合，然后将事件方法集合及订阅者加入到Map中，当执行post时，会根据事件类型，从集合中获取对应的订阅集合，通过配置的threadMode，使用对应的Poster调用订阅者的事件，最后通过反射method的invoke执行事件。

关键类功能说明

类	说明
EventBus	总线调度类，getDefault()为单例模式。内部持有订阅者及事件集合。还有各事件的发送器。eventTypesCache（缓存所有粘性事件的集合）、subscriptionsByEventType（key为事件，value为订阅者集合的Map）、typesBySubscriber（key为订阅者，value为事件集合的Map）、currentPostingThreadState（ThreadLocal，当前线程的事件集合）、mainThreadPoster（主线程的post）、backgroundPoster（后台线程的post）、asyncPoster（异步线程的post）、subscriberMethodFinder（获取订阅者中的事件）
SubscriberMethod	订阅方法的类，包含Method、ThreadMode、priority等配置属性
Subscription	订阅者类，包含subscriber的Object实例、subscriberMethod
PostingThreadState	存储当前线程的事件集合
SubscriberMethodFinder	用于获取订阅中的定义的事件接收方法
PendingPost	subscription与event的包装类，内部维护一个pendingPostPool，当池中有PendingPost实例，会进行复用
PendingPostQueue	内部维护了一个head、tail的PendingPost实例，提供enqueue及poll操作
HandlerPoster	用于处理主线程的事件执行
BackgroundPoster	用于处理后台线程的事件执行
AsyncPoster	用于执行异步线程的事件执行

代码执行流程

注册-register

注册主要是通过反射获取订阅者中定义的事件方法集合，将订阅者和事件集合加入对应的Map，然后会判断是否支持粘性事件，将之前发送的粘性事件缓存发送给订阅者。

1、 源码实现

public void register(Object subscriber) {
        //获取注册的Object的Class
        Class subscriberClass = subscriber.getClass();
        //通过subscriberMethodFinder获取该Object中所有的订阅方法（SubscriberMethod集合）
        List subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);
        synchronized (this) {
            //遍历事件集合
            for (SubscriberMethod subscriberMethod : subscriberMethods) {
                subscribe(subscriber, subscriberMethod);
            }
        }
    }
    
  private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) {
        Class eventType = subscriberMethod.eventType;
        //生成Subscription对象（SubscriberMethod的包装类）
        Subscription newSubscription = new Subscription(subscriber, subscriberMethod);
        //获取subscriptionsByEventType集合（key为事情，value为订阅集合）
        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;
            }
        }
        //获取typesBySubscriber集合（key为订阅者，value为事件集合）
        List> subscribedEvents = typesBySubscriber.get(subscriber);
        if (subscribedEvents == null) {
            subscribedEvents = new ArrayList<>();
            typesBySubscriber.put(subscriber, subscribedEvents);
        }
        //将所有的事件，根据订阅者key加入到事件集合中
        subscribedEvents.add(eventType);

        //事件方法是否支持（粘性事情）
        if (subscriberMethod.sticky) {
            //事件方法是否支持（继承事件）
            if (eventInheritance) {
            
                //遍历stickyEvents，找出所有继承于事件的父事件
                Set, Object>> entries = stickyEvents.entrySet();
                for (Map.Entry, Object> entry : entries) {
                    Class candidateEventType = entry.getKey();
                    if (eventType.isAssignableFrom(candidateEventType)) {
                        Object stickyEvent = entry.getValue();
                        //给订阅者发送之前缓存的粘性事件
                        checkPostStickyEventToSubscription(newSubscription, stickyEvent);
                    }
                }
            } else {
                Object stickyEvent = stickyEvents.get(eventType);
                        //给订阅者发送之前缓存的粘性事件
                checkPostStickyEventToSubscription(newSubscription, stickyEvent);
            }
        }
    }

2、 流程图

image

发送-post

1、 源码实现

 public void post(Object event) {
        //获取当前线程的PostingThreadState
        PostingThreadState postingState = currentPostingThreadState.get();
        //获取事件队列postingState.eventQueue
        List