EventBus源码阅读和学习笔记

概述

目前项目当中经常会用到eventbus 来发送消息，所以抽时间阅读了一下eventbus的源码，也在网上看了一些关于eventbus的源码解析的问题，所以自己也做一下笔记，理一理自己的思路，目前eventbus最新的版本是3.0，新增了注解等功能。eventbus 是android的一个事件 发布/订阅框架 ，通过解耦 分发者和订阅者来简化事件的传递.

使用

我们在应用当中使用非常的简单，就从我们使用开始往下看，由于eventbus是一个单例所以直接**EventBus.getDefault() **获取实例，获取到实例后就可以开始注册和使用，并将自己这个类传递进去也就是this，因为this在后面通过java的反射机制会用到。

image.png

EventBus.getDefault().register(this);
....
@Subscribe(sticky = true)
  public void onDeviceConnectStateChange(DeviceConnectStateEvent event) {
      logger.debug("onDeviceConnectStateChange:" + event.isConnected);
      setMiniPlayerViewVisibility(event.isConnected ? View.VISIBLE : View.GONE);
      if (event.isConnected) {
          mMiniPlayerView.refresh();
      }
  }
....
@Subscribe(sticky = true)
  public void onWifiStateChange(WifiStateChangeEvent event) {
      if (!event.isConnected) {
          setMiniPlayerViewVisibility(View.GONE);
      }
  }

...
EventBus.getDefault().unregister(this);

发送消息

// MainActivityFragmentEvent 是一个类，需要发送的消息数据自己封装在里面了。
MainActivityFragmentEvent message = new MainActivityFragmentEvent(FragmentFactory.TAG_MAIN, FragmentFactory.TAG_SEARCH, true);
EventBus.getDefault().post(message);

EventBus 事件回调方法线程(Delivery Thread)
EventBus有四种线程模式 , 可以通过@Subscribe()注解的threadMode参数进行指定

• ThreadMode:POSTING:
  POSTING是 threadMode的默认参数,如果不设置该参数就是POSTING模式. 在这种模式下接收事件的方法和发布消息的方法运行在同一个线程中.
• ThreadMode:MAIN:
  在 MAIN 模式下事件接收方法将会运行在主线程中(有时也称为UI线程). 如果发布事件的线程是主线程那么事件就会直接发布给订阅者,不会进行线程切换, 也就相当于使用了POSTING模式.
• ThreadMode:BACKGROUND:
  事件接收方法运行在一个后台线程，但是事件并不并发。
  如果发布事件本身就在后台线程中,那么事件接收方法就运行在这个线程中,不在另外开启新的线程.
  如果发布事件在主线程中,那么EventBus会开一个后台线程(只有一个)然后在该线程中依次处理所有事件.
• ThreadMode:ASYNC:
  在ASYNC模式下事件接收方法总是运行在一个发布事件线程和主线程之外独立的线程中,发布事件不必依赖订阅事件处理结果. 因此此模式适合于在事件处理中有比较耗时的操作的情况.为了避免同一时间有过多的运行线程.EventBus使用线程池和事件处理完成通知来限制最大的线程并发数.

粘性事件(Stick Events)

在EventBus的基本使用中我们说过那种模式必须要先订阅事件然后再发布事件. 这次我们来尝试一下EventBus另一种用法 粘性事件,在这种模式允许先发布事件再订阅事件 . EventBus会将粘性事件保存在内存中然后发送给订阅者,订阅者也可以主动查询粘性事件.

public void sendStickyEvent(View view) {
  EventBus.getDefault().postSticky(new EventBusStickyMsg("我是Sticky消息"));
}
//注册
 EventBus.getDefault().register(EventBusSendActivity.this);
//解除注册
@Override
protected void onDestroy() {
    super.onDestroy();
    // 移除所有的粘性事件.
    EventBus.getDefault().removeAllStickyEvents();
    // 解注册
    EventBus.getDefault().unregister(EventBusSendActivity.this);
}

源码解析

