使用方法
//注册事件
EventBus.getDefault().register(Object subscriber);
//注销事件
EventBus.getDefault().unregister(Object subscriber);
//发送
EventBus.getDefault().post(Object event);
//接收
//这里的方法名不是关键所在,关键是发送的Object和接收的Object需要保持一致
//@Subscribe注解中有三个参数,具体作用详见@Subscribe
@Subscribe(threadMode = ThreadMode.MAIN,sticky = true, priority = 1)
public void onEvent(Object event) {
Log.i("eventbus", event.toString());
}
@Subscribe
当方法添加了该注解的时候,就可以接收发送者发出的消息了
//订阅者注解添加后,就可以监听和接收发送来的消息
package org.greenrobot.eventbus;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
//生成javadoc文档
@Documented
//注解的生命周期:注解不仅被保存到class文件中,jvm加载class文件之后,仍然存在
@Retention(RetentionPolicy.RUNTIME)
//注解的作用域:只允许方法使用该注解
@Target({ElementType.METHOD})
//在方法上标记该注解就能够接收到到订阅的特定信息
public @interface Subscribe {
//订阅者接收信息的线程模式
ThreadMode t hreadMode() default ThreadMode.POSTING;
/**
* 如果为true,则传递最近的粘性事件。
* 使用EventBus.postStickey(Object)传递给该订阅者(如果事件可用)。
*/
boolean sticky() default false;
/** 订阅者优先级,以影响事件交付的顺序。
* 在同一个交付线程({@link ThreadMode})中,优先级较高的订阅者将比优先级较低的订阅者更早接收事件。 * 默认优先级为0。
* 注意:优先级不影响具有不同{@link ThreadMode}的订阅者之间的交付顺序!
*/
int priority() default 0;
}
- ThreadMode threadMode()
- ThreadMode 是enum(枚举)类型
- threadMode默认值是POSTING
- ThreadMode有四种模式:
- POSTING
- 订阅者将在发布事件的同一线程中直接调用。
- 这是默认值。
- 事件交付意味着开销最小,因为它完全避免了线程切换。
- 因此,这是推荐的模式,不需要主线程就可以在很短的时间内完成的简单任务。
- 事件处理程序使用此模式必须快速返回,以避免阻塞可能是主线程的发布线程。
- MAIN
- 在Android上,订阅者将在Android的主线程(UI线程)中被调用。
- 如果发布线程是主线程,订阅者方法将被直接调用,从而阻塞发布线程。
- 否则事件排队等待交付(非阻塞)。
- 使用此模式的订阅者必须快速返回,以避免阻塞主线程。
- 如果不在Android上,其行为与POSTING相同。
- MAIN_ORDERED
- 在Android上,订阅者将在Android的主线程(UI线程)中被调用。
- 与MAIN不同,事件将始终排队等待交付。
- 这确保post调用是非阻塞的。
- BACKGROUND
- 在Android上,订阅者将在后台线程中调用。
- 如果发布线程不是主线程,则将直接在发布线程中调用订阅者方法。
- 如果发布线程是主线程,EventBus使用一个后台线程,它将按顺序交付所有事件。
- 使用此模式的订阅者应尝试快速返回,以避免阻塞后台线程。
- 如果不是在Android上,总是使用后台线程。
- ASYNC
- 订阅者将在单独的线程中调用。
- 这总是独立于发布线程和主线程。
- 发布事件从不使用此模式等待订阅者方法。
- 如果订阅者方法的执行可能需要一些时间,例如网络访问,则应使用此模式。
- 避免同时触发大量长时间运行的异步订阅方方法来限制并发线程的数量。
- EventBus使用线程池来有效地重用来自已完成异步订阅方通知的线程。
- POSTING
- boolean sticky()
- sticky(粘性)默认值是false
- 如果是true,那么可以通过EventBus的postSticky方法分发最近的粘性事件给该订阅者(前提是该事件可获得)。
- int priority()
- Method的优先级
- 优先级高的可以先获得分发的事件。
- 这个不会影响不同的ThreadMode的分发事件顺序。也就是同一线程中的先后顺序