EventBus源码分析（三）

EventBus源码分析（三）

在前面的两篇文章中分别对EventBus中的构建，分发事件以及注册方法的查询做了分析，本篇文章是最后一部分，主要针对EventBus对于注册方法的调用作学习了解，前面两篇文章的链接如下：
EventBus源码分析（一）
EventBus源码分析（二）

EventBus方法调用机制需要从EventBus的postToSubscription方法开始，该方法在第一篇文章中也曾分析过，其代码如下：

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 {
                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);
    }
}

这个方法的代码也可以清晰地说明了在不同的threadMode情况下，注册方法在不同线程调用的情况。
在理解注册方法在哪个线程被调用之前需要首先明确postToSubscription()方法在哪个线程被调用，该方法是由EventBus对象的post()方法经过一系列方法调用的，所以它运行在用户发送事件的线程中，参数isMainThread表示该运行线程是否为主线程，下面四种threadMode中，注册方法被调用的线程分别为：

  1. POSTING：最简单的一种模式，即直接在事件发送的线程中调用注册方法；
  2. MAIN：在主线程中调用注册方法，如果事件发送线程不是主线程，则由mainThreadPoster将方法调用派送到主线程中调用，其实就是使用的Handler机制，后面再做分析；
  3. BACKGROUND：在后台线程中调用，如果事件发送不是在主线程，则注册方法则直接在该线程中被调用，如果在主线程发送事件，则注册方法由backgroundPoster派发到工作线程中调用；
  4. ASYNC：直接由asyncPoster派发到工作线程中调用，至于它与BACKGROUND的区别，后面会根据源码做分析。

所以从该方法中可以看出，在切换不同线程调用注册方法，是通过三个Poster完成的，下面分别对它们的源码做分析。

1. HandlerPoster

首先mainThreadPoster的类型为HandlerPoster，从名字可以看出它应该与Handler有关。在android的编程中，如果一些耗时操作的结果需要更新UI，那么需要通过定义Handler的形式，将结果加入到主线程的消息队列，然后由自定义在主线程的Handler对消息做处理。那么这里的原理也是一致的。首先看HandlerPoster的代码：

final class HandlerPoster extends Handler {

    private final PendingPostQueue queue;
    private final int maxMillisInsideHandleMessage;
    private final EventBus eventBus;
    private boolean handlerActive;

    HandlerPoster(EventBus eventBus, Looper looper, int maxMillisInsideHandleMessage) {
        super(looper);
        this.eventBus = eventBus;
        this.maxMillisInsideHandleMessage = maxMillisInsideHandleMessage;
        queue = new PendingPostQueue();
    }
    ...
}

可以看到HandlerPoster是继承自Handler，那么它则是根据构造器中传入的Looper对象，在handleMessage()方法中处理对应线程中消息队列的消息，那么我们再看在EventBus对象初始化时，mainThreadPoster初始化是否为主线程的Looper, EventBus的构造器中的部分代码为：

mainThreadPoster = new HandlerPoster(this, Looper.getMainLooper(), 10);

Looper.getMainLooper()说明了mainThreadPoster的handleMessage方法是在主线程中被调用，就可以实现将注册方法派发到主线程中调用了。其他参数后面部分一一分析。
首先来看PendingPostQueue这个明显是一个队列，其代码有兴趣的可以自行查看，它是自定义的队列，没有实现Java定义的Queue接口，这里只是简单定义了内部的队列数据结构以及入队和出队方法，只不过有一个与时间相关的出队方法，后面用到时会提到。PendingPostQueue内部的队列结构中的元素即为PendingPost，它封装了一次注册方法调用所需要的注册信息和事件类型，即Subscription类型对象和事件对象。类的代码很简单，不再贴出，但是PendingPost中有一个对象的缓存池，最多可以保存10000个PendingPost对象，避免了对象的创建和回收。有兴趣的可以查看源码。

下面看HandlerPoster的入队方法：

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");
            }
        }
    }
}

首先根据注册信息和事件对象构建一个PendingPost加入队列，然后通过发送消息通知Handler自身调用handleMessage()方法，这里的handlerActive是一个标志位，标志当前是否正在执行处理PendingPostQueue队列中的PendingPost，也就是正在调用队列中的注册方法。下面为handleMessage()方法：

@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) {
                    // Check again, this time in synchronized
                    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;
    }
}

这里代码的逻辑就是循环遍历队列，通过eventBus.invokeSubscriber(pendingPost)方法执行注册方法，invokeSubscriber()方法在第一篇文章中已经分析过。两次判断pendingPost是否为空是处理多线程的同步问题，这里与单例模式是同样的道理。不过这里需要注意的是EventBus为HandlerPoster处理调用注册方法设定了时间上限，也就是构造器中初始化的maxMillisInsideHandleMessage，在EventBus中初始化mainThreadPost时为其指定了10ms, 也就是while循环超过10ms之后会退出handleMessage方法，并将handleActive置位true，并再次发送消息，使得该handler再次调用handleMessage()方法，继续处理队列中的注册信息，这是为了避免队列过长是，while循环阻塞主线程造成卡顿。
以上就是HandlerPoster的全部代码，十分简短，通过Handler的方式将注册方法的调用派发到其他线程，在EventBus中只是将其用于在主线程中调用注册方法的情况。

2. BackgroundPoster

下面为BackgroundPoster的源码：

final class BackgroundPoster implements Runnable {

    private final PendingPostQueue queue;
    private final EventBus eventBus;

    private volatile boolean executorRunning;