先看看getDefault里面是怎么处理的吧

    /** Convenience singleton for apps using a process-wide EventBus instance. */
    public static EventBus getDefault() {
        if (defaultInstance == null) {
            synchronized (EventBus.class) {
                if (defaultInstance == null) {
                    defaultInstance = new EventBus();
                }
            }
        }
        return defaultInstance;
    }

很正常的单例实例化过程，synchronized 防止多线程同时访问。new EventBus() 是真正的构造方法里面

private static final EventBusBuilder DEFAULT_BUILDER = new EventBusBuilder();
public EventBus() {  
  this(DEFAULT_BUILDER);
}

EventBus(EventBusBuilder builder) {
       subscriptionsByEventType = new HashMap<>();
        typesBySubscriber = new HashMap<>();
        stickyEvents = new ConcurrentHashMap<>();
        mainThreadPoster = new HandlerPoster(this, Looper.getMainLooper(), 10);
        backgroundPoster = new BackgroundPoster(this);
        asyncPoster = new AsyncPoster(this);
        indexCount = builder.subscriberInfoIndexes != null ? builder.subscriberInfoIndexes.size() : 0;
        subscriberMethodFinder = new SubscriberMethodFinder(builder.subscriberInfoIndexes,
                builder.strictMethodVerification, builder.ignoreGeneratedIndex);
        logSubscriberExceptions = builder.logSubscriberExceptions;
        logNoSubscriberMessages = builder.logNoSubscriberMessages;
        sendSubscriberExceptionEvent = builder.sendSubscriberExceptionEvent;
        sendNoSubscriberEvent = builder.sendNoSubscriberEvent;
        throwSubscriberException = builder.throwSubscriberException;
        eventInheritance = builder.eventInheritance;
        executorService = builder.executorService;
    }

• subscriptionsByEventType: 看变量英文名字也应该可以猜到这个集合的意思Map, CopyOnWriteArrayList> subscriptionsByEventType 一个Map表，key 为订阅的事件（eventType 就是处理消息方法的那个参数，比如我们上面DeviceConnectStateEvent或WifiStateChangeEvent），类型是class，value为定义了这个事件的所有订阅者的集合。subscriptionsByEventType.put(eventType, subscriptions);
• typesBySubscriber : Map>> typesBySubscriber; key 订阅者对象，values 这个订阅对象订阅的消息集合。
• stickyEvents:黏性事件，之前使用过stickybroadcast的应该就比价熟悉，这类的事件消息，只要你订阅就算你定义在消息分发之后，也会收到消息， Map, Object> stickyEvents;key 黏性事件的类对象，黏性事件消息。
• //事件主线程处理 mainThreadPoster = new HandlerPoster(this, Looper.getMainLooper(), 10);
  //事件 Background 处理 backgroundPoster = new BackgroundPoster(this);
  //事件异步线程处理 asyncPoster = new AsyncPoster(this);
  上面这几个方法是后面我们post 消息时，跟进ThreadMode 的类型来觉得在哪个地方通知订阅者。

构造函数里面做了很多初始化各种参数的工作，然后我们走到register方法里面去

/**
     * Registers the given subscriber to receive events. Subscribers must call {@link #unregister(Object)} once they
     * are no longer interested in receiving events.
     * 

     * Subscribers have event handling methods that must be annotated by {@link Subscribe}.
     * The {@link Subscribe} annotation also allows configuration like {@link
     * ThreadMode} and priority.
     */
    public void register(Object subscriber) {  //传进来的参数就是需要订阅消息的那个class
        Class subscriberClass = subscriber.getClass();
      //查找注册的这个类当中有多少个订阅方法并存进list列表当中 
        List subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);
        synchronized (this) {
            for (SubscriberMethod subscriberMethod : subscriberMethods) {
                //  分别订阅这个类当中的方法。
                subscribe(subscriber, subscriberMethod);
            }
        }
    }

下面看看 是通过什么方式能够找到这个类里面有哪些订阅方法的，也就是subscriberMethodFinder.findSubscriberMethods(subscriberClass)的实现