EventBus索引加速探究

0. 为什么使用索引加速？

===============================================================================

EventBus在源码上的实现目标是什么：“找到所有的订阅方法”

所以它的优化方向是什么：“以最快的速度找到所有的订阅方法”

这里先介绍一下3.0之前 EventBus寻找订阅方法的做法

• 3.0版本之前

通过反射，拿到订阅者类的所有方法，找到 onEvent开头的订阅方法

就是通过 反射+遍历 的方式。这样的做法未免太过暴力，如果在方法特别多的类进行了注册，性能会不高。

GreenDao其实在很早就想过使用 反射+注解 的方式来进行方法搜寻，但是由于注解只是作为一个标识的方法，在没有别的帮助的情况下，还是得使用 遍历来拿到所有被注解的方法。 它就是变相版的“onEvent开头”的做法。

甚至性能更低（因为算上了注解时消耗的时间空间），这就导致 GreenDao团队迟迟不肯使用这个注解+反射的原因。

直到他们使用了 AnnotationProcessor

• 3.0版本

提供了 EventBusAnnotationProcessor，它可以在编译时生成代码，避免了在运行时通过反射遍历所有方法的弊端。 在性能方面，超越之前任何版本

厉害归厉害，但是我之前一直认为这个 注解器是直接封装在 EventBus里面的，所以默认它会使用这种方法，直到我学习了AnnotationProcessor的用法…

1. findSubscriberMethods方法

============================================================================================

在EventBus的register()实现订阅者注册中，用到了 findSubscriberMethods()来获取订阅者声明的@Subscribe方法：

// EventBus.java

List findSubscriberMethods(Class<?> subscriberClass) {

List subscriberMethods = METHOD_CACHE.get(subscriberClass);

if (subscriberMethods != null) {

return subscriberMethods;

}

if (ignoreGeneratedIndex) { // 1

subscriberMethods = findUsingReflection(subscriberClass); // 2

} else {

subscriberMethods = findUsingInfo(subscriberClass); // 3

}

if (subscriberMethods.isEmpty()) {

throw new EventBusException("Subscriber " + subscriberClass

• " and its super classes have no public methods with the @Subscribe annotation");

} else {

METHOD_CACHE.put(subscriberClass, subscriberMethods);

return subscriberMethods;

}

}

第一次注册的订阅者会走到注释1处进行判断。

ignoreGeneratedIndex 这个字段的意思为 ：是否忽略索引生成

可以看出，这个字段用来判断订阅者是否使用索引加速。默认为false。

如果不使用索引加速，就会调用注释2： findUsingRelfection()，它通过反射得到订阅者类及其父类里所有方法，找到的被 @Subscribe注解的方法。和第0节中所讲的方式是一样的。

如果使用索引加速，就会调用注释3： findUsingInfo()，通过注解器方式获取。来看下这个方法：

// SubscriberMethodFinder.java

private List findUsingInfo(Class<?> subscriberClass) {

FindState findState = prepareFindState(); // 1

findState.initForSubscriber(subscriberClass); // 2

while (findState.clazz != null) {

findState.subscriberInfo = getSubscriberInfo(findState); // 3

if (findState.subscriberInfo != null) { // 4

SubscriberMethod[] array = findState.subscriberInfo.getSubscriberMethods();

for (SubscriberMethod subscriberMethod : array) {

if (findState.checkAdd(subscriberMethod.method, subscriberMethod.eventType)) {

findState.subscriberMethods.add(subscriberMethod);

}

}

} else {

findUsingReflectionInSingleClass(findState); // 5

}

findState.moveToSuperclass(); // 6

}

return getMethodsAndRelease(findState);

}

注释1：从 FindState池中获取一个 FindState对象，所以它的内容是空的。为什么使用 FindState池而不是 new一个出来，是因为EventBus是一个单例模式，一个进程只有一个EventBus，如果为了每个订阅者都要new一个FindState，那么其EventBus的内存空间就会有许许多多的FindState，为了优化性能，就创建 一个池子来循环利用。FindState的作用是用来描述 订阅者和订阅方法的关联信息。

注释2：将 订阅者对象 和注释1处获取到的FindState对象绑定，代码是这样的：

void initForSubscriber(Class<?> subscriberClass) {

this.subscriberClass = clazz = subscriberClass;

skipSuperClasses = false;

subscriberInfo = null; // 这里 subscriberInfo置null

}

