EventBus使用详解

2401_83601703

于 2024-05-06 08:28:05 发布

阅读量945

点赞数 30

分类专栏：程序员文章标签： java android 开发语言

本文链接：https://blog.csdn.net/2401_83601703/article/details/138481586

版权

程序员专栏收录该内容

520 篇文章 2 订阅

订阅专栏

-keepattributes Annotation

-keepclassmembers class ** {

@org.greenrobot.eventbus.Subscribe ;

}

-keep enum org.greenrobot.eventbus.ThreadMode { *; }

使用之前了解EventBus的三个要素：

Event 事件。它可以是任意的Object类型，你可以自定义一个Class类。
Subscriber 事件订阅者。在EventBus3.0之前我们必须定义以onEvent开头的几个方法，分别是onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync，而在3.0之后事件处理的方法名可以随意取，不过需要加上注解@subscribe()，并且指定线程模型，默认是POSTING。
Publisher 事件的发布者。我们可以在任意线程里发布事件，一般情况下，使用EventBus.getDefault()就可以得到一个EventBus对象，然后再调用post(Object)方法即可。

EventBus的使用基本上分为简单的3个步骤：定义事件、注册事件订阅者、发布事件。

1.自定义一个事件：

public class MessageEvent {

private String message;

public MessageEvent(String message) {

this.message = message;

}

public String getMessage() {

return message;

}

public void setMessage(String message) {

this.message = message;

}

2.注册并订阅事件：

EventBus的注册和反注册需要成对出现，一般在onCreate和onDestroy方法，或者在onStart和onStop方法中。

public class MainActivity extends Activity {

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

EventBus.getDefault().register(this);

}

@Override

protected void onDestroy() {

super.onDestroy();

EventBus.getDefault().unregister(this);

}

订阅事件：

@Subscribe(threadMode = ThreadMode.MAIN)

public void onMessageEvent(MessageEvent event) {

…

}

这里方法名可以任意取，但必须添加@Subscribe注解（这里指定线程模型为主线程），方法参数即前面自定义的事件类。

3.发布事件：

EventBus.getDefault().post(new MessageEvent(“Hello EventBus!”));

下面简单例子，点击MainActivity按钮启动SecondActivity, 在SecondActivity中给MainActivity页面发送一个消息

public class MainActivity extends Activity implements View.OnClickListener {

private final static String TAG = MainActivity.class.getSimpleName();

private Button mGoBtn;

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

initView();

EventBus.getDefault().register(this);

}

private void initView() {

mGoBtn = (Button) findViewById(R.id.btn_go);

mGoBtn.setOnClickListener(this);

}

@Override

public void onClick(View v) {

switch (v.getId()) {

case R.id.btn_go:

Intent intent = new Intent(this, SecondActivity.class);

startActivity(intent);

break;

default:

break;

}

@Subscribe(threadMode = ThreadMode.MAIN)

public void onMessageEvent(MessageEvent event) {

//接收消息改变按钮文字并打印信息

mGoBtn.setText(event.getMessage());

Log.e(TAG, "onMessageEvent: " + event.getMessage());

}

@Override

protected void onDestroy() {

super.onDestroy();

EventBus.getDefault().unregister(this);

}

public class SecondActivity extends Activity implements View.OnClickListener {

private Button mSendBtn;

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_second);

initView();

}

private void initView() {

mSendBtn = (Button) findViewById(R.id.btn_send);

mSendBtn.setOnClickListener(this);

}

@Override

public void onClick(View v) {

switch (v.getId()) {

case R.id.btn_send:

//点击按钮给第一个页面发送消息

EventBus.getDefault().post(new MessageEvent(“Hello EventBus!”));

break;

default:

break;

}

注意发送方的页面如果不需要接收事件就不需要进行EventBus的注册，发送方只需要调用EventBus.getDefault().post()这句即可。

EventBus线程模式

EventBus支持订阅者和发布者在不同的线程中调用。你可以使用线程模式来指定调用订阅者方法的线程。EventBus总共支持5种线程模式：

ThreadMode.POSTING 订阅者方法将在发布事件所在的线程中被调用。这是默认的线程模式。事件的传递是同步的，一旦发布事件，所有该模式的订阅者方法都将被调用。这种线程模式意味着最少的性能开销，因为它避免了线程的切换。因此，对于不要求是主线程并且耗时很短的简单任务推荐使用该模式。使用该模式的订阅者方法应该快速返回，以避免阻塞发布事件的线程，这可能是主线程。
ThreadMode.MAIN 订阅者方法将在主线程（UI线程）中被调用。因此，可以在该模式的订阅者方法中直接更新UI界面。如果发布事件的线程是主线程，那么该模式的订阅者方法将被直接调用。使用该模式的订阅者方法必须快速返回，以避免阻塞主线程。
ThreadMode.MAIN_ORDERED 订阅者方法将在主线程（UI线程）中被调用。因此，可以在该模式的订阅者方法中直接更新UI界面。事件将先进入队列然后才发送给订阅者，所以发布事件的调用将立即返回。这使得事件的处理保持严格的串行顺序。使用该模式的订阅者方法必须快速返回，以避免阻塞主线程。
ThreadMode.BACKGROUND 订阅者方法将在后台线程中被调用。如果发布事件的线程不是主线程，那么订阅者方法将直接在该线程中被调用。如果发布事件的线程是主线程，那么将使用一个单独的后台线程，该线程将按顺序发送所有的事件。使用该模式的订阅者方法应该快速返回，以避免阻塞后台线程。
ThreadMode.ASYNC 订阅者方法将在一个单独的线程中被调用。因此，发布事件的调用将立即返回。如果订阅者方法的执行需要一些时间，例如网络访问，那么就应该使用该模式。避免触发大量的长时间运行的订阅者方法，以限制并发线程的数量。EventBus使用了一个线程池来有效地重用已经完成调用订阅者方法的线程。

例子：

public class MainActivity extends Activity implements View.OnClickListener {

private final static String TAG = MainActivity.class.getSimpleName();

private Button mGoBtn;

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

initView();

EventBus.getDefault().register(this);

}

private void initView() {

mGoBtn = (Button) findViewById(R.id.btn_go);

mGoBtn.setOnClickListener(this);

}

@Override

public void onClick(View v) {

switch (v.getId()) {

case R.id.btn_go:

Intent intent = new Intent(this, SecondActivity.class);

startActivity(intent);

break;

default:

break;

}

@Subscribe(threadMode = ThreadMode.POSTING)

public void onMessageEventPosting(MessageEvent event) {

Log.d(TAG, "onMessageEventPosting(), current thread is " + Thread.currentThread().getName());

}

@Subscribe(threadMode = ThreadMode.MAIN)

public void onMessageEventMain(MessageEvent event) {

Log.d(TAG, "onMessageEventMain(), current thread is " + Thread.currentThread().getName());

}

@Subscribe(threadMode = ThreadMode.MAIN_ORDERED)

public void onMessageEventMainOrdered(MessageEvent event) {

Log.d(TAG, "onMessageEventMainOrdered(), current thread is " + Thread.currentThread().getName());

}

@Subscribe(threadMode = ThreadMode.BACKGROUND)

public void onMessageEventBackground(MessageEvent event) {

Log.d(TAG, "onMessageEventBackground(), current thread is " + Thread.currentThread().getName());

}

@Subscribe(threadMode = ThreadMode.ASYNC)

public void onMessageEventAsync(MessageEvent event) {

Log.d(TAG, "onMessageEventAsync(), current thread is " + Thread.currentThread().getName());

}

@Override

protected void onDestroy() {

super.onDestroy();

EventBus.getDefault().unregister(this);

}

MainActivity订阅了MessageEvent事件，定义了5个不同线程模式的订阅者方法。当接收到MessageEvent事件时，订阅者方法将打印当前所在的线程名。

在SecondActivity当中点击发送按钮时，在名为"Publisher"的子线程中给MainActivity发送一个事件：

@Override

public void onClick(View v) {

switch (v.getId()) {

case R.id.btn_send:

new Thread(“Publisher”){

@Override

public void run() {

EventBus.getDefault().post(new MessageEvent(“Hello EventBus!”));

}

}.start();

break;

default:

break;

}

输出：

D/MainActivity: onMessageEventBackground(), current thread is Publisher

D/MainActivity: onMessageEventAsync(), current thread is pool-2-thread-1

D/MainActivity: onMessageEventPosting(), current thread is Publisher

D/MainActivity: onMessageEventMain(), current thread is main

D/MainActivity: onMessageEventMainOrdered(), current thread is main

EventBus粘性事件

EventBus粘性事件所处理的问题是：发布者先发送了事件，但是此时订阅者还未产生，一段时间后订阅者才订阅了该事件，也就是使得在发送事件之后订阅者再订阅该事件也能收到该事件。

比如需求是在第一个Activity中发送事件，然后启动第二个Activity接收事件进行处理，但此时在打开第二个Activity时是接收不到消息的，主要是因为第二个Activity在第一个Activity发送事件时还未完成EventBus的注册，此时就需要使用粘性事件处理。

接收粘性事件的订阅者方法注解必须添加sticky = true属性：

@Subscribe(sticky = true)

public void onMessageEvent(MessageEvent event) {

}

发布粘性事件使用postSticky():

EventBus.getDefault().postSticky(new MessageEvent(“Hello EventBus!”));

发布一个粘性事件之后，EventBus将一直缓存该粘性事件。如果想要移除粘性事件，那么可以使用如下方法：

// 移除指定的粘性事件

removeStickyEvent(Object event);

// 移除指定类型的粘性事件

removeStickyEvent(Class eventType);

// 移除所有的粘性事件

removeAllStickyEvents();

例子：

点击MainActivity的按钮时，先发送一个粘性事件，再启动SecondActivity

@Override

public void onClick(View v) {

switch (v.getId()) {

case R.id.btn_go:

EventBus.getDefault().postSticky(new MessageEvent(“Hello”));

Intent intent = new Intent(this, SecondActivity.class);

startActivity(intent);

break;

default:

break;

}

在打开的SecondActivity中订阅该事件：

public class SecondActivity extends Activity {

private final static String TAG = SecondActivity.class.getSimpleName();

private Button mSendBtn;

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_second);

initView();

EventBus.getDefault().register(this);

}

private void initView() {

mSendBtn = (Button) findViewById(R.id.btn_send);

}

@Subscribe(threadMode = ThreadMode.MAIN, sticky = true)

public void onMessageEvent(MessageEvent event) {

Log.i(TAG, "onMessageEvent: " + event.getMessage());

// 更新界面

mSendBtn.setText(event.getMessage());

// 移除粘性事件

EventBus.getDefault().removeStickyEvent(event);

}

@Override

protected void onDestroy() {

super.onDestroy();

EventBus.getDefault().unregister(this);

}

输出：

在这里插入图片描述

EventBus事件优先级

EventBus支持在定义订阅者方法时指定事件传递的优先级。默认情况下，订阅者方法的事件传递优先级为0。数值越大，优先级越高。在相同的线程模式下，更高优先级的订阅者方法将优先接收到事件。

注意：优先级只有在相同的线程模式下才有效。如果相同的线程模式下的订阅方法都没有指定优先级（默认优先级为 0），则接收事件的方法顺序会按照方法名的字母排序。

指定事件传递优先级需要在订阅方法注解上添加priority属性：

@Subscribe(priority = 1)

public void onMessageEvent(MessageEvent event) {

}

你可以在高优先级的订阅者方法接收到事件之后取消事件的传递。此时，低优先级的订阅者方法将不会接收到该事件。注意：订阅者方法只有在线程模式为ThreadMode.POSTING时，才可以取消一个事件的传递。

取消事件的传递使用cancelEventDelivery()方法：

@Subscribe(threadMode = ThreadMode.POSTING, priority = 1)

public void onMessageEvent(MessageEvent event) {

…

// 取消事件传递

EventBus.getDefault().cancelEventDelivery(event);

}

例子：

在MainActivity中指定不同优先级的订阅者方法

public class MainActivity extends Activity implements View.OnClickListener {

private final static String TAG = MainActivity.class.getSimpleName();

private Button mGoBtn;

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

initView();

EventBus.getDefault().register(this);

}

private void initView() {

mGoBtn = (Button) findViewById(R.id.btn_go);

mGoBtn.setOnClickListener(this);

}

@Override

public void onClick(View v) {

switch (v.getId()) {

case R.id.btn_go:

Intent intent = new Intent(this, SecondActivity.class);

startActivity(intent);

break;

default:

break;

}

@Subscribe(threadMode = ThreadMode.POSTING, priority = 1)

public void onMessageEvent1(MessageEvent event) {

Log.i(TAG, "onMessageEvent1(), message is " + event.getMessage());

}

@Subscribe(threadMode = ThreadMode.POSTING, priority = 2)

public void onMessageEvent2(MessageEvent event) {

Log.i(TAG, "onMessageEvent2(), message is " + event.getMessage());

}

@Subscribe(threadMode = ThreadMode.POSTING, priority = 3)

public void onMessageEvent3(MessageEvent event) {

Log.i(TAG, "onMessageEvent3(), message is " + event.getMessage());

// 取消事件传递

EventBus.getDefault().cancelEventDelivery(event);

}

@Subscribe(threadMode = ThreadMode.POSTING, priority = 4)

public void onMessageEvent4(MessageEvent event) {

Log.i(TAG, "onMessageEvent4(), message is " + event.getMessage());

}

@Subscribe(threadMode = ThreadMode.POSTING, priority = 5)

public void onMessageEvent5(MessageEvent event) {

Log.i(TAG, "onMessageEvent5(), message is " + event.getMessage());

}

@Override

protected void onDestroy() {

super.onDestroy();

EventBus.getDefault().unregister(this);

}

在MainActivity中订阅了MessageEvent事件，定义了5个不同优先级的订阅者方法。当接收到MessageEvent事件时，订阅者方法将打印日志消息。优先级为3的订阅者方法中在接收到事件之后取消了事件的传递。

在SecondActivity当中点击按钮时给MainActivity发送一个消息事件：

@Override

public void onClick(View v) {

switch (v.getId()) {

case R.id.btn_send:

EventBus.getDefault().post(new MessageEvent(“Hello EventBus!”));

break;

default:

break;

}

输出：

I/MainActivity: onMessageEvent5(), message is Hello EventBus!

I/MainActivity: onMessageEvent4(), message is Hello EventBus!

I/MainActivity: onMessageEvent3(), message is Hello EventBus!

可以看到只有优先级5、4、3的被打印出来了，优先级为2、1的事件被取消了。

注意，上面代码是在同一个页面MainActivity中定义了5个不同优先级的方法，假如是在不同页面的话，一旦调用了cancelEventDelivery()方法同样会起作用，即此时所有的页面中，凡是订阅该事件的方法优先级<=取消订阅方法的优先级的统统都不会再接收到事件了（不管线程模式是什么）。

在上面基础上我们在SecondActivity当中来添加几个跟MainActivity中相同优先级的订阅方法：

学习分享，共勉

Android高级架构师进阶之路

题外话，我在阿里工作多年，深知技术改革和创新的方向，Android开发以其美观、快速、高效、开放等优势迅速俘获人心，但很多Android兴趣爱好者所需的进阶学习资料确实不太系统，完整。今天我把我搜集和整理的这份学习资料分享给有需要的人

Android进阶知识体系学习脑图

Android进阶高级工程师学习全套手册

对标Android阿里P7，年薪50w+学习视频

大厂内部Android高频面试题，以及面试经历

《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！
ivity: onMessageEvent4(), message is Hello EventBus!

I/MainActivity: onMessageEvent3(), message is Hello EventBus!

可以看到只有优先级5、4、3的被打印出来了，优先级为2、1的事件被取消了。

在上面基础上我们在SecondActivity当中来添加几个跟MainActivity中相同优先级的订阅方法：

学习分享，共勉

Android高级架构师进阶之路

Android进阶知识体系学习脑图

[外链图片转存中…(img-xWuMpjJR-1714955273997)]

Android进阶高级工程师学习全套手册

[外链图片转存中…(img-2l4Ze9TL-1714955273998)]

对标Android阿里P7，年薪50w+学习视频

[外链图片转存中…(img-Dm7mEdEa-1714955273999)]

大厂内部Android高频面试题，以及面试经历

[外链图片转存中…(img-ZJvR56sB-1714955273999)]
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！

2401_83601703

关注

30
点赞
踩
19

收藏

觉得还不错? 一键收藏
0
评论
EventBus使用详解

-keepattributes Annotation-keepclassmembers class ** {@org.greenrobot.eventbus.Subscribe ;}-keep enum org.greenrobot.eventbus.ThreadMode { *; }使用之前了解EventBus的三个要素：Event 事件。它可以是任意的Object类型，你可以自定义一个Class类。Subscriber 事件订阅者。在EventBus3.0之前我们必须定义以onEvent开头的几个方法，
复制链接

扫一扫