    BackgroundPoster(EventBus eventBus) {
        this.eventBus = eventBus;
        queue = new PendingPostQueue();
    }
    ...
}

首先BackgroundPoster是继承自Runnable，是一个可执行的任务，这里看到BackgroundPoster中也有队列和标志位，其执行逻辑与HandlerPoster应该极为相似，下面看一下它的入队方法：

public void enqueue(Subscription subscription, Object event) {
    PendingPost pendingPost = PendingPost.obtainPendingPost(subscription, event);
    synchronized (this) {
        queue.enqueue(pendingPost);
        if (!executorRunning) {
            executorRunning = true;
            eventBus.getExecutorService().execute(this);
        }
    }
}

代码逻辑很简单，构建PendingPost，并在同步块中将该对象入队，然后调用线程池中的线程执行该Runnable，即在其他线程中执行run方法，进而调用注册方法，下面看run方法代码：

@Override
public void run() {
    try {
        try {
            while (true) {
                PendingPost pendingPost = queue.poll(1000);
                if (pendingPost == null) {
                    synchronized (this) {
                        // Check again, this time in synchronized
                        pendingPost = queue.poll();
                        if (pendingPost == null) {
                            executorRunning = false;
                            return;
                        }
                    }
                }
                eventBus.invokeSubscriber(pendingPost);
            }
        } catch (InterruptedException e) {
            Log.w("Event", Thread.currentThread().getName() + " was interruppted", e);
        }
    } finally {
        executorRunning = false;
    }
}

这里的while循环，除了没有设定时间上限之外，几乎与HandlerPoster中handleMessage方法中的处理逻辑完全一致，只不过标志位改成了executorRunning，其作用也几乎是一致的。但是这里需要注意有另外一个与时间有关的方法，即queue.poll(1000)，这里有一个等待过程，即从队列中取PendingPost对象时，如果没有PendingPost会等待1000毫秒，其代码如下：

synchronized PendingPost poll(int maxMillisToWait) throws InterruptedException {
    if (head == null) {
        wait(maxMillisToWait);
    }
    return poll();
}

这里是典型的生产者和消费者模型，并且设定了时间上限。因此也就说明了BackgroundPoster会将1000毫秒以内入队的注册信息在同一个线程中调用，这一点也是与AsyncPoster最重要的区别。BackgroundPoster的代码也介绍完了，同样十分简单，下面继续分析AsyncPoster中的代码，下面你会看到，其实现更简单。

3. AsyncPoster

由于AsyncPoster的代码实现比较简单，这里一次性全部贴出它的代码：

class AsyncPoster implements Runnable {

    private final PendingPostQueue queue;
    private final EventBus eventBus;

    AsyncPoster(EventBus eventBus) {
        this.eventBus = eventBus;
        queue = new PendingPostQueue();
    }

    public void enqueue(Subscription subscription, Object event) {
        PendingPost pendingPost = PendingPost.obtainPendingPost(subscription, event);
        queue.enqueue(pendingPost);
        eventBus.getExecutorService().execute(this);
    }

    @Override
    public void run() {
        PendingPost pendingPost = queue.poll();
        if(pendingPost == null) {
            throw new IllegalStateException("No pending post available");
        }
        eventBus.invokeSubscriber(pendingPost);
    }

}

AsyncPoster同样是继承自Runnable，但是可以看到这里没有了标志位和while循环，入队的逻辑就是构建PendingPost，然后加入队列，这里注意enqueue是同步的方法，不用担心同步问题，然后调用线程池的线程执行该Runnable，run方法的逻辑就是取出队列的pendingPost, 并执行invokeSubscriber方法，由于是入队一次调用一次execute方法，所以正常情况下队列中不会取不出pendingPost, 也不会剩余pendingPost。
这里AsyncPoster更为简单，但是重点是需要思考一下它与BackgroundPoster的区别，前面也提到过BackgroundPoster设定一个时间上限，并且在该段时间内入队的注册信息会在同一个线程中调用，而AsyncPoster则是完全异步的调用。也就是说BackgroundPoster会尽可能在同一线程中调用注册方法，但不保证，可是它保证有一定的顺序，也就是注册信息收集的顺序，而AsyncPoster对注册方法的调用则是完全异步，不确定在哪个线程，也不确定顺序。

至此，对于注册方法调用的线程调度分析源码已经分析完了，总结起来只是三个不同的Poster, HandlerPoster是继承自Handler, 通过handler机制可以将线程调度分派给主线程，而BackgroundPoster和AsyncPoster则是继承自Runnable，覆写run方法定义调用注册方法的任务，并有线程池负责调度启动该任务，进而完成对注册方法的调用。

通过三篇文章，对EventBus的源码大致分析了一遍，下图对分析的流程大致做一个总结，EventBus主要负责不同对象间传递消息，并且可以很方便地切换线程调用注册方法，EventBus的工作机制大概可以分为图中三部分，即注册，发送和调度三个步骤，其中构建部分主要是几个数据结构用来记录信息，后面三个则是三个步骤，图中总结了其中最主要的方法调用。

eventbus.png

后记

EventBus可以很方便地在不同对象之间传递消息或者对象，并且很容易做到线程的切换，但是它也有它的局限性，就是不适用于多进程的应用，在多进程的情况下，EventBus中无论是单例还是同步方法以及同步块都会失效，所以便会失去了传递消息的作用。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,271评论 5赞 476
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,275评论 2赞 380
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,151评论 0赞 336
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,550评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,553评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,559评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,924评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,580评论 0赞 257
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,826评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2赞 320
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,363评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,940评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2赞 342

推荐阅读更多精彩内容