EventBus 3.0源码解析
Posted 火龙裸先生
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了EventBus 3.0源码解析相关的知识，希望对你有一定的参考价值。
现在网上讲解EventBus的文章大多数都是针对2.x版本的，比较老旧，本篇文章希望可以给大家在新版本上面带来帮助。
EventBus 是专门为android设计的用于订阅，发布总线的库，用到这个库的app很多，因为它有很多的优点。比如：
-
它可以简单Android组件之间的通信
-
它可以避免了Android四大组件复杂的生命周期处理
-
它可以让你的代码更为简洁。
先一起了解下如何使用，然后在分析它的源码，知道它的工作原理。我们直接来使用EventBus 3.0，3.x主要的一个新的特性就是使用了注解，我们的 Subscribe 可以在代码中就指定我们的 EventBus 使用什么 ThreadMode，是否粘性事件，优先级。
这些，等会在源码分析的时候会讲，先看看如何使用：
视图上显示一个TextView和一个Button，点击按钮的时候，就执行NetWork任务请求，请求执行结束后，在 onEventMainThread 方法更新UI，下面是 NetWork :
代码看起来要比广播和回调方便多了，下面是UI显示：
初始化:
上面是 EventBus 初始化的三个步骤，直观上看用到 单例模式和Builder模式，将构造参数给分离了出来，实际上还用到了策略模式，其中Builder中有些参数用于代码执行的策略，就说，你传的参数不一样，我执行的方式不一样，像 ignoreGeneratedIndex 作用就是让 EventBus 如何查找出订阅方法的策略。这些布尔类型的参数，在分析代码中可以逐步的了解到，先了解一些缓存对象，以更容易的了解源码：
-
subscriptionsByEventType : 内部是一个Map集合，可以根据 EventType 查找订阅事件。
-
typesBySubscriber : 根据我们的订阅对象找到 EventType。
-
stickyEvents : 粘性事件的缓存。
-
事件投递者 : mainThreadPoster, backgroundPoster, asyncPoster 根据订阅注解ThreadMode 去选择不同的投递者，不同投递者投递事件，接收函数会执行在不同的线程中。
-
subscriberMethodFinder ：查找方法用的，内部维护了一个订阅方法的集合。
注册:
当我们调用 register(this) 的时候就把订阅者给传了进来，代码量很少，主要就两个步骤，第一个 findSubscriberMethods 找出一个 SubscriberMethod 的集合，然后就遍历SubscriberMethod 去订阅事件，我们先看看 findSubscriberMethods() 里面到底做了什么，返回的是什么。
首先从缓存中查找，如果找到了就立马返回。如果缓存中没有的话，则根据ignoreGeneratedIndex 选择如何查找订阅方法，最后，找到订阅方法后，放入缓存，以免下次继续查找。ignoreGeneratedIndex 默认就是 false，那我们会执行 findUsingInfo() 方法，但是这里先分析 findUsingReflection()，因为在我们没有做任何配置的情况下还是会执行上面的findUsingReflection()，就是通过反射来解析注解。
从上面的代码块，我们可以看到，第一步准备 FindState，我们点进去看看：
这里我们先了解从池中拿出一个 FindState对象，FindState 中维护的就是我们对订阅方法查找结果的封装。其实，往后面，我们就知道作者这里设计的非常精妙。第二步，initForSubscriber() 就是将我们的订阅者传给FindState对象。第三步做的就是不断从订阅者和订阅者的父类去查找订阅方法，一起看 findUsingReflectionInSingleClass()：
代码很长，其实就是对订阅者方法的遍历，看有没有注解，有的话就解析注解，最后将找到的订阅方法的集合封装到 FindState 对象中的 subscriberMethods 集合中。我们解析完了之后，在看 findUsingReflection() 方法的最后，返回了 getMethodsAndRelease(FindState)，将我们的 FindState 传给了getMethodsAndRelease() 方法，好，我们点进去：
从这里，我们就知道作者设计 FindState池的初心了，解析完了之后，将订阅方法赋给List集合，再回收 FindState，继续接收解析，内存没有半点浪费。最后，我们返回的是一个订阅方法的集合。这样，我们通过反射解析注解，找到订阅方法的方式，我们已经分析完了。再看看通过apt处理器来找，我们知道apt处理，是针对源码的处理，是执行在编译过程中的。所以性能要比反射好的多，所以推荐大家使用这种方式。好，那最开始，我说使用 findUsingInfo() 方法如果没有配置还是使用反射呢，我们一起看看：
上面，我注释解析的很清楚了，前几步的操作基本一致，主要看 getSubscriberInfo(findState)这个方法：
上面一段代码是针对缓存的，如果缓存中有就直接返回，底下，是从 subscriberInfoIndexes中查找订阅信息的。那么，我们的 subscriberInfoIndexes 从哪来的呢，是 EventBus Builder对象：
public class EventBusBuilder { private final static ExecutorService DEFAULT_EXECUTOR_SERVICE = Executors.newCachedThreadPool(); ...... List<SubscriberInfoIndex> subscriberInfoIndexes;
默认是空的，所以结合上面的代码，还是执行了 findUsingReflection() 方法。那么，我们应该如何操作呢？我们需要配置下。第一步引入EventBusAnnotationProcessor 库：
这个库是在预编译过程，对我们的代码进行处理，找到我们有订阅方法的类的。第二步，配置项目的build.gradle文件：
将我们的库和 andorid-apt 引入，其中参数 arguments 是指定，我们处理完我们的源码文件，生成的文件名的。好，我们rebuild一下我们的项目。然后在build文件夹下面发现了：
我们点进去看看：
把我们的订阅类和订阅方法全找出来了，当，我们这个类初始化的时候，我们的SUBSCRIBER_INDEX这个集合就已经有我们的订阅信息了。所以，你知道为什么，叫ignoreGeneratedIndex了把。好，最后一步，我们就通过EventBus初始化，将这个类给传进去：
EventBus.builder().addIndex(new MyEventBusIndex()).installDefaultEventBus().register(this);
这样，它就会通过apt方式来处理我们的注解了，需要强调的是，我们是在编译过程中就已经找到我们的订阅信息了，不会在运行期做任何事情，所以这个效率是非常高的。好了，我们查找订阅的代码已经全部分析完了，这个部分是3.0最核心的代码，作者很精心的设计以提高EventBus的性能，我们看完之后也受益良多啊。好，继续分析，继续看findUsingInfo()方法，之前，我注释的也很清楚，但是还有个地方需要注意：
我们添加订阅方法的时候还有个检查，我们分析下：
这里，有两步检查，第一步检查，很好懂，第二步，根据什么签名来检查，我们看看：
其实作者，这里又做了一个优化，将方法名和事件类型当作key，来保存方法，将传来的方法类型和我们签名的保存的比较，如果我们保存的是父类，就返回 true，如果是子类，就将传来的方法保存起来，返回 false。这样做的意图是，如果有父类的方法了，就没有必要添加子类的方法了，因为继承会执行到的。至此，我们对查找订阅方法的过程已经完全分析完了。看懂了之后，非常的过瘾。无论哪种方式查找，都返回了SubscriberMethod 对象，我们看看它维护了什么属性：
/** * Used internally by EventBus * and generated subscriber indexes. */ public class SubscriberMethod { final Method method; final ThreadMode threadMode; final Class<?> eventType; final int priority; final boolean sticky; /** Used for efficient comparison */ String methodString;
订阅:
订阅的代码比较长，但是理解起来并不难，而且，我也做了很详细的注释，其实里面就做了两件事，将我们的订阅方法和订阅者，封装到 subscriptionsByEventType和typesBySubscriber，至于这两个对象是干什么的呢？第一个是我们投递订阅事件的时候，就是根据我们的 EventType 找到我们的订阅事件，从而去分发事件，处理事件的；第二个是在调用 EventBus 3 源码解析