EventBus源码解析

关于EventBus

  1. EventBus是一个轻量级的发布和订阅事件的库
  2. 有基本超过2W的开发者在使用
  3. 服务于许多大体量的App
  4. 集成和使用方式都特别方便
```

//订阅与解除订阅

 @Override
 public void onStart() {
     super.onStart();
     EventBus.getDefault().register(this);
 }

 @Override
 public void onStop() {
     super.onStop();
     EventBus.getDefault().unregister(this);
 }

//定义事件
public class MessageEvent

// 订阅者接受到事件后的回调
@Subscribe(threadMode = ThreadMode.MAIN)  
public void onMessageEvent(MessageEvent event)

//发布事件
EventBus.getDefault().post(new MessageEvent());

```  

疑问

EventBus是如何进行事件关联的

EventBus的核心类
  1. EventBus 事件发布和订阅的唯一入口
  2. Subscribe (注解类)用于声明事件
public @interface Subscribe {
    ThreadMode threadMode() default ThreadMode.POSTING; //事件回调处理线程

    boolean sticky() default false;  //  是否需要粘性事件  默认false

  
    int priority() default 0;  // 优先权
}


  1. SubscriberMethodFinder 通过反射获取实体类中带有Subscribe注解的订阅者的相关信息,并存入集合
  2. SubscriberMethod 用于封装订阅者的相关信息
  3. Poster 接口,实现该接口的有AsyncPoster,BackgroundPoster,HandlerPoster用于处理发布的事件
事件处理流程
  1. 事件订阅与存储
 //外部调用方法进行订阅
 EventBus.getDefault().register(this);
 
 //EventBus内用于存储订阅者的集合
 private final Map<Class<?>, CopyOnWriteArrayList<Subscription>> subscriptionsByEventType;
 key: 事件的Class对象
 value: Subscription的集合
 
 //Subscription内部属性
 final class Subscription {
   final Object subscriber;   //订阅者,上述register(this)中的this
   final SubscriberMethod subscriberMethod;  
 }
 
 //SubscriberMethod内部属性
 public class SubscriberMethod {
     final Method method;     //等待被事件触发的方法
     final Class<?> eventType;  //事件的class对象
     
     final ThreadMode threadMode;   
     final int priority;
     final boolean sticky;
  }

在EventBus类中的register方法内。

List<SubscriberMethod> subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);

这句代码主要作用就是通过放射获取订阅者及其父类中 带有Subscribe注解的方法,以及Subscribe的相关参数
由于代码太多就不贴出来了,感兴趣的同学可以去了解一下

获取相关信息后执行EventBus类中的subscribe方法,封装Subscription并存入到subscriptionsByEventType集合中

private void subscribe(Object subscriber, SubscriberMethod subscriberMethod) 
  1. 发布事件
  //发布事件
  EventBus.getDefault().post(new MessageEvent())
  
  //通过事件的class类型 获取该事件的订阅者 执行postToSubscription方法
    private boolean postSingleEventForEventType(Object event, PostingThreadState postingState, Class<?> eventClass) {
          CopyOnWriteArrayList<Subscription> subscriptions;
          synchronized (this) {
              subscriptions = subscriptionsByEventType.get(eventClass);
          }
          if (subscriptions != null && !subscriptions.isEmpty()) {
              for (Subscription subscription : subscriptions) {
                  postingState.event = event;
                  postingState.subscription = subscription;
                  boolean aborted = false;
                  try {
                      postToSubscription(subscription, event, postingState.isMainThread);
                      aborted = postingState.canceled;
                  } finally {
                      postingState.event = null;
                      postingState.subscription = null;
                      postingState.canceled = false;
                  }
                  if (aborted) {
                      break;
                  }
              }
              return true;
          }
          return false;
      }
      
  
  //判断不同的threadMode调用不同的处理类进行方法放射执行 method.invoke("方法所在类的实例化对象","参数")
  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 MAIN_ORDERED:
                  if (mainThreadPoster != null) {
                      mainThreadPoster.enqueue(subscription, event);
                  } else {
                      // temporary: technically not correct as poster not decoupled from subscriber
                      invokeSubscriber(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);
          }
      }
      
  1. 其他
EventBus.getDefault().unregister(this)

解除订阅 其实无非就是从subscriptionsByEventType集合中删除掉对应的订阅对象

 EventBus.getDefault().postSticky(new MessageEvent())

发送粘性事件,流程跟发布正常的时间大致一致,postSticky方法内调用了post方法(),不过在这之前EventBus也同时将该事件加入了

private final Map<Class<?>, Object> stickyEvents;

stickyEvents用于存储的粘性事件会在有订阅者订阅时,去检测是否需要粘性事件,如果为True则会匹配stickyEvents中的粘性事件
如果有事件匹配,则会直接执行该事件

其实EventBus的主要设计模式 就是一个观察者模式,根据该模式其实我们也能手写一个属于我们自己的事件分发库

参考EventBus写的一个事件分发库,在EventBus的基础上,添加事件延迟处理功能
https://github.com/liujun123456/EngineEvent

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