参考
EventBus—github
启舰— EventBus使用详解(一)——初步使用EventBus
启舰— EventBus使用详解(二)——EventBus使用进阶
Gadle
compile 'org.greenrobot:eventbus:3.0.0'
使用方法
涉及到三个地方
1. 新建一个消息类
2. 在你要接受消息的类里面,写一个onMessageEvent方法(新版本需要用注解),在这个方法内部去处理接受到的消息。还必须在生命周期方法里注册和注销EventBus
3. 在你要发消息的类里面,去发消息EventBus.getDefault().post(new MessageEvent(98));
Define events:
定义事件,新建一个类,一般这两个类里面会有几个属性,这个属性就是你要发送和传递的值
public static class MessageEvent { /* Additional fields if needed */ int age; public MessageEvent(int age){ this.age=age } public int getAge(){ return age; } }
Prepare subscribers: Declare and annotate your subscribing method, optionally specify a thread mode:
准备一个订阅者,声明一个方法(这个方法名可以随便起,因为他靠的是注解来识别方法),并用 @Subscribe注解这个方法,指定(可选)一个线程模式
在你要接受消息的Activity(Service)里添加下面的方法@Subscribe(threadMode = ThreadMode.MAIN) public void onMessageEvent(MessageEvent event) { /* Do something 拿到传递过来的数据 */ int age=evnt.getAge(); Log.e("tag",age+""); };
Register and unregister your subscriber. For example on Android, activities and fragments should usually register according to their life cycle:
在你要接受消息的Activity(Service)的生命周期方法中,注册和注销你的订阅者
@Override public void onStart() { super.onStart(); EventBus.getDefault().register(this); } @Override public void onStop() { super.onStop(); EventBus.getDefault().unregister(this); }
Post events:
发送事件,在另一个类(Activity)里面发送消息
EventBus.getDefault().post(new MessageEvent(98));
注意
- 消息的接收是根据参数中的类名(MessageEvent)来决定执行哪一个的,多个方法中参数类名一样的话,那么这多个方法都会收到消息
线程(threadMode = ThreadMode.MAIN)
ThreadMode.MAIN
ThreadMode.ASYNC
ThreadMode.BACKGROUND
ThreadMode.POSTING
对照旧版本去理解
onEvent:如果使用onEvent作为订阅函数,那么该事件在哪个线程发布出来的,onEvent就会在这个线程中运行,也就是说发布事件和接收事件线程在同一个线程。使用这个方法时,在onEvent方法中不能执行耗时操作,如果执行耗时操作容易导致事件分发延迟。onEventMainThread:如果使用onEventMainThread作为订阅函数,那么不论事件是在哪个线程中发布出来的,onEventMainThread都会在UI线程中执行,接收事件就会在UI线程中运行,这个在Android中是非常有用的,因为在Android中只能在UI线程中跟新UI,所以在onEvnetMainThread方法中是不能执行耗时操作的。
onEventBackground:如果使用onEventBackgrond作为订阅函数,那么如果事件是在UI线程中发布出来的,那么onEventBackground就会在子线程中运行,如果事件本来就是子线程中发布出来的,那么onEventBackground函数直接在该子线程中执行。
onEventAsync:使用这个函数作为订阅函数,那么无论事件在哪个线程发布,都会创建新的子线程在执行onEventAsync.
++++++补充+++++
EventBus3.0使用
使用场景
EventBus是一款针对Android优化的发布/订阅事件总线。简化了应用程序内各组件间、组件与后台线程间的通信。优点是开销小,代码更优雅,以及将发送者和接收者解耦。如果Activity和Activity进行交互还好说,如果Fragment和Fragment进行交互着实令人头疼,我们会使用广播来处理,但是使用广播稍显麻烦并且效率也不高,如果传递的数据是实体类需要序列化,那么很显然成本会有点高。今天我们就来学习下EventBus3.0的使用方法。(摘自http://blog.youkuaiyun.com/itachi85/article/details/52205464)
简单说:解决Activity、Service等四大组件以及Fragment,之前互相通讯的问题
用法场景一:
Activity之间互传数据
Activity1打开Activity2,在Activity2中发消息,在Activity1中接收消息,并且显示这个消息
一、定义一个类,这个类的对象就是我们要传递的消息,我们知道如果在Activity之间传递基本类型还好,通过intent的bundle直接传递就好,但是要传递一个自定义的对象,你需要序列化,这就很麻烦了,我们看看EventBus在传递对象时候是怎么进行的
import java.util.List;
/**
* Created by apple on 2017/12/20.
*/
public class SchoolBean {
private String name;
private String address;
private String president;
private List<GradeBean> mGradeBeanList;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
public String getPresident() {
return president;
}
public void setPresident(String president) {
this.president = president;
}
public List<GradeBean> getGradeBeanList() {
return mGradeBeanList;
}
public void setGradeBeanList(List<GradeBean> gradeBeanList) {
mGradeBeanList = gradeBeanList;
}
public SchoolBean(String name, String address, String president, List<GradeBean> gradeBeanList) {
this.name = name;
this.address = address;
this.president = president;
mGradeBeanList = gradeBeanList;
}
public static class GradeBean {
private String name;
private String teacher;
private int studentCount;
@Override
public String toString() {
return "GradeBean{" +
"name='" + name + '\'' +
", teacher='" + teacher + '\'' +
", studentCount=" + studentCount +
'}';
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getTeacher() {
return teacher;
}
public void setTeacher(String teacher) {
this.teacher = teacher;
}
public int getStudentCount() {
return studentCount;
}
public void setStudentCount(int studentCount) {
this.studentCount = studentCount;
}
public GradeBean(String name, String teacher, int studentCount) {
this.name = name;
this.teacher = teacher;
this.studentCount = studentCount;
}
}
}
二、Activity1
Activity1里面注册、反注册EventBus(注意一定要在onCreate和onDestroy里进行,Fragment的话是在onStart和onDestroy里面)
通过下面的方法接收消息
a. 必须使用注解@Subscribe
b. threadMode = ThreadMode.MAIN:表示在主线程接收消息
c. public void onMessageEvent(SchoolBean bean):这个方法名随便写,但是参数必须与发消息时候的类型相同,因为EventBus3.0以后是通过这个参数来区分接受那一个消息的
@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(SchoolBean bean) {
/* Do something 拿到传递过来的数据 */
List<SchoolBean.GradeBean> list = bean.getGradeBeanList();
String s =
bean.getName() + "\n" + bean.getAddress() + "\n" + bean.getPresident() + "\n";
for (int i = 0; i < list.size(); i++) {
String grade = list.get(i).toString();
s = s + grade + "\n";
}
tv.setText(s);
}
Activity1完整代码:
public class Activity1 extends Activity {
private Button bt;
private TextView tv;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_event1);
// 注意:如果是在Activity之间传递数据,必须把反注册写在onCreate里,不要写在onStart里
EventBus.getDefault().register(this);
bt = (Button) findViewById(R.id.bt);
tv = (TextView) findViewById(R.id.tv);
bt.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
startActivity(new Intent(Activity1.this, Activity2.class));
}
});
}
@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(SchoolBean bean) {
/* Do something 拿到传递过来的数据 */
List<SchoolBean.GradeBean> list = bean.getGradeBeanList();
String s =
bean.getName() + "\n" + bean.getAddress() + "\n" + bean.getPresident() + "\n";
for (int i = 0; i < list.size(); i++) {
String grade = list.get(i).toString();
s = s + grade + "\n";
}
tv.setText(s);
}
@Override
protected void onDestroy() {
super.onDestroy();
// 注意:如果是在Activity之间传递数据,必须把反注册写在onDestroy里,不要写在onStop里
EventBus.getDefault().unregister(this);
}
}
三、Activity2
Activity2是发送消息的,代码很简单,这里不需要注册、反注册EventBus,只需要下面一句话即可
EventBus.getDefault().post(schoolBean);
完整代码:
public class Activity2 extends Activity {
private TextView tv;
@Override
protected void onCreate(final Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_event2);
tv = (TextView) findViewById(R.id.tv);
Log.e("tag", 10 + "");
tv.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
List<SchoolBean.GradeBean> gradeList = new ArrayList<>();
gradeList.add(new SchoolBean.GradeBean("一年级", "王老师", 100));
gradeList.add(new SchoolBean.GradeBean("二年级", "张老师", 87));
gradeList.add(new SchoolBean.GradeBean("三年级", "李老师", 97));
SchoolBean schoolBean = new SchoolBean("北京市第一中心小学", "北京市朝阳区望京地区", "王校长", gradeList);
EventBus.getDefault().post(schoolBean);
finish();
}
});
}
}
看看发生了什么
EventBus3.0粘性事件
EventBus还支持发送黏性事件,就是在发送事件之后再订阅该事件也能收到该事件,为了验证粘性事件我们修改以前的代码:
在Activity1里先不去注册Eventbus,当点击按钮时,再去注册,此时也能收到消息)
- 订阅粘性事件
在Activity1中我们将注册事件添加到button的点击事件中(不在onCreate方法里一开始就注册EventBus):
bt1.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
//注册过就不要再注册了,会报错
if (!EventBus.getDefault().isRegistered(Activity1.this)){
EventBus.getDefault().register(Activity1.this);}
}
});
- 订阅者处理粘性事件
在Activity1中新写一个方法用来处理粘性事件:
主要是添加了:sticky = true
@Subscribe(threadMode = ThreadMode.MAIN,sticky = true)
public void onMessageEvent(SchoolBean bean) {
/* Do something 拿到传递过来的数据 */
List<SchoolBean.GradeBean> list = bean.getGradeBeanList();
String s =
bean.getName() + "\n" + bean.getAddress() + "\n" + bean.getPresident() + "\n";
for (int i = 0; i < list.size(); i++) {
String grade = list.get(i).toString();
s = s + grade + "\n";
}
tv.setText(s);
}
- 发送黏性事件
在Activity2中我们定义一个Button来发送粘性事件:
使用EventBus.getDefault().postSticky()
方法
tv.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
List<SchoolBean.GradeBean> gradeList = new ArrayList<>();
gradeList.add(new SchoolBean.GradeBean("一年级", "王老师", 100));
gradeList.add(new SchoolBean.GradeBean("二年级", "张老师", 87));
gradeList.add(new SchoolBean.GradeBean("三年级", "李老师", 97));
SchoolBean schoolBean = new SchoolBean("北京市第一中心小学", "北京市朝阳区望京地区", "王校长", gradeList);
EventBus.getDefault().postSticky(schoolBean);
finish();
}
});