EventBus 注册过程优化
EventBus是一个流行的Android开发库,使用非常方便,但是这个工具的使用并非一直都很顺利。下面是一段使用示例:
@Override
public void onStart() {super.onStart();EventBus.getDefault().register(this);
}@Override
public void onStop() {super.onStop();EventBus.getDefault().unregister(this);
}@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(MessageEvent event) {// Do something
}
这段示例对于了解EventBus使用的人来说非常简单,但是这里可能会遇到以下问题:
onMessageEvent
没用的时候删除这个方法,忘记删除register
和unregister
调用而导致异常;register
和unregister
方法没有成对出现,漏了unregister
就可能OOM;register
和unregister
方法出现的位置不匹配,比如一个在onCreate
而另一个在onStop
。
这些问题对于熟悉EventBus并开发谨慎的人肯定不会遇到,但智者千虑,必有一失,人总会有掉链子的时候。究其原因,还是归结到这段程序中该表达的东西没有表达清楚:
- 首先是
register
和unregister
必须成对出现这一隐式条件; - 然后是因为有
Subscribe
修饰的方法,所以需要register
。
优化方法
首先来解决第二点没有表达出因果关系的问题。只要程序中出现如下表达即可:
if containsSubscribeMethodregisterAndUnregister
elsedo nothing
并且这个过程可以自动调用,而非手动编写,理由是:这个类中存在Subscribe
注解修饰的方法,所以需要注册EventBus。因此可以把这个过程放在父类中,在对象初始化的时候进行。
因此我们可以在父类中编写下面这样的代码:
public abstract class BaseActivity extends AppCompatActivity {public BaseActivity() {registerLifecycleObserverForEventBus();}private void registerLifecycleObserverForEventBus() {boolean hasSubscribeMethod = Arrays.stream(getClass().getMethods()) //stream的使用需要desugar.filter(method -> Modifier.isPublic(method.getModifiers())).anyMatch(method -> method.getAnnotation(Subscribe.class) != null);if (hasSubscribeMethod) {//register and unregister}}
}
这样子类中只要有包含Subscribe
注解修饰的方法,就能自动启用EventBus,不会出现漏掉的问题;删除对应方法以后,也不需要检查并删除对应register
和unregister
调用。
然后是register
和unregister
方法的调用位置问题。onCreate
对应onDestroy
,onStart
对应onStop
,onResume
对应onDestroy
。所以我们需要有方法来告知在何时注册,这里可以新增一个可选注解,用来修饰类:
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface SubscriberInfo {Lifecycle.Event registerOn() default Lifecycle.Event.ON_CREATE;
}
没有该注解时,默认的调用时机是onCreate
对应onDestroy
,所以完整实现如下:
public abstract class BaseActivity extends AppCompatActivity {public BaseActivity() {registerLifecycleObserverForEventBus();}private void registerLifecycleObserverForEventBus() {boolean hasSubscribeMethod = Arrays.stream(getClass().getMethods()).filter(method -> Modifier.isPublic(method.getModifiers())).anyMatch(method -> method.getAnnotation(Subscribe.class) != null);SubscriberInfo subscriberInfoInfo = getClass().getAnnotation(SubscriberInfo.class);Lifecycle.Event registerOnEvent = subscriberInfoInfo == null ? Lifecycle.Event.ON_CREATE : subscriberInfoInfo.registerOn();if (hasSubscribeMethod) {switch (registerOnEvent) {case ON_CREATE: {getLifecycle().addObserver(new DefaultLifecycleObserver() {@Overridepublic void onCreate(@NonNull @NotNull LifecycleOwner owner) {DefaultLifecycleObserver.super.onCreate(owner);EventBus.getDefault().register(BaseActivity.this);}@Overridepublic void onDestroy(@NonNull @NotNull LifecycleOwner owner) {DefaultLifecycleObserver.super.onDestroy(owner);EventBus.getDefault().unregister(BaseActivity.this);}});break;}case ON_START: {getLifecycle().addObserver(new DefaultLifecycleObserver() {@Overridepublic void onStart(@NonNull @NotNull LifecycleOwner owner) {DefaultLifecycleObserver.super.onStart(owner);EventBus.getDefault().register(BaseActivity.this);}@Overridepublic void onStop(@NonNull @NotNull LifecycleOwner owner) {DefaultLifecycleObserver.super.onStop(owner);EventBus.getDefault().unregister(BaseActivity.this);}});break;}case ON_RESUME: {getLifecycle().addObserver(new DefaultLifecycleObserver() {@Overridepublic void onResume(@NonNull @NotNull LifecycleOwner owner) {DefaultLifecycleObserver.super.onResume(owner);EventBus.getDefault().register(BaseActivity.this);}@Overridepublic void onPause(@NonNull @NotNull LifecycleOwner owner) {DefaultLifecycleObserver.super.onPause(owner);EventBus.getDefault().unregister(BaseActivity.this);}});break;}default:throw new IllegalStateException("unsupported event:" + registerOnEvent);}}}
}
这样在子类Activity
就不用去管注册的事情了,如果需要额外指定注册时机,就添加SubscriberInfo
注解:
@SubscriberInfo(registerOn = Lifecycle.Event.ON_START)
public class MainActivity extends BaseActivity {//......
}