EventBus源码研读(上)

摘要

本文原创，转载请注明地址： http://kymjs.com/code/2015/12/12/01

本文总共分三部分，从源码角度分析了 EventBus 库。以及介绍了其内部实现注册、发送、响应、取消注册的原理。

• 基础用法
  • 注册订阅者
  • 事件发送
• 进入源码世界
  • 入口类EventBus类
  • EventBusBuilder类
  • 三个Poster类
• Poster工作原理

基础用法

用法与广播相同,且比广播更简单:

注册订阅者

首先你需要注册一个 事件订阅者 ,为了方便理解你可以把他当成广播的 广播接收者 你可以在任何一个类中使用如下代码注册以及解除注册

//把当前类注册为订阅者(接收者) EventBus.getDefault().register(this);  //解除注册当前类(同广播一样,一定要调用,否则会内存泄露) EventBus.getDefault().unregister(this);

注册了订阅者以后,我们需要创建一个回调方法 onEvent ,当我们订阅的事件发送的时候就会回调它

//其实命名不一定必须是onEvent(),但那属于高级用法了,这里我们只说最简单的 public void onEvent(Object event) {}

事件发送

/**  * 这里的event类型必须和上面我们onEvent()方法的参数类型一致  * (子父类关系也不行,必须是相同类型，原因我们下面看源码)  */ EventBus.getDefault().post(event);

至此,EventBus就可以正常工作了.

进入源码世界

入口类EventBus类

我们从使用的流程来,首先看 EventBus#getDefault()

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

只是简单的维护单例,调用构造方法,再看构造方法,调用重载的构造方法,重载的构造方法又需要一个 EventBusBuilder 对象

public EventBus() {     this(DEFAULT_BUILDER); }  EventBus(EventBusBuilder builder) { }

EventBusBuilder类

看名字就知道,这个类是用来创建 EventBus 对象的.

Builder类提供了这么多个可选的配置属性,这里变量含义大家直接看我的注释,就不多作解释了我们主要来看最终的建造方法

/**  * 根据参数创建对象,并赋值给EventBus.defaultInstance, 必须在默认的eventbus对象使用以前调用  *  * @throws EventBusException if there's already a default EventBus instance in place  */ public EventBus installDefaultEventBus() {     synchronized (EventBus.class) {         if (EventBus.defaultInstance != null) {             throw new EventBusException("Default instance already exists." +                     " It may be only set once before it's used the first time to ensure " +                     "consistent behavior.");         }         EventBus.defaultInstance = build();         return EventBus.defaultInstance;     } }  /**  * 根据参数创建对象  */ public EventBus build() {     return new EventBus(this); }

再回到我们的 EventBus 构造方法,根据提供的建造者初始化了一大堆属性

我们继续看这些初始化的字段.

三个Poster类

先是一大堆Map,看不懂,跳过去,我们先来看这三个Poster，需要说明的一点就是：Poster只负责处理粘滞事件，原因我们之后看代码。

private final HandlerPoster mainThreadPoster; //前台发送者 private final BackgroundPoster backgroundPoster; //后台发送者 private final AsyncPoster asyncPoster;   //后台发送者(只让队列第一个待订阅者去响应)

每个Poster中都有一个发送任务队列, PendingPostQueue queue;

进到队列里面再看 定义了两个节点,从字面上理解就是队列的头节点和尾节点

private PendingPost head; //待发送对象队列头节点 private PendingPost tail;//待发送对象队列尾节点

再看这个PendingPost类的实现:

//单例池,复用对象 private final static List<PendingPost> pendingPostPool = new ArrayList<PendingPost>();  Object event; //事件类型 Subscription subscription; //订阅者 PendingPost next; //队列下一个待发送对象