注释3：通过 getSubscriberInfo(findState)来获取这个 订阅者的subscriberInfo

注释4： 如果subscriberInfo存在，就从 subscriberInfo中获取 @Subscribe方法

注释5：如果subscriberInfo不存在，就调用 findUsingReflectionInSingleClass(findState) 反射+暴力的方法寻找，就是一开始的findUsingReflection()

显然，注释3的获取的东西，可以验证我们有没有开启 索引加速。我们来看看这个方法：

// SubscriberMethodFiner.java

private SubscriberInfo getSubscriberInfo(FindState findState) {

if (findState.subscriberInfo != null && findState.subscriberInfo.getSuperSubscriberInfo() != null) { // 1

SubscriberInfo superclassInfo = findState.subscriberInfo.getSuperSubscriberInfo();

if (findState.clazz == superclassInfo.getSubscriberClass()) {

return superclassInfo;

}

}

if (subscriberInfoIndexes != null) { // 2

for (SubscriberInfoIndex index : subscriberInfoIndexes) {

SubscriberInfo info = index.getSubscriberInfo(findState.clazz);

if (info != null) {

return info;

}

}

}

return null;

}

注释1： 如果 findState.subcriberInfo 不为null，且其内容也不为null，就把那些东西取出来。

在上面 FindState的初始化，我们看到了会把它的 subcriberInfo置为null，所以如果是第一次执行，注释1的条件是会判断会false。就会往注释2走。

注释2：判断 subscriberInfoIndexes是否为空，如果不为空，则遍历所有，找到一个和 订阅者相匹配的 SubscriberInfo返回回去。

那subscriberInfoIndexes是什么？怎么来的呢？

首先它是一个 List<SubscriberInfoIndex>类型，它是一个列表，里面放的是 “订阅者索引”。

它在 EventBus的构造方法中被创建：

EventBus(EventBusBuilder builder) {

…

subscriberMethodFinder = new SubscriberMethodFinder(builder.subscriberInfoIndexes,

builder.strictMethodVerification, builder.ignoreGeneratedIndex);

…

}

可以看出它是来自于 EventBusBuilder，而在EventBusBuilder中， 这个对象又是怎么产生的呢，我通过源码，发现它只有一处地方用来操作这个列表：

// EventBusBuidler.java

/** Adds an index generated by EventBus’ annotation preprocessor. */

public EventBusBuilder addIndex(SubscriberInfoIndex index) {

if (subscriberInfoIndexes == null) {

subscriberInfoIndexes = new ArrayList<>();

}

subscriberInfoIndexes.add(index);

return this;

}

通过 addIndex()将 SubscriberInfoIndex 往这个列表里面加。再往上找，没有了，addIndex()没有出现在任意一处被调用的地方。

也就是说，这个方法，是外部调用的。

它的英文注释我翻译一下：通过EventBus的注解处理器添加一个索引 。

这就说明了这个方法，是由注解器产生的Java文件调用。这也说明了，如果我们不使用注解处理器，EventBus寻找 @Subcriber的做法，永远是 反射 + 遍历。

2. 通过EventBusAnnotationProcessor生成Java文件

==========================================================================================================

EventBusAnnotationProcessor 需要引入，示例代码如下：

// build.gradle

android {

defaultConfig {

javaCompileOptions {

annotationProcessorOptions {

arguments = [ eventBusIndex : ‘com.example.myapp.MyEventBusIndex’ ]

}

}

}

}

dependencies {

def eventbus_version = ‘3.2.0’

implementation “org.greenrobot:eventbus:$eventbus_version”

annotationProcessor “org.greenrobot:eventbus-annotation-processor:$eventbus_version”

}

然后在项目中，写入 @Subscribe方法：

public class MainActivity extends AppCompatActivity {

@Subscribe(threadMode = ThreadMode.MAIN)

public void onMainActivityEvent(MainActivityEvent event){

}

…

}

点击编译，就会在下图目录中看到编译时生成的文件：

来看下文件内容：

