EventBus解析说明(一基本使用)
简介
介绍:是一个Android的事件发布和订阅的框架,用来实现订阅者和发布者的解耦,来简化事件的传递。当代码量非常大的时候,我们常用的handler,broadcast,接口回调等,会让代码比较复杂,可能耦合比较高,而EventBus在事件传递就有着很NB的功能。(当然我们在其中没有解释的地方,接下来我都会有具体介绍)
使用流程
构建消息发送类
public class Event {
private String eventMessage;
public Event(String eventMessage) {
this.eventMessage = eventMessage;
}
public void setEventMessage(String eventMessage) {
this.eventMessage = eventMessage;
}
public String getEventMessage() {
return eventMessage;
}
}
注册和注销事件(成为订阅者和取消订阅)
EventBus.getDefault().register(this);
EventBus.getDefault().unregister(this);
具体的流程代码
// 主页面,实现注册
public class MainActivity extends AppCompatActivity implements View.OnClickListener {
private TextView tvShow;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
tvShow = findViewById(R.id.tv_show);
Button btnEventBus1 = findViewById(R.id.btn_event_bus_1);
Button btnEventBus2 = findViewById(R.id.btn_event_bus_2);
btnEventBus1.setOnClickListener(this);
btnEventBus2.setOnClickListener(this);
EventBus.getDefault().register(this);
}
@Override
public void onClick(View v) {
switch (v.getId()) {
case R.id.btn_event_bus_1:
// 跳转界面发送事件,非sticky事件
startActivity(new Intent(this, EventBusActivity.class));
break;
case R.id.btn_event_bus_2:
// 发送sticky事件
EventBus.getDefault().postSticky(new Event("hello android"));
startActivity(new Intent(this, EventBus2Activity.class));
break;
default:
break;
}
}
@Override
protected void onDestroy() {
super.onDestroy();
// 解除订阅并移除sticky事件
EventBus.getDefault().unregister(this);
EventBus.getDefault().removeAllStickyEvents();
}
@Subscribe(threadMode = ThreadMode.MAIN)
public void setText(Event event) {
tvShow.setText(event.getEventMessage());
}
}
// 演示一般事件
public class EventBusActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_event_bus);
findViewById(R.id.btn_send_message).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// 发布事件(MainActivity用接受,在此之前,主页面要提前注册完毕)
EventBus.getDefault().post(new Event("hello android"));
finish();
}
});
}
}
// 演示sticky事件
public class EventBus2Activity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_event_bus2);
findViewById(R.id.btn_send_sticky_message).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
finish();
}
});
// 注意:这个时候才注册,意味者post之后才注册
EventBus.getDefault().register(this);
}
// 这个注解很重要,是订阅者的方法标志
@Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
public void setStickyText(Event event) {
Toast.makeText(this, "hello sticky", Toast.LENGTH_SHORT).show();
}
@Override
protected void onDestroy() {
super.onDestroy();
EventBus.getDefault().unregister(this);
}
}
接下来我们就来分析以下注解(简单使用怎么能没有注解)
@Documented // 是一个javadoc文档
@Retention(RetentionPolicy.RUNTIME) // 指定可以在运行时有效
@Target({ElementType.METHOD}) // 用来描述方法
public @interface Subscribe {
// 注意这个(这个与我将要介绍的三个poster对应)mainThread,background,async对应)
ThreadMode threadMode() default ThreadMode.POSTING;
// 是否时粘性事件
boolean sticky() default false;
// 优先级
int priority() default 0;
}
// 这个我后面还会介绍
public enum ThreadMode {
POSTING,// 在post发布事件的时候,不管发布在什么线程,直接调用订阅者事件方法
MAIN,// 在post发布事件的时候,发布在主线程才调用订阅者事件方法,否则通过mainThreadPoster处理
BACKGROUND, //发布者不在主线程,通过启动唯一后台线程处理(和async可以通过我的poster分析对比)
ASYNC // 不管订阅者处在什么线程,post之后,都会使用一个空线程执行订阅者方法
}
小结
首先我们发布事件有两种,post和postSticky,前者在订阅者接受事件的时候必须要提前注册,后者可以在事件发布时候注册。注意,我们在注册和注销的时候,最好和Activity或者和Fragment的生命周期保持一致。