EventBus学习笔记
使用方法
(1)首先需要定义一个消息类,该类可以不继承任何基类也不需要实现任何接口。
例如:
public class MessageEvent{
private String mMsg;
public MessageEvent (String msg) {
mMsg = msg;
}
public String getMsg(){
return mMsg;
}
}
(2)在需要订阅事件的地方注册事件。比如activity的oncreate中,或者Application的onCreate方法中。
EventBus.getDefault().register(this);
(3)产生事件,即发送消息。
EventBus.getDefault().post(messageEvent);
(4)处理消息.
@Subscribe(threadMode = ThreadMode.Main)
public void XXX(MessageEvent messageEvent) {
...
}
在3.0之前,EventBus还没有使用注解方式。消息处理的方法也只能限定于onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync,分别代表四种线程模型。
onEvent: 如果使用onEvent作为订阅函数,那么该事件在哪个线程发布出来的,onEvent就会在这个线程中运行,也就是说发布事件和接收事件线程在同一个线程。使用这个方法时,在onEvent方法中不能执行耗时操作,如果执行耗时操作容易导致事件分发延迟。
onEventMainThread: 如果使用onEventMainThread作为订阅函数,那么不论事件是在哪个线程中发布出来的,onEventMainThread都会在UI线程中执行,接收事件就会在UI线程中运行,这个在Android中是非常有用的,因为在Android中只能在UI线程中跟新UI,所以在onEvnetMainThread方法中是不能执行耗时操作的。
onEventBackground: 如果使用onEventBackgrond作为订阅函数,那么如果事件是在UI线程中发布出来的,那么onEventBackground就会在子线程中运行,如果事件本来就是子线程中发布出来的,那么onEventBackground函数直接在该子线程中执行。
onEventAsync: 使用这个函数作为订阅函数,那么无论事件在哪个线程发布,都会创建新的子线程在执行onEventAsync.
而在3.0之后,消息处理的方法可以随便取名,但是需要添加一个注解@Subscribe,并且要指定线程模型(默认为PostThread),四种线程模型,下面会讲到。
(5)取消消息订阅.
EventBus.getDefault().unregister(this);
线程模式
public enum ThreadMode {
POSTING,///事件的处理在和事件的发送在相同的进程(如果在子线程中发布消息,则收到的消息也在子线程中)
MAIN,///事件的处理会在UI线程中执行
BACKGROUND,///事件的处理会在一个后台线程中执行,尽管是在后台线程中运行,事件处理时间不应太长。
如果事件分发在主线程,件会被加到一个队列中,由一个线程依次处理这些事件,如果某个事件处理时间太长,会阻塞后面的事件的派发或处理。
如果事件分发在后台线程,事件会立即执行处理。
ASYNC ///事件处理会在单独的线程中执行,主要用于在后台线程中执行耗时操作,每个事件会开启一个线程(有线程池),但最好限制线程的数目。
}
黏性事件
类似broadcast中的Sticky Broadcast,消息先发送,等到注册之后还可以收到订阅消息。
它只能收到最新的一次消息。
public class StickyEventBusActivity extends AppCompatActivity {
private int index = 0;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.sticky_eventbus);
findViewById(R.id.post).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
EventBus.getDefault().postSticky(new MessageEvent("test :: " + index++));
}
});
findViewById(R.id.regist).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
EventBus.getDefault().register(StickyEventBusActivity.this);
}
});
findViewById(R.id.unregist).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
EventBus.getDefault().unregister(StickyEventBusActivity.this);
}
});
}
@Subscribe(threadMode = ThreadMode.POSTING, sticky = true)
public void onMessageEventPostThread(MessageEvent messageEvent) {
Log.e(EventBusActivity1.TAG, "onMessageEventPostThread POSTING : "+messageEvent.getMsg());
}
@Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
public void onMessageEventMainThread(MessageEvent messageEvent) {
Log.e(EventBusActivity1.TAG, "onMessageEventMainThread : "+messageEvent.getMsg());
}
@Subscribe(threadMode = ThreadMode.BACKGROUND, sticky = true)
public void onMessageEventBackgroundThread(MessageEvent messageEvent) {
Log.e(EventBusActivity1.TAG, "onMessageEventBackgroundThread : "+messageEvent.getMsg());
}
@Subscribe(threadMode = ThreadMode.ASYNC, sticky = true)
public void onMessageEventAsync(MessageEvent messageEvent) {
Log.e(EventBusActivity1.TAG, "onMessageEventAsync : "+ messageEvent.getMsg());
}
}
感谢
很多关于eventbus的介绍文章的作者们。