事件总线,继承自观察者模式,也是基于发布订阅的机制来实现事件的发送与接收的。
Eventbus是一个专门为Android平台优化定制的事件总线函数库,在3.0版本之后,使用注解进行事件的订阅。在3.0的版本中,使用的注解类型为Runtime,因此在运行时会通过反射进行解析,会带来一定的性能损耗。
只需要在Module里面的build.gradle添加依赖即可以引用
compile 'org.greenrobot:eventbus:3.0.0'
Eventbus的使用
注册以及接收消息
注册
注册和注销的代码分别为:
EventBus.getDefault().register(this);
EventBus.getDefault().unregister(this);
一般而言,注册和取消注册时机应该和组件的生命周期相关联,对于Activity,应该在onStart/onStop对应注册取消,在界面销毁后没有取消注册,将会造成内存泄漏。在本人的测试中,使用界面A启动界面B,当B返回时不进行注销,使用LeakCanary进行检测,会检测到泄漏
@Override
protected void onStop() {
super.onStop();
//注释掉下面这句,将会产生泄漏
EventBus.getDefault().unregister(this);
}
接收消息
对于EventBus消息的接收,在3.0版本,方法名是任意的,但是必须进行@Subcribe的声明,@Subcribe的定义如下
@Documented
//为运行时注解
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface Subscribe {
//声明该方法运行在哪个线程,默认是发送线程,可见官网解释
ThreadMode threadMode() default ThreadMode.POSTING;
/**
* 如果是真,则接收最新的{@link EventBus#postSticky(Object)})消息
*这个可以用来解决界面跳转所带来的消息传递
*/
boolean sticky() default false;
/**
* 优先级,默认是0,数值越大等级越高,等级高的可以取消事件的传递
*/
int priority() default 0;
}
由上述解释,可以有以下的消息接收方式:
@Subscribe
public void eventGet(MessageEvent event){
bnChange.setText(event.getName() + "\n" + event.getMessage());
}
/**
* 粘性事件,注册的时候就会检测以前有没有该类型的消息,有的话就调用该方法
* @param event 自定义的事件,只会接受该类型的事件,默认还可以接收其子类的事件
*/
@Subscribe(sticky = true)
public void onActivityGet(SecondActivityEvent event){
textView.setText(event.getMsg());
}
对于消息的接收,主要是通过方法参数决定的, 所以如果有很多不同的事件对应不同的处理,那么需要自定义消息格式,否则会由于消息参数一致,否则参数相同的声明方法都将会被反射调用。
事件的发布
对于事件的发布,比较简单,主要有两种方式,见代码解释
/**
*发送普通消息,只用当前注册了该事件的订阅者才能够接收到消息
*/
EventBus.getDefault().post(new MessageEvent(integer.incrementAndGet() + "", "activity 传递事件"));
/**
*发送粘性事件,当前注册了该事件的订阅者能够接收到消息
* 此外,该事件会被EventBus保存,当有监听器注册并且方法的声明包括{@Subscribe(sticky = true)}
* 方法会被调用
* 注意:EventBus只会保存最新的一条消息,会把原来的消息覆盖掉
*/
EventBus.getDefault().postSticky(new SecondActivityEvent(integer.get() + ""));
对于第二个方法,在保存消息之后,还会再调用第一个方法。
使用总结
EventBus的使用比较简单,可以按照官网图的方式来进行理解。EventBus相当于邮箱,发布者直接把信息放到信箱,信箱会自动把信息发给订阅了的人。
构造函数原理
一般我们不需要显式创建EventBus的实例,直接通过调用EventBus#getDefault获取全局唯一单例即可,对于构造函数,可以通过下面的流程图解释:
具体的构造代码就不贴了, 可以自己下载源码查看.
EventBus#regiser流程及原理
整体注册流程如下所示:
相对来说整体流程还是比较清晰的, 有一些小细节没有在流程图绘制出来,注册的方法如下所示:
public void register(Object subscriber) {
Class<?> subscriberClass = subscriber.getClass();
List<SubscriberMethod> subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);
synchronized (this) {
for (SubscriberMethod subscriberMethod : subscriberMethods) {
subscribe(subscriber, subscriberMethod);
}
}
}
对于获取主体相对应的方法,在EventBus的官网上,有两种方法,一种是直接通过运行时反射获取,还有一种是通过EventBusAnnotationProcessor进行编译时期的@Subscribe注解解析。相对来说第二种方法会快很多。
还有一个就是对于主体里面声明了@Subscribe(Sticky = true)的方法,在绑定的时候就会进行反射调用,当然前提是本身EventBus有对应的消息。
EventBus#post流程及原理
对于整个发送事件, 流程图如下所示:
整个发送流程的源代码这里就不进行贴出了,主要注意的是,对于发送粘性事件的发送方式,其实也是会调用到普通的消息发送方式的。
public void postSticky(Object event) {
synchronized (stickyEvents) {
stickyEvents.put(event.getClass(), event);
}
// Should be posted after it is putted, in case the subscriber wants to remove immediately
post(event);
}
总结
这篇文章主要就是通过流程图来解释整个EventBus的工作过程,源码解释贴的比较少,可以自己去看源码结合流程图来进行分析。
github:https://github.com/ZCYL/TextCompile.git