转:https://www.jianshu.com/p/d9516884dbd4
EventBus是一款在 Android 开发中使用的发布/订阅事件总线框架,基于观察者模式,将事件的接收者和发送者分开,简化了组件之间的通信,使用简单、效率高、体积小!下边是官方的 EventBus 原理图:
文章图片
EventBus 的用法可以参考官网,这里不做过多的说明。本文主要是从 EventBus 使用的方式入手,来分析 EventBus 背后的实现原理,以下内容基于eventbus:3.1.1版本,主要包括如下几个方面的内容:
Subscribe注解
注册事件订阅方法
取消注册
发送事件
事件处理
粘性事件
Subscriber Index
核心流程梳理
一、Subscribe注解
EventBus3.0 开始用Subscribe注解配置事件订阅方法,不再使用方法名了,例如:
@SubscribepublicvoidhandleEvent(Stringevent){// do something}
其中事件类型可以是 Java 中已有的类型或者我们自定义的类型。
具体看下Subscribe注解的实现:
@Documented@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.METHOD})public@interfaceSubscribe{// 指定事件订阅方法的线程模式,即在那个线程执行事件订阅方法处理事件,默认为POSTINGThreadModethreadMode()defaultThreadMode.POSTING;
// 是否支持粘性事件,默认为falsebooleansticky()defaultfalse;
// 指定事件订阅方法的优先级,默认为0,如果多个事件订阅方法可以接收相同事件的,则优先级高的先接收到事件intpriority()default0;
}
所以在使用Subscribe注解时可以根据需求指定threadMode、sticky、priority三个属性。
其中threadMode属性有如下几个可选值:
ThreadMode.POSTING,默认的线程模式,在那个线程发送事件就在对应线程处理事件,避免了线程切换,效率高。
ThreadMode.MAIN,如在主线程(UI线程)发送事件,则直接在主线程处理事件;如果在子线程发送事件,则先将事件入队列,然后通过 Handler 切换到主线程,依次处理事件。
ThreadMode.MAIN_ORDERED,无论在那个线程发送事件,都先将事件入队列,然后通过 Handler 切换到主线程,依次处理事件。
ThreadMode.BACKGROUND,如果在主线程发送事件,则先将事件入队列,然后通过线程池依次处理事件;如果在子线程发送事件,则直接在发送事件的线程处理事件。
ThreadMode.ASYNC,无论在那个线程发送事件,都将事件入队列,然后通过线程池处理。
二、注册事件订阅方法
注册事件的方式如下:
EventBus.getDefault().register(this);
其中getDefault()是一个单例方法,保证当前只有一个EventBus实例:
publicstaticEventBusgetDefault(){if(defaultInstance==null){synchronized(EventBus.class){if(defaultInstance==null){defaultInstance=newEventBus();
}}}returndefaultInstance;
}
继续看new EventBus()做了些什么:
publicEventBus(){this(DEFAULT_BUILDER);
}
在这里又调用了EventBus的另一个构造函数来完成它相关属性的初始化:
EventBus(EventBusBuilderbuilder){logger=builder.getLogger();
subscriptionsByEventType=newHashMap<>();
typesBySubscriber=newHashMap<>();
stickyEvents=newConcurrentHashMap<>();
mainThreadSupport=builder.getMainThreadSupport();
mainThreadPoster=mainThreadSupport!=null?mainThreadSupport.createPoster(this):null;
backgroundPoster=newBackgroundPoster(this);
asyncPoster=newAsyncPoster(this);
indexCount=builder.subscriberInfoIndexes!=null?builder.subscriberInfoIndexes.size():0;
subscriberMethodFinder=newSubscriberMethodFinder(builder.subscriberInfoIndexes,builder.strictMethodVerification,builder.ignoreGeneratedIndex);
logSubscriberExceptions=builder.logSubscriberExceptions;
logNoSubscriberMessages=builder.logNoSubscriberMessages;
sendSubscriberExceptionEvent=builder.sendSubscriberExceptionEvent;
sendNoSubscriberEvent=builder.sendNoSubscriberEvent;
throwSubscriberException=builder.throwSubscriberException;
eventInheritance=builder.eventInheritance;
executorService=builder.executorService;
}
DEFAULT_BUILDER就是一个默认的EventBusBuilder:
privatestaticfinalEventBusBuilderDEFAULT_BUILDER=newEventBusBuilder();
如果有需要的话,我们也可以通过配置EventBusBuilder来更改EventBus的属性,例如用如下方式注册事件:
EventBus.builder().eventInheritance(false).logSubscriberExceptions(false).build().register(this);
有了EventBus的实例就可以进行注册了:
publicvoidregister(Objectsubscriber){// 得到当前要注册类的Class对象Class>subscriberClass=subscriber.getClass();
// 根据Class查找当前类中订阅了事件的方法集合,即使用了Subscribe注解、有public修饰符、一个参数的方法// SubscriberMethod类主要封装了符合条件方法的相关信息:// Method对象、线程模式、事件类型、优先级、是否是粘性事等ListsubscriberMethods=subscriberMethodFinder.findSubscriberMethods(subscriberClass);
synchronized(this){// 循环遍历订阅了事件的方法集合,以完成注册for(SubscriberMethodsubscriberMethod:subscriberMethods){subscribe(subscriber,subscriberMethod);
}}}
可以看到register()方法主要分为查找和注册两部分,首先来看查找的过程,从findSubscriberMethods()开始:
ListfindSubscriberMethods(Class>subscriberClass){// METHOD_CACHE是一个ConcurrentHashMap,直接保存了subscriberClass和对应SubscriberMethod的集合,以提高注册效率,赋值重复查找。ListsubscriberMethods=METHOD_CACHE.get(subscriberClass);
if(subscriberMethods!=null){returnsubscriberMethods;
}// 由于使用了默认的EventBusBuilder,则ignoreGeneratedIndex属性默认为false,即是否忽略注解生成器if(ignoreGeneratedIndex){subscriberMethods=findUsingReflection(subscriberClass);
}else{subscriberMethods=findUsingInfo(subscriberClass);
}// 如果对应类中没有符合条件的方法,则抛出异常if(subscriberMethods.isEmpty()){thrownewEventBusException("Subscriber "+subscriberClass+" and its super classes have no public methods with the @Subscribe annotation");
}else{// 保存查找到的订阅事件的方法METHOD_CACHE.put(subscriberClass,subscriberMethods);
returnsubscriberMethods;
}}
findSubscriberMethods()流程很清晰,即先从缓存中查找,如果找到则直接返回,否则去做下一步的查找过程,然后缓存查找到的集合,根据上边的注释可知findUsingInfo()方法会被调用:
privateListfindUsingInfo(Class>subscriberClass){FindStatefindState=prepareFindState();
findState.initForSubscriber(subscriberClass);
// 初始状态下findState.clazz就是subscriberClasswhile(findState.clazz!=null){findState.subscriberInfo=getSubscriberInfo(findState);
// 条件不成立if(findState.subscriberInfo!=null){SubscriberMethod[]array=findState.subscriberInfo.getSubscriberMethods();
for(SubscriberMethodsubscriberMethod:array){if(findState.checkAdd(subscriberMethod.method,subscriberMethod.eventType)){findState.subscriberMethods.add(subscriberMethod);
}}}else{// 通过反射查找订阅事件的方法findUsingReflectionInSingleClass(findState);
}// 修改findState.clazz为subscriberClass的父类Class,即需要遍历父类findState.moveToSuperclass();
}// 查找到的方法保存在了FindState实例的subscriberMethods集合中。// 使用subscriberMethods构建一个新的List// 释放掉findStatereturngetMethodsAndRelease(findState);
}
findUsingInfo()方法会在当前要注册的类以及其父类中查找订阅事件的方法,这里出现了一个FindState类,它是SubscriberMethodFinder的内部类,用来辅助查找订阅事件的方法,具体的查找过程在findUsingReflectionInSingleClass()方法,它主要通过反射查找订阅事件的方法:
privatevoidfindUsingReflectionInSingleClass(FindStatefindState){Method[]methods;
try{// This is faster than getMethods, especially when subscribers are fat classes like Activitiesmethods=findState.clazz.getDeclaredMethods();
}catch(Throwableth){// Workaround for java.lang.NoClassDefFoundError, see https://github.com/greenrobot/EventBus/issues/149methods=findState.clazz.getMethods();
findState.skipSuperClasses=true;
}// 循环遍历当前类的方法,筛选出符合条件的for(Methodmethod:methods){// 获得方法的修饰符intmodifiers=method.getModifiers();
// 如果是public类型,但非abstract、static等if((modifiers&Modifier.PUBLIC)!=0&&(modifiers&MODIFIERS_IGNORE)==0){// 获得当前方法所有参数的类型Class>[]parameterTypes=method.getParameterTypes();
// 如果当前方法只有一个参数if(parameterTypes.length==1){SubscribesubscribeAnnotation=method.getAnnotation(Subscribe.class);
// 如果当前方法使用了Subscribe注解if(subscribeAnnotation!=null){// 得到该参数的类型Class>eventType=parameterTypes[0];
// checkAdd()方法用来判断FindState的anyMethodByEventType map是否已经添加过以当前eventType为key的键值对,没添加过则返回trueif(findState.checkAdd(method,eventType)){// 得到Subscribe注解的threadMode属性值,即线程模式ThreadModethreadMode=subscribeAnnotation.threadMode();
// 创建一个SubscriberMethod对象,并添加到subscriberMethods集合findState.subscriberMethods.add(newSubscriberMethod(method,eventType,threadMode,subscribeAnnotation.priority(),subscribeAnnotation.sticky()));
}}}elseif(strictMethodVerification&&method.isAnnotationPresent(Subscribe.class)){StringmethodName=method.getDeclaringClass().getName()+"."+method.getName();
thrownewEventBusException("@Subscribe method "+methodName+"must have exactly 1 parameter but has "+parameterTypes.length);
}}elseif(strictMethodVerification&&method.isAnnotationPresent(Subscribe.class)){StringmethodName=method.getDeclaringClass().getName()+"."+method.getName();
thrownewEventBusException(methodName+" is a illegal @Subscribe method: must be public, non-static, and non-abstract");
}}}
到此register()方法中findSubscriberMethods()流程就分析完了,我们已经找到了当前注册类及其父类中订阅事件的方法的集合。接下来分析具体的注册流程,即register()中的subscribe()方法:
privatevoidsubscribe(Objectsubscriber,SubscriberMethodsubscriberMethod){// 得到当前订阅了事件的方法的参数类型Class>eventType=subscriberMethod.eventType;
// Subscription类保存了要注册的类对象以及当前的subscriberMethodSubscriptionnewSubscription=newSubscription(subscriber,subscriberMethod);
// subscriptionsByEventType是一个HashMap,保存了以eventType为key,Subscription对象集合为value的键值对// 先查找subscriptionsByEventType是否存在以当前eventType为key的值CopyOnWriteArrayListsubscriptions=subscriptionsByEventType.get(eventType);
// 如果不存在,则创建一个subscriptions,并保存到subscriptionsByEventTypeif(subscriptions==null){subscriptions=newCopyOnWriteArrayList<>();
subscriptionsByEventType.put(eventType,subscriptions);
}else{if(subscriptions.contains(newSubscription)){thrownewEventBusException("Subscriber "+subscriber.getClass()+" already registered to event "+eventType);
}}// 添加上边创建的newSubscription对象到subscriptions中intsize=subscriptions.size();
for(inti=0;
i<=size;
i++){if(i==size||subscriberMethod.priority>subscriptions.get(i).subscriberMethod.priority){subscriptions.add(i,newSubscription);
break;
}}// typesBySubscribere也是一个HashMap,保存了以当前要注册类的对象为key,注册类中订阅事件的方法的参数类型的集合为value的键值对// 查找是否存在对应的参数类型集合List>subscribedEvents=typesBySubscriber.get(subscriber);
// 不存在则创建一个subscribedEvents,并保存到typesBySubscriberif(subscribedEvents==null){subscribedEvents=newArrayList<>();
typesBySubscriber.put(subscriber,subscribedEvents);
}// 保存当前订阅了事件的方法的参数类型subscribedEvents.add(eventType);
// 粘性事件相关的,后边具体分析if(subscriberMethod.sticky){if(eventInheritance){// Existing sticky events of all subclasses of eventType have to be considered.// Note: Iterating over all events may be inefficient with lots of sticky events,// thus data structure should be changed to allow a more efficient lookup// (e.g. an additional map storing sub classes of super classes: Class -> List).Set,Object>>entries=stickyEvents.entrySet();
for(Map.Entry,Object>entry:entries){Class>candidateEventType=entry.getKey();
if(eventType.isAssignableFrom(candidateEventType)){ObjectstickyEvent=entry.getValue();
checkPostStickyEventToSubscription(newSubscription,stickyEvent);
}}}else{ObjectstickyEvent=stickyEvents.get(eventType);
checkPostStickyEventToSubscription(newSubscription,stickyEvent);
}}}
这就是注册的核心流程,所以subscribe()方法主要是得到了subscriptionsByEventType、typesBySubscriber两个 HashMap。我们在发送事件的时候要用到subscriptionsByEventType,完成事件的处理。当取消 EventBus 注册的时候要用到typesBySubscriber、subscriptionsByEventType,完成相关资源的释放。
三、取消注册
接下来看,EventBus 如何取消注册:
EventBus.getDefault().unregister(this);
核心的方法就是unregister():
publicsynchronizedvoidunregister(Objectsubscriber){// 得到当前注册类对象 对应的 订阅事件方法的参数类型 的集合List>subscribedTypes=typesBySubscriber.get(subscriber);
if(subscribedTypes!=null){// 遍历参数类型集合,释放之前缓存的当前类中的Subscriptionfor(Class>eventType:subscribedTypes){unsubscribeByEventType(subscriber,eventType);
}// 删除以subscriber为key的键值对typesBySubscriber.remove(subscriber);
}else{logger.log(Level.WARNING,"Subscriber to unregister was not registered before: "+subscriber.getClass());
}}
内容很简单,继续看unsubscribeByEventType()方法:
privatevoidunsubscribeByEventType(Objectsubscriber,Class>eventType){// 得到当前参数类型对应的Subscription集合Listsubscriptions=subscriptionsByEventType.get(eventType);
if(subscriptions!=null){intsize=subscriptions.size();
// 遍历Subscription集合for(inti=0;
i
所以在unregister()方法中,释放了typesBySubscriber、subscriptionsByEventType中缓存的资源。
四、发送事件
当发送一个事件的时候,我们可以通过如下方式:
EventBus.getDefault().post("Hello World!")
可以看到,发送事件就是通过post()方法完成的:
publicvoidpost(Objectevent){// currentPostingThreadState是一个PostingThreadState类型的ThreadLocal// PostingThreadState类保存了事件队列和线程模式等信息PostingThreadStatepostingState=currentPostingThreadState.get();
List
推荐阅读