本文章已授权玉刚说微信公众号转载
封装优化
今天将 EventBus 封装到基类中报错了
先翻译一下这段报错的提示，这个报错说的是这个 Activity 自己以及它的父类没有任何订阅的方法
于是乎我回去看了一下公司项目对 EventBus 的封装（PS：这个不是我封装的），我的同事采用的是在基类占位的方式
但是我有更好的写法，那种无意义的订阅方法占位写法不优雅，我们可以捕捉这个异常，让我们的 App 不会崩掉
我们要思考的一个问题，EventBus.register 的时候如果这个类里面没有订阅的方法会报错，那么问题来了，如果取消订阅的时候会不会报错呢？接下来让我们简单看一下源码
然而并不会抛异常，只是简单地打印了一个 log 日志，所以在 EventBus.unregister 方法中无需捕捉异常
但是我们可以再做一下优化，先判断当前对象有没有注册过 EventBus，有的话再取消注册
相关代码
public abstract class BaseActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
try {
EventBus.getDefault().register(this);
} catch (EventBusException ignored) {
// Subscriber class Activity and its super classes have no public methods with the @Subscribe annotation
}
}
@Override
protected void onDestroy() {
super.onDestroy();
if (EventBus.getDefault().isRegistered(this)) {
EventBus.getDefault().unregister(this);
}
}
}
APT 插件
在项目中集成 Apt 插件
android {
defaultConfig {
javaCompileOptions {
annotationProcessorOptions {
// EventBus Apt 索引类生成位置
arguments = [ eventBusIndex : applicationId + '.MyEventBusIndex' ]
}
}
}
}
dependencies {
implementation 'org.greenrobot:eventbus:3.1.1'
annotationProcessor 'org.greenrobot:eventbus-annotation-processor:3.1.1'
}
在 Application 中初始化 EventBus 的默认配置
// 初始化 EventBus
EventBus.builder()
.ignoreGeneratedIndex(false) // 使用 Apt 插件
.addIndex(new MyEventBusIndex()) // 添加索引类
.installDefaultEventBus(); // 作为默认配置
然后选择 Build -> Rebuild Project，前提是项目已经使用了 EventBus（项目中有 @Subscribe 注解的方法），否则没办法生成这个类
看过这段由 APT 自动生成的代码你是否焕然大悟了
/** This class is generated by EventBus, do not edit. */
public class MyEventBusIndex implements SubscriberInfoIndex {
private static final Map<Class<?>, SubscriberInfo> SUBSCRIBER_INDEX;
static {
SUBSCRIBER_INDEX = new HashMap<Class<?>, SubscriberInfo>();
putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.fragment.PersonFragment.class, true,
new SubscriberMethodInfo[] {
new SubscriberMethodInfo("onLoginEvent", com.gatewang.ksl.event.LoginEvent.class, ThreadMode.MAIN),
new SubscriberMethodInfo("onLoginOutEvent", com.gatewang.ksl.event.LoginOutEvent.class, ThreadMode.MAIN),
}));
putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.activity.MainActivity.class, true,
new SubscriberMethodInfo[] {
new SubscriberMethodInfo("goBackHomeEvent", com.gatewang.ksl.event.GoBackHomeEvent.class, ThreadMode.MAIN),
}));
putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.fragment.SJMBaseFragment.class, true,
new SubscriberMethodInfo[] {
new SubscriberMethodInfo("onEvent", String.class, ThreadMode.MAIN),
}));
putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.activity.LoginActivity.class, true,
new SubscriberMethodInfo[] {
new SubscriberMethodInfo("onLoginEventEvent", com.gatewang.ksl.event.LoginEvent.class, ThreadMode.MAIN),
}));
putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.activity.KSLBaseActivity.class, true,
new SubscriberMethodInfo[] {
new SubscriberMethodInfo("onEvent", String.class, ThreadMode.MAIN),
new SubscriberMethodInfo("onLoginOutEvent", com.gatewang.ksl.event.LoginOutEvent.class, ThreadMode.MAIN),
}));
putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.activity.SignInActivity.class, true,
new SubscriberMethodInfo[] {
new SubscriberMethodInfo("onLoginEvent", com.gatewang.ksl.event.LoginEvent.class, ThreadMode.MAIN),
}));
putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.fragment.ShopCartFragment.class, true,
new SubscriberMethodInfo[] {
new SubscriberMethodInfo("onRefreshShopCartEvent", com.gatewang.ksl.event.RefreshShopCartEvent.class,
ThreadMode.MAIN),
new SubscriberMethodInfo("onLoginEvent", com.gatewang.ksl.event.LoginEvent.class, ThreadMode.MAIN),
}));
}
private static void putIndex(SubscriberInfo info) {
SUBSCRIBER_INDEX.put(info.getSubscriberClass(), info);
}
@Override
public SubscriberInfo getSubscriberInfo(Class<?> subscriberClass) {
SubscriberInfo info = SUBSCRIBER_INDEX.get(subscriberClass);
if (info != null) {
return info;
} else {
return null;
}
}
}
接下来让我们看一下这段代码是个什么东西
那么它究竟是怎么提升 EventBus 效率的，可以看出来，这个 Apt 插件将那些订阅的方法生成到 MyEventBusIndex 中，那么这样做的好处是什么？试想一下，EventBus 的原理大概是什么样子的，EventBus.register 到底是怎么获取到这个类中被 @Subscribe 修饰的方法信息，相信用过注解的人都知道，注解只能通过反射获取得到。但是 EventBus 使用 Apt 自动生成的 MyEventBusIndex 类中，包含了这个类所有被注解的方法信息（方法名、事件对象、执行的线程等等），因为这样的话就不需要通过反射获取注解上面的信息了，因为这些信息已经被 Apt 自动生成到一个类里面了，在 EventBus.register 的时候会优先判断，有没有这个 MyEventBusIndex 类，有的话就从这个类获取，没有的话再通过反射获取，这样就能有效避免使用反射带来的性能问题
终极优化
学过 Apt 插件后，可以换一种更优雅更好的写法，这样就不需要捕捉代码块中的异常了
/**
* author : Android 轮子哥
* github : https://github.com/getActivity/AndroidProject
* time : 2019/04/02
* desc : EventBus 辅助类
*/
public final class EventBusHelper {
// EventBus 索引类
private static final SubscriberInfoIndex SUBSCRIBE_INDEX = new MyEventBusIndex();
// 这个类是否需要注册 EventBus
private static final ArrayMap<String, Boolean> SUBSCRIBE_EVENT = new ArrayMap<>();
// 不允许被外部实例化
private EventBusHelper() {}
/**
* 初始化 EventBus
*/
public static void init() {
EventBus.builder()
.ignoreGeneratedIndex(false) // 使用 Apt 插件
.addIndex(SUBSCRIBE_INDEX) // 添加索引类
.installDefaultEventBus(); // 作为默认配置
}
/**
* 注册 EventBus
*/
public static void register(Object subscriber) {
if (canSubscribeEvent(subscriber)) {
EventBus.getDefault().register(subscriber);
}
}
/**
* 反注册 EventBus
*/
public static void unregister(Object subscriber) {
if (canSubscribeEvent(subscriber) && EventBus.getDefault().isRegistered(subscriber)) {
EventBus.getDefault().unregister(subscriber);
}
}
/**
* 判断是否使用了 EventBus 注解
*
* @param subscriber 被订阅的类
*/
private static boolean canSubscribeEvent(Object subscriber) {
Class<?> clazz = subscriber.getClass();
// 这个 Class 类型有没有遍历过
Boolean result = SUBSCRIBE_EVENT.get(clazz.getName());
if (result != null) {
// 有的话直接返回结果
return result;
}
// 没有的话进行遍历
while (clazz != null) {
// 如果索引集合中有这个 Class 类型的订阅信息，则这个类型的对象都需要注册 EventBus
if (SUBSCRIBE_INDEX.getSubscriberInfo(clazz) != null) {
// 这个类需要注册 EventBus
result = true;
clazz = null;
} else {
String clazzName = clazz.getName();
// 跳过系统类（忽略 java. javax. android. androidx. 等开头包名的类）
if (clazzName.startsWith("java") || clazzName.startsWith("android")) {
clazz = null;
} else {
// 往上查找
clazz = clazz.getSuperclass();
}
}
}
// 这个类不需要注册 EventBus
if (result == null) {
result = false;
}
SUBSCRIBE_EVENT.put(subscriber.getClass().getName(), result);
return result;
}
@Subscribe(threadMode = ThreadMode.MAIN)
public void onEventBus(EventBusHelper helper) {
// 占位，只为了能生成 MyEventBusIndex 索引类
// 如果项目中已经有用到 @Subscribe 去注解方法，这个方法可以直接删除
}
}
public class BaseApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
// 初始化 EventBus
EventBusHelper.init();
}
}
public abstract class BaseActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// 注册 EventBus
EventBusHelper.register(this);
}
@Override
protected void onDestroy() {
super.onDestroy();
// 反注册 EventBus
EventBusHelper.unregister(this);
}
}
为什么要那么写呢？下篇文章我们将对 EventBus 的源码进行详细的解析
