源码分析 - EventBus

1、使用

event:

public class Event {

  public String message;
}

Subscriber:

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        EventBus.getDefault().register(this);
//      EventBus bus = EventBus.builder().logNoSubscriberMessages(true).build();
//      bus.register(this);

        findViewById(R.id.txv).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                startActivity(new Intent(MainActivity.this,SecondActivity.class));
            }
        });
    }

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

    @Subscribe(threadMode = ThreadMode.MAIN, sticky = true,priority = 0)
    public void onGetMessage(Event event){
        Log.e("tbg",event.message);
    }

    @Subscribe(threadMode = ThreadMode.MAIN, sticky = true,priority = 1)
    public void onGetMessage2(Event event){
        Log.e("tbg2",event.message);
    }
}

Publisher:

public class SecondActivity extends Activity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        findViewById(R.id.txv).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Event event = new Event();
                event.message = "dunzhixuan";
                EventBus.getDefault().postSticky(event);
                EventBus.getDefault().post(event);
            }
        });
    }
}

EventBus采用的是观察者模式:如技术图所示
EventBus中的三个角色

Event:事件,它可以是任意类型,EventBus会根据事件类型进行全局的通知。
Subscriber:事件订阅者,在EventBus 3.0之前我们必须定义以onEvent开头的那几个方法,分别是onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync,而在3.0之后事件处理的方法名可以随意取,不过需要加上注解@subscribe,并且指定线程模型,默认是POSTING。
Publisher:事件的发布者,可以在任意线程里发布事件。一般情况下,使用EventBus.getDefault()就可以得到一个EventBus对象,然后再调用post(Object)方法即可。

Eventbus是一种事件总线机制

@Subscribe中的三个参数:

threadModule:

  • POSTING 默认,表示事件处理函数的线程跟发布事件的线程在同一个线程。 直接通过java.lang.reflect包的method.invoke执行
  • MAIN 在主线程执行 EventBus会先判断是否在主线程:是,则直接跟POSTING一样通过method.invoke直接执行;否,则压入mainPoster的队列里
  • MAIN_ORDERED 同样是在主线程执行 EventBus压入mainPoster的队列中
  • BACKGROUND 后台运行 EventBus会先判断是否在主线程:是,则压入backgroundPoster的队列里.注意,backgroundPoster在 Executor的execute()方法 上添加了 synchronized关键字 并设立 了控制标记flag,保证任一时间只且仅能有一个任务会被线程池执行。;否,则通过method.invoke直接执行。
  • ASYNC 在单独一个线程中执行 由EventBusBuilder中的newCachedThreadPool执行
sticky -- 是否是粘性事件:
true:是粘性事件 -- 在发送Event后register也可以收到Event
false:默认。不是粘性事件
priority -- 优先级
默认为0,数值约大,优先级越高

2、源码分析

核心类:
==EventBus==:连接Publisher和Subscriber(观察者类)的中间桥

核心参数:

  • Map<Class<?>, CopyOnWriteArrayList<Subscription>> ==subscriptionsByEventType==;
    一个key为==EventType==(EventType为消息Event的Class),value为Subscription集合的HashMap。
  • Map<Object, List<Class<?>>> typesBySubscriber;
    一个Key为观察者类,value为EventType的HashMap
  • Map<Class<?>, Object> stickyEvents;
    一个Key为EventType,value为要发送的Event的ConcurrentHashMap
  • ExecutorService executorService;
    一个新创建的缓存线程池
  • 三个Poster:mainThreadPoster、backgroundPoster、asyncPoster根据不同的threadMode来使用不同的Poster,Poster中主要是equeue Event/开启对应的线程来invokeSubscriber
  • SubscriberMethodFinder subscriberMethodFinder;
    可以理解为将EventBus抽离出来的工具类:
    只有一个作用:通过传入的Subscriber类来获取到该类的被@Subscribe注解修饰的观察方法的集合

核心方法:EventBus.getDefault().register(this);

  • 通过线程安全的单例模式创建一个EventBus对象
  • 或者可以通过构建者模式创建一个自定义的EventBus对象:EventBus bus = EventBus.builder().logNoSubscriberMessages(true).build();
SubscriberMethod

保存了我们的被@Subscriber修饰的方法的所有内容(可以理解为一个Bean类)

Subscription

包含了我们的观察者类subscriber和被@Subscribe注解修饰的观察方法的信息

Poster的实现类里(mainThreadPoster/backgroundPoster/asyncPoster)

线程不满足时将Event放入队列里,通过handler机制来在线程满足时调用invoke方法

流程分析

  • register方法:
    1、为subscriptionsByEventType赋值--根据priority的大小来放入到map的前面或者后面来控制顺序
    2、为typesBySubscriber赋值
    3、如果粘性事件,从stickyEvents中取event,如果event不为空,则重新调用postToSubscription
  • postSticky方法:
    1、将Event放进stickyEvents中
    2、调用post方法

  • post方法:
    对当前线程进行校验--调用了postSingleEvent方法
    最终调用到了postToSubscription方法

  • postToSubscription方法:
    post/postSticky 的最终调用方法
    判断threadMode:
    线程满足的情况:直接调用invokeSubscriber
    线程不满足的情况:

1、 mainThreadPoster:
①、做equeue操作,
②、调用Handler机制:sendMessage、handleMessage
2、backgroundPoster:
backgroundPoster在 Executor的execute()方法 上添加了 synchronized关键字 并设立 了控制标记flag,保证任一时间只且仅能有一个任务会被线程池执行。
3、asyncPoster:
在单独一个线程中执行 由EventBusBuilder中的newCachedThreadPool执行

注意:equeue是将event和event对应的Subscription作为参数创建一个单链表PendingPost类压入(equeue)到Poster的实现类里;

  • unregister方法:
    将subscriptionsByEventType和typesBySubscriber清空

总结:

EventBus使用了观察者模式,来进行消息的发送和处理,可以通过声明不同的threadModule来在不同的线程进行消息的处理。
EventBus可以通过线程安全的单例模式创建一个默认的EventBus或者通过Builder模式创建一个自定义的EventBus类。
在调用register时,做了两件事
1、会为EventBus的核心参数subscriptionsByEventType进行赋值,subscriptionsByEventType是一个map,map的value是一个Subscription的CopyOnWriteArrayList,Subscription里面存储了观察者类和被@Subscriber修饰的方法的一切属性
在存储这个Subscription的list的时候,会根据priority优先级来确定存放位置。
2、判断是否是粘性事件,如果是粘性事件,那么从粘性事件列表里取出来event来调用postToSubscription来处理event

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

推荐阅读更多精彩内容

  • 前面对EventBus 的简单实用写了一篇,相信大家都会使用,如果使用的还不熟,或者不够6,可以花2分钟瞄一眼:h...
    gogoingmonkey阅读 309评论 0 0
  • title: EventBus 源码分析date: 2017-09-15 09:38:14tags: [Sourc...
    Passon_Fang阅读 195评论 0 0
  • EventBus 源码分析 分析源码之前 EventBus 大神的 github,最好的老师。 一、使用 我们在平...
    猪_队友阅读 349评论 0 4
  • 首先从订阅开始 register方法会获取传入的object对象的class,通过findSubscriberMe...
    BigDevil_S阅读 74评论 0 1
  • 简介 前面我学习了如何使用EventBus,还有了解了EventBus的特性,那么接下来我们一起来学习EventB...
    eirunye阅读 452评论 0 0