/**  * 首先检查复用池中是否有可用,如果有则返回复用,否则返回一个新的  *  * @param subscription 订阅者  * @param event        订阅事件  * @return 待发送对象  */ static PendingPost obtainPendingPost(Subscription subscription, Object event) {     synchronized (pendingPostPool) {         int size = pendingPostPool.size();         if (size > 0) {             PendingPost pendingPost = pendingPostPool.remove(size - 1);             pendingPost.event = event;             pendingPost.subscription = subscription;             pendingPost.next = null;             return pendingPost;         }     }     return new PendingPost(event, subscription); }

/**  * 回收一个待发送对象,并加入复用池  *  * @param pendingPost 待回收的待发送对象  */ static void releasePendingPost(PendingPost pendingPost) {     pendingPost.event = null;     pendingPost.subscription = null;     pendingPost.next = null;     synchronized (pendingPostPool) {         // 防止池无限增长         if (pendingPostPool.size() < 10000) {             pendingPostPool.add(pendingPost);         }     } }

PendingPost的代码我们就看完了，再回到上一级，队列的设计：

接着是 PendingPostQueue 的入队方法

synchronized void enqueue(PendingPost pendingPost) {  ...     if (tail != null) {         tail.next = pendingPost;         tail = pendingPost;     } else if (head == null) {         head = tail = pendingPost;     }      ... }

synchronized PendingPost poll() {     PendingPost pendingPost = head;     if (head != null) {         head = head.next;         if (head == null) {             tail = null;         }     }     return pendingPost; }

再回到上一级，接着是 HandlerPoster 的入队方法 enqueue() ,

/**  * @param subscription 订阅者  * @param event        订阅事件  */ void enqueue(Subscription subscription, Object event) {     PendingPost pendingPost = PendingPost.obtainPendingPost(subscription, event);     synchronized (this) {         queue.enqueue(pendingPost);         if (!handlerActive) {             handlerActive = true;             if (!sendMessage(obtainMessage())) {                 throw new EventBusException("Could not send handler message");             }         }     } }

@Override public void handleMessage(Message msg) {     boolean rescheduled = false;     try {         long started = SystemClock.uptimeMillis();         while (true) {             PendingPost pendingPost = queue.poll();             if (pendingPost == null) {                 synchronized (this) {                     // 双重校验,类似单例中的实现                     pendingPost = queue.poll();                     if (pendingPost == null) {                         handlerActive = false;                         return;                     }                 }             }             //如果订阅者没有取消注册,则分发消息             eventBus.invokeSubscriber(pendingPost);                          //如果在一定时间内仍然没有发完队列中所有的待发送者,则退出             long timeInMethod = SystemClock.uptimeMillis() - started;             if (timeInMethod >= maxMillisInsideHandleMessage) {                 if (!sendMessage(obtainMessage())) {                     throw new EventBusException("Could not send handler message");                 }                 rescheduled = true;                 return;             }         }     } finally {         handlerActive = rescheduled;     } }

handleMessage() 不停的在待发送队列queue中去取消息。 需要说明的是在循环之外有个临时 boolean 变量 rescheduled ,最后是通过这个值去修改了 handlerActive 。而 handlerActive 是用来判断当前queue中是否有正在发送对象的任务，看到上面的入队方法 enqueue() ,如果已经有任务在跑着了，就不需要再去sendMessage()唤起我们的 handleMessage()

最终通过 eventBus 对象的 invokeSubscriber() 最终发送出去，并回收这个 pendingPost ，让注册了的订阅者去响应(相当于回调),至于这个发送方法,我们之后再看。

看完了HandlePoster类,另外两个异步的发送者实现代码也差不多,唯一的区别就是另外两个是工作在异步,实现的Runnable接口,大家自己类比,这里就不帖代码了.

Poster工作原理

最后我们再来回顾一下 Poster 、 PendingPostQueue 、 PendingPost 这三个类，再看看下面这张图，是不是有种似曾相识的感觉。

啊哈，那是 Handle 、 Message 、 Looper 的工作原理，再看看Poster的