EventBus源码分析(四): 发送Event和响应注册的回调方法

前言#

今天是EventBus的最后一篇了,之前我们已经理解了EventBus的编译过程,以及如何注册和解绑Event,发送Event其实是在注册成功的基础上遍历的你需要的类和方法,相对于之前的几篇,今天的内容会相对轻松很多。

正文#

发送Event有两种,一种是普通的Event,一种是StickyEvent。我们先看普通的Event,打开post方法:

/**
     *  发送Event
     * */
    public void post(Object event) {
        // 通过工厂类,获取一个执行状态类
        // 每一个线程对应一个
        PostingThreadState postingState = currentPostingThreadState.get();
        // 把Event加入到队列中
        List<Object> eventQueue = postingState.eventQueue;
        eventQueue.add(event);

        // 如果这个信息类并没有在执行
        if (!postingState.isPosting) {
            // 是否是主线程
            postingState.isMainThread = Looper.getMainLooper() == Looper.myLooper();
            // 改变执行状态
            postingState.isPosting = true;
            // 判断执行是否被取消了
            if (postingState.canceled) {
                throw new EventBusException("Internal error. Abort state was not reset");
            }
            // 开始循环发送Event
            try {
                while (!eventQueue.isEmpty()) {
                    // 别忘了ArrayList的remove会返回remove的对象
                    // 执行队列中第一个Event
                    postSingleEvent(eventQueue.remove(0), postingState);
                }
            } finally {
                // 执行结束之后,要重置状态类的属性
                postingState.isPosting = false;
                postingState.isMainThread = false;
            }
        }
    }

先从ThreadLocal中得到当前执行线程中对应的执行状态对象,ThreadLocal可以为不同线程创建不同的对象,并且这个对象是可以复用的,防止了创建短生命周期的对象,减轻了内存的压力。

之后把回调的Event类型放入到这个对象中,设置了一些属性,例如是否是主线程,是否在执行中等等。最关键的部分就是这个while循环,所以我们接下来要看的是postSingleEvent(eventQueue.remove(0), postingState)这个方法:

/**
     * 执行单个Event
     * */
    private void postSingleEvent(Object event, PostingThreadState postingState) throws Error {
        // 得到Event的Class
        Class<?> eventClass = event.getClass();
        boolean subscriptionFound = false;
        // 如果Event是支持继承的
        if (eventInheritance) {
            // 找到使用Event的父类
            List<Class<?>> eventTypes = lookupAllEventTypes(eventClass);
            int countTypes = eventTypes.size();
            for (int h = 0; h < countTypes; h++) {
                Class<?> clazz = eventTypes.get(h);
                // 开始发送Event给当前的Class
                // 每一次都要跟下一次的结果进行 或操作,也就是只要有一个Class的Event没找到,都会返回false
                subscriptionFound |= postSingleEventForEventType(event, postingState, clazz);
            }
        } else {
            // 开始发送Event给当前的Class
            subscriptionFound = postSingleEventForEventType(event, postingState, eventClass);
        }
        //如果并没有找到这个Event绑定的信息
        if (!subscriptionFound) {
            // 是否打印log
            if (logNoSubscriberMessages) {
                Log.d(TAG, "No subscribers registered for event " + eventClass);
            }
            // 是否发送Event
            if (sendNoSubscriberEvent && eventClass != NoSubscriberEvent.class &&
                    eventClass != SubscriberExceptionEvent.class) {
                post(new NoSubscriberEvent(this, event));
            }
        }
    }

这个方法中,先判断是否支持Event继承,如果是支持的,要把这个当前Event的父类也要回调,例如MyEvent继承了SuperEvent,发送的MyEvent的同时也要发送SuperEvent,如果不支持的话只要回调当前这个类型就可以了。

看来这里还没有回调绑定的方法,所以要查看postSingleEventForEventType(event, postingState, clazz)中的代码:

/**
     *  根据Event的类型发送给对一个的Class
     * */
    private boolean postSingleEventForEventType(Object event, PostingThreadState postingState, Class<?> eventClass) {
        CopyOnWriteArrayList<Subscription> subscriptions;
        synchronized (this) {
            // 得到和Event对应的类和方法
            subscriptions = subscriptionsByEventType.get(eventClass);
        }
        // 判空
        if (subscriptions != null && !subscriptions.isEmpty()) {
            // 对列表循环
            for (Subscription subscription : subscriptions) {
                // 设置要执行的信息
                postingState.event = event;
                postingState.subscription = subscription;
                boolean aborted = false;
                try {
                    // 执行Class中被注解的方法
                    postToSubscription(subscription, event, postingState.isMainThread);
                    // 如果post被取消了,停止循环
                    aborted = postingState.canceled;
                } finally {
                    // 重置执行的信息
                    postingState.event = null;
                    postingState.subscription = null;
                    postingState.canceled = false;
                }
                if (aborted) {
                    break;
                }
            }
            return true;
        }
        return false;
    }

