EventBus源码分析_刘永雷(雷惊风)

EventBus源码分析一．简单介绍。

EventBus定义：是一个发布/ 订阅的开源框架，要用于事件的发布和订阅，一般传递事件的方式主要有Handler、BroadCastReceiver、Interface 回调等，EventBus的好处主要在于代码简单，使用方便，充分了降低订阅者与发布者的耦合度，所有的事件都交由EventBus这个事件总线来管理。

二．涉及到的模块。

想通过Eventbus完成事件传递，至少要涉及3个部分，订阅者、发布者、事件，下边逐个简单介绍。

1.订阅者。

订阅一个或多个事件对象，当发布者发布对应事件后，EventBus会查找所有订阅了本事件的所有订阅者，并执行订阅者操作类中相应的OnEvent*（Object）方法，完成对应操作。

订阅方法：EventBus.getDefault().register(this);单例模式。

2.发布者。

顾名思义，就是发布某个事件的对象，当发布者完成特定任务后，发布事件，事件总线EventBus通过事件获取对应的订阅者列表，循环执行订阅者中对应的OnEvent*（Object）事件响应函数。

发布事件方法：EventBus.getDefault().post(EventOb)；3.事件。

就是一个对象。

可以携带一些处理后的信息。

分为普通事件和Sticky 事件，相对于一般事件，Sticky 事件不同之处在于，当事件发布后，再有订阅者开始订阅该类型事件，依然能收到该类型事件最近一个Sticky 事件。

三．用到的方法及作用。

1.EventBus.getDefault().register(this);注册当前类到事件总线EventBus。

This参数为当前activity的上下文对象。

写在订阅者对象中。

2.EventBus.getDefault().post(new EventOB());发布一个EventOB事件到事件总线EventBus中，EventOB为发布的事件类型，也就是一个对象。

3.Public void onEvent/onEvenMainThread /BackgroundThread /Async(){};当发布者发布事件后，EventBus找到订阅者后通过订阅者的ThreadMode名称类型在相应线程执行内部代码。

ThreadMode共四种：①PostThread：直接调用订阅者的事件响应函数；②MainThread 并且发布线程就是主线程，则直接调用订阅者的事件响应函数，否则通过主线程的Handler 发送消息在主线程中处理——调用订阅者的事件响应函数；③BackgroundThread 并且发布线程是主线程，则启动异步线程去处理，否则直接直接调用订阅者的事件响应函数；♍Async ，则启动异步线程去处理——调用订阅者的事件响应函数。

4.EventBus.getDefault().unRegister(this);取消当前类订阅。

四．源码分析。

1.从订阅开始：订阅流程图public void register(Object subscriber) {register(subscriber, false, 0);}注释：以上调用三个参数注册方法subscriber为调用者acticity上下文对象；再看三参数方法：private synchronized void register(Object subscriber, boolean sticky, int priority) {List<SubscriberMethod> subscriberMethods =subscriberMethodFinder.findSubscriberMethods(subscriber.getClass());for (SubscriberMethod subscriberMethod : subscriberMethods) {subscribe(subscriber, subscriberMethod, sticky, priority);}}注释：看参数subscriber：上下文对象；Sticky：是否粘性（当再次有新订阅者，老订阅者能收到处理信息）；priority：优先级设置，优先级越高，首先执行。

subscriberMethodFinder订阅者响应函数信息存储和查找类。

ubscriberMethodFinder.findSubscriberMethods(subscriber.getClass())方法：List<SubscriberMethod> findSubscriberMethods(Class<?> subscriberClass) {String key = subscriberClass.getName();List<SubscriberMethod> subscriberMethods;synchronized (methodCache) {subscriberMethods = methodCache.get(key);}if (subscriberMethods != null) {return subscriberMethods;}subscriberMethods = new ArrayList<SubscriberMethod>();Class<?> clazz = subscriberClass;HashSet<String> eventTypesFound = new HashSet<String>();StringBuilder methodKeyBuilder = new StringBuilder();while (clazz != null) {String name = clazz.getName();if (name.startsWith("java.") || name.startsWith("javax.") ||name.startsWith("android.")) {// Skip system classes, this just degrades performancebreak;}// Starting with EventBus 2.2 we enforced methods to be public (might changewith annotations again)Method[] methods = clazz.getDeclaredMethods();for (Method method : methods) {String methodName = method.getName();if (methodName.startsWith(ON_EVENT_METHOD_NAME)) {int modifiers = method.getModifiers();if ((modifiers & Modifier.PUBLIC) != 0 && (modifiers & MODIFIERS_IGNORE) == 0) {Class<?>[] parameterTypes = method.getParameterTypes();if (parameterTypes.length == 1) {String modifierString =methodName.substring(ON_EVENT_METHOD_NAME.length());ThreadMode threadMode;if (modifierString.length() == 0) {threadMode = ThreadMode.PostThread;} else if (modifierString.equals("MainThread")) {threadMode = ThreadMode.MainThread;} else if (modifierString.equals("BackgroundThread")) { threadMode = ThreadMode.BackgroundThread;} else if (modifierString.equals("Async")) {threadMode = ThreadMode.Async;} else {if(skipMethodVerificationForClasses.containsKey(clazz)) {continue;} else {throw new EventBusException("Illegal onEvent method, check for typos: " + method);}}Class<?> eventType = parameterTypes[0];methodKeyBuilder.setLength(0);methodKeyBuilder.append(methodName);methodKeyBuilder.append('>').append(eventType.getName());String methodKey = methodKeyBuilder.toString();if (eventTypesFound.add(methodKey)) {// Only add if not already found in a sub classsubscriberMethods.add(new SubscriberMethod(method, threadMode, eventType));}}} else if (!skipMethodVerificationForClasses.containsKey(clazz)) {Log.d(EventBus.TAG, "Skipping method (not public, static or abstract): " + clazz + "."+ methodName);}}}clazz = clazz.getSuperclass();}if (subscriberMethods.isEmpty()) {throw new EventBusException("Subscriber " + subscriberClass + " has no public methods called "+ ON_EVENT_METHOD_NAME);} else {synchronized (methodCache) {methodCache.put(key, subscriberMethods);}return subscriberMethods;}}注释：看核心部分：首先通过name去缓存中查找，存在直接返回，不存在继续往下走。