public class MyEventBusIndex implements SubscriberInfoIndex {

private static final Map<Class<?>, SubscriberInfo> SUBSCRIBER_INDEX;

static {

SUBSCRIBER_INDEX = new HashMap<Class<?>, SubscriberInfo>(); // 1

putIndex(new SimpleSubscriberInfo(MainActivity.class, true, new SubscriberMethodInfo[] {

new SubscriberMethodInfo(“onMainActivityEvent”, MainActivityEvent.class, ThreadMode.MAIN),

})); // 2

}

private static void putIndex(SubscriberInfo info) {

SUBSCRIBER_INDEX.put(info.getSubscriberClass(), info);

}

@Override

public SubscriberInfo getSubscriberInfo(Class<?> subscriberClass) { // 3

SubscriberInfo info = SUBSCRIBER_INDEX.get(subscriberClass);

if (info != null) {

return info;

} else {

return null;

}

}

}

注释1： 在静态代码块中， 创建一个 Map，key是所有的订阅者， value 是该订阅者所有的订阅方法

注释2：对每个订阅者，将其内部所有的 @Subscribe方法添加其 SubscriberMethodInfo[] 这个数组中，并封装到 SubscriberInfo中，put到注释1的Map中。

注释3：getSubscriberInfo()用来拿到对应订阅者的信息，在第一节中的 SubscriberMethodFiner.getSubscriberInfo()里面，我们看到的正是调用了这个方法。

但是如果我们默认情况下使用 EventBus.getDefault().register()是不会调用到这个方法的，因为默认方法并不会 赋值给subscriberInfoIndexes，所以我们要手动加入：

EventBus.builder().addIndex(new MyEventBusIndex()).installDefaultEventBus(); // 1

EventBus.getDefault().register(this);

注释1：通过 addIndex()把生成出来的Java文件加入进去，它会给 subscriberInfoIndexes赋值。这个方法只能使用一次，建议在Application的onCreate中使用。

到这里，索引的用法就结束了。通过使用索引，把搜索订阅方法的做法放在了编译时做，相比于运行时暴力搜索，性能相比可见一斑。官方给出了在Nexus5上性能图：

EventBus3.0在没有使用注解生成器的性能比2.x都低（我现在就是处在这个位置），但是使用索引之后，速度能快到究极独一档。所以没什么好说的，赶紧用了。

接下来我要分析一下EventBusAnnotationProcessor的源码，这部分不感兴趣的同学可以不看了。

3.EventBusAnnotationProcessor部分源码分析

====================================================================================================

3.1 process方法

---

AnnotationProcessor的关键地方都是在与 process()是怎么生成Java文件的，来看下它的 process()：

// EventBusAnnotationProcessor.java

public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment env) {

Messager messager = processingEnv.getMessager(); // 1

try {

String index = processingEnv.getOptions().get(OPTION_EVENT_BUS_INDEX); // 2

…

verbose = Boolean.parseBoolean(processingEnv.getOptions().get(OPTION_VERBOSE)); // 3

int lastPeriod = index.lastIndexOf(‘.’);

String indexPackage = lastPeriod != -1 ? index.substring(0, lastPeriod) : null; // 4

…

collectSubscribers(annotations, env, messager); // 5

checkForSubscribersToSkip(messager, indexPackage); // 6

if (!methodsByClass.isEmpty()) {

createInfoIndexFile(index); // 7

} …

} …

}

process() 仅留下比较关键的代码，其他非关键代码更多是容错相关。

注释1： 获取信使，它用来打印log，因为AnnotationProcessor组件是Java的，所以不能使用Android的Log工具来打印，它就起到这么一个作用。

注释2：OPTION_EVENT_BUS_INDEX就是我们在 gradle文件中写的 ： [eventBusIndex : 'xxx']的内容，通过注释2的方法，可以拿到当前项目EventBus的 eventBusIndex。它的作用是用来创建索引文件。

注释3：拿到verbose值，它同样在 gralde中拿，但是我们导包时没有写出来，annotationProcessor的完整导包是：

javaCompileOptions {

annotationProcessorOptions {

arguments = [ eventBusIndex : ‘com.example.myapp.MyEventBusIndex’

verbose : ‘true’]

}

}

这个 verbose如果为true，那我们注释1的信使就会在 编译时打印编译这些代码的log，如果为false则不打印。所以这个字段并不重要，我们一般都会忽略。

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。**

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

[外链图片转存中…(img-sYYghUsv-1715557794927)]

[外链图片转存中…(img-tSNFxANA-1715557794928)]

[外链图片转存中…(img-gKFCau4k-1715557794929)]

[外链图片转存中…(img-k0xbSVzw-1715557794930)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！