Android知识体系之第三方框架EventBus

Android知识体系

使用

定义事件->注册订阅->发布事件 ->处理事件

1、定义事件，其实就是一个普通的实体类

class EventTest {
    private String url,name;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getUrl() {
        return url;
    }
    public void setUrl(String url) {
        this.url = url;
    }
}

2、在Activity的onCreate和onDestroy里面分贝注册监听和反注册监听。

 @Override
protected void onCreate(Bundle savedInstanceState) {
    ...
    ...
    //注册监听
    EventBus.getDefault().register(this);
}

@Override
protected void onDestroy() {
    super.onDestroy();
    //反注册
    EventBus.getDefault().unregister(this);
}

3、在另一个Activity或者数据处理层里面 发布事件。

EventTest event = new EventTest();
event.setName("111");
event.setUrl("www.baidu.com");
EventBus.getDefault().post(event);

4、在之前注册的Activity里面@Subscribe注解标记的方法，会被调用。

@Subscribe(threadMode = ThreadMode.POSTING, priority = 0, sticky = true)
public void onEvent(EventTest event) {
    String name = event.getName();
    String url = event.getUrl();
    Log.e("点击",name+":"+url);
};

原理

核心架构

注册事件

• 根据反射找到所有的订阅方法，也就是@Subscribe修饰的方法
• 将订阅方法（其中一个）和订阅者封装组装成订阅组合，在后面发送事件时，是以它为基本事件发送单位。
• 把订阅组合存到subscriptionsByEventType和typesBySubscriber这两个Map里面
  
  • subscriptionsByEventType，如其名字是<EventType, List<订阅组合>>的集合，会根据EventType（就是订阅方法参数的class，例如例子中的EventTest）来找到该EventType对应的所有订阅组合
  • typesBySubscriber，是<订阅者, List<EventType>>的集合，可以根据订阅者找到该订阅者的所有EventType，主要用在反注册的时候。
• 粘性事件处理

发送事件

• 获取当前线程的发送状态
  当调用currentPostingThreadState.get()获取当前线程的PostingThreadState，如果获取不到，就会调用initialValue，并且set进去。

private final ThreadLocal<PostingThreadState> currentPostingThreadState = new ThreadLocal<PostingThreadState>() {
    @Override
    protected PostingThreadState initialValue() {
        return new PostingThreadState();
    }
};
/**
 * 线程的发送状态
 */
final static class PostingThreadState {
    final List<Object> eventQueue = new ArrayList<Object>();    //当前线程的事件队列
    boolean isPosting;
    boolean isMainThread;
    Subscription subscription;
    Object event;
    boolean canceled;
}

• 将当前事件添加到队列中
• 遍历队列中的事件挨个发送出去
  
  • 找到所有的订阅者
    根据EventType从subscriptionsByEventType中得到所有的订阅组合（订阅者+订阅方法：Subscription），
  • 在对应线程调用订阅方法
    我们在写订阅方法的时候，需要指定threadMode，因此我们在发送事件给订阅方法时，需要在指定的线程里调用它。

四种threadMode

/**
 * 根据 threadMode 发送事件给该订阅者
 * @param subscription
 * @param event
 * @param isMainThread
 */
private void postToSubscription(Subscription subscription, Object event, boolean isMainThread) {
    switch (subscription.subscriberMethod.threadMode) {
        case POSTING:       //直接在当前线程调用
            invokeSubscriber(subscription, event);
            break;
        case MAIN:      //订阅方法要在主线程执行
            if (isMainThread) {     //当前就在主线程，直接调用
                invokeSubscriber(subscription, event);
            } else {        //入队，handler 发送消息到主线程，在主线程中反射调用
                mainThreadPoster.enqueue(subscription, event);
            }
            break;
        case BACKGROUND:
            if (isMainThread) {     //放到子线程线程池中执行
                backgroundPoster.enqueue(subscription, event);
            } else {
                invokeSubscriber(subscription, event);
            }
            break;
        case ASYNC:     //直接在子线程中执行
            asyncPoster.enqueue(subscription, event);
            break;
        default:
            throw new IllegalStateException("Unknown thread mode: " + subscription.subscriberMethod.threadMode);
    }
}

• POSTING
  订阅方法要求被调用的线程和发送者在同一线程，直接使用反射调用订阅者的方法。
• MAIN
  
  • 当前线程为主线程，也是直接反射调用
  • 当前线程不是主线程，使用Handler发送到主线程，依然是反射调用，内部通过队列类管理多个发送事件
• BACKGROUND
  
  • 当前线程为主线程，放到后台线程处理，共用的后台线程，，内部通过队列类管理多个发送事件
  • 当前线程不为主线程，直接反射调用
• ASYNC
  起子线程来调用发送，多个发送事件，就会起多个子线程。

反注册事件

/**
 * 解除注册很简单，就从两个属性中移除当前类
 * @param subscriber
 */
public synchronized void unregister(Object subscriber) {
    List<Class<?>> subscribedTypes = typesBySubscriber.get(subscriber);
    if (subscribedTypes != null) {
        //找到这个类中所有的订阅方法，挨个取消注册
        for (Class<?> eventType : subscribedTypes) {
            unsubscribeByEventType(subscriber, eventType);
        }
        //移除这个订阅记录
        typesBySubscriber.remove(subscriber);
    } else {
        Log.w(TAG, "Subscriber to unregister was not registered before: " + subscriber.getClass());
    }
}
private void unsubscribeByEventType(Object subscriber, Class<?> eventType) {
    //获取订阅这个事件的订阅者列表
    List<Subscription> subscriptions = subscriptionsByEventType.get(eventType);
    if (subscriptions != null) {
        int size = subscriptions.size();    //只调用一次 subscriptions.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--;
            }
        }
    }
}

索引加速

在编译时apt插件通过EventBusAnnotationProcessor分析注解，并利用注解标识的相关类的信息去生成相关的类。

• 代码生成工具JavaPoet，square 开源的 Java 代码生成框架
• auto-service，Google 开源的注解注册处理器

小结

• EventBus 包含 register 和 unregister 两个方法用于标记当前 subscriber 是否需要接收消息，内部对应向 CopyOnWriteArrayList 添加和移除元素这两个操作
• 每当有 event 被 post 出来时，就需要根据 eventClass 对象找到所有所有声明了 @Subscribe 注解且对这种消息类型进行监听的方法，这些方法都是在 subscriber 进行 register 的时候，从 subscriber 中获取到的
• 从 subscriber 中获取所有监听方法的方式有两种。不管是通过什么方式进行获取，拿到所有方法后都会将 methods 按照消息类型 eventType 进行归类，方便后续遍历。
  
  • 第一种是在运行阶段通过反射来拿到，对应的是没有配置注解处理器的情况。
  • 第二种对应的是有配置注解处理器的情况，通过在编译阶段全局扫描 @Subscribe 注解并生成辅助文件，从而在 register 的时候省去效率低下的反射操作。
• 每当有消息被发送出来时，就根据 event 对应的 Class 对象找到相应的监听方法，然后通过反射的方式来回调方法。外部可以在初始化 EventBus 的时候选择是否要考虑 event 的继承关系，即在 event 被 Post 出来时，对 event 的父类型进行监听的方法是否需要被回调

参考

Android 主流开源库源码分析（一）- EventBus 源码详解
Android 主流开源库源码分析（二）- EventBus 自己实现一个

Android面试之EventBus原理分析
Android事件总线（二）EventBus3.0源码解析
老司机教你 “飙” EventBus 3
Android 框架学习2：源码分析 EventBus 3.0 如何实现事件总线