大家也应该看出来了,这个方法主要是对PostingThreadState在回调绑定方法的前后状态进行设置,核心方法是在postToSubscription(subscription, event, postingState.isMainThread)中:

/**
     * 根据不同的ThreadMode,回调被绑定的方法
     * */
    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);
        }
    }

这里我们终于看到了之前在Subscribe中设置的ThreadMode的作用,因为篇幅的问题,这里我简单的概括一下:

1、POSTING:表示的是直接在当前线程回调,和你发送Event时的线程是一样的,所以使用的时候要特别注意:别在子线程中更新UI。

2、MAIN:主线程中回调,如果当前不是主线程,就通过Handler机制在主线程调用,详细可以看HandlerPoster。

3、BACKGROUND:后台线程,也可以叫做非主线程。如果发送Event是在主线程,则会创建一个新的Runnable,在线程池中运行,如果发送Event在子线程,则会使用当前的线程。详细可以看BackgroundPoster。

4、ASYNC:异步线程,不管是在什么线程中发送Event,回调绑定的方法,都会新建Runnable,运行在线程池中。详细可以看AsyncPoster。

不管进行了什么样的判断,最终都会调用invokeSubscriber(subscription, event)方法:

/**
     * 通过反射的方法,调用被注解的方法
     * */
    void invokeSubscriber(Subscription subscription, Object event) {
        try {
            subscription.subscriberMethod.method.invoke(subscription.subscriber, event);
        } catch (InvocationTargetException e) {
            // 处理反射调用出现的异常
            handleSubscriberException(subscription, event, e.getCause());
        } catch (IllegalAccessException e) {
            throw new IllegalStateException("Unexpected exception", e);
        }
    }

最后是通过反射,调用了绑定的Class的被注解的方法,到此圆满结束。

postStickyEvent的事就不讲了吗?当然不会,因为你懂了普通Event,就自然明白了StickyEvent:

/**
     * 发送StickyEvent
     * */
    public void postSticky(Object event) {
        // 这个把Event进行了缓存
        synchronized (stickyEvents) {
            stickyEvents.put(event.getClass(), event);
        }
        // Should be posted after it is putted, in case the subscriber wants to remove immediately
        //  和post的执行是完全一样的
        post(event);
    }

因为是StickyEvent的缓存是Map类型,所以先添加或者是覆盖相同Event的缓存,这样下次谁绑定StickyEvent就会得到最近的结果。之后调用了我们刚刚分析过的post(Event)。

总结#

到此为止,我们的EventBus的源码解析就结束了,为什么好像看上去很简单的观察者模式,怎么感觉变得复杂了呢?跟我们之前的demo比,有什么优势呢?

我们最后来进行一个总结:

1、通过注解,可以更加灵活直观的设置Event回调的优先级,线程,是否是StickyEvent,否则我们需要在注册或者其他地方,增加属性和参数,并且和方法分离开来,维护起来会比较麻烦。

2、增加了不同线程的回调,让开发者更明确自己在回调将要做什么,例如使用了MAIN,那我能猜测,他肯定是要更新UI。

3、StickyEvent的使用丰富了使用场景,解决了某些情况下,页面是一篇空白的尴尬。

应该说注解的使用,是整个EventBus的亮点,是他让EventBus变得灵活,让我们更加简便的配置每一个需要绑定的方法。

好了,有关EventBus的内容就到此结束了,还有什么问题,欢迎大家留言一起讨论。

添加了注释的EventBus源码地址

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,394评论 25 707
  • 博文出处:EventBus源码解析,欢迎大家关注我的博客,谢谢! 0001B 时近年末,但是也没闲着。最近正好在看...
    俞其荣阅读 1,294评论 1 16
  • EventBus源码分析(一) EventBus官方介绍为一个为Android系统优化的事件订阅总线,它不仅可以很...
    蕉下孤客阅读 3,972评论 4 42
  • 对于Android开发老司机来说肯定不会陌生,它是一个基于观察者模式的事件发布/订阅框架,开发者可以通过极少的代码...
    飞扬小米阅读 1,467评论 0 50
  • 气温渐渐降低,临近冬天了吧。树叶哗啦啦的响声小了下来,那些光秃秃的枝丫刺破天空,留下枝丫间的斑驳和萧索的孤独。雨声...
    山有墓阅读 210评论 0 0