Android 事件总线框架：EventBus

创作时间:

作者:

@小白创作中心

Android 事件总线框架：EventBus

引用

CSDN

https://m.blog.csdn.net/qq_36457184/article/details/144567369

EventBus是Android开发中常用的事件总线框架，它采用发布/订阅模式实现组件间的解耦通信。本文将详细介绍EventBus的使用方法、优势以及注意事项，帮助开发者更好地利用这一工具提升开发效率。

一. 简介

EventBus是一个适用于 Android 和 Java 的开源库，使用发布者/订阅者模式实现松散耦合。EventBus仅用几行代码即可实现与解耦类的集中通信 - 简化代码、消除依赖关系并加快应用开发速度。

二. 好处

简化组件间通信：
EventBus
允许组件之间进行松耦合通信，无需直接调用接口或依赖于特定的类。
减少代码量：减少样板代码，使得代码更加简洁和易于维护。
提高开发效率：开发者可以快速实现组件间的事件传递，从而提高开发效率。
跨组件通信：允许不同组件（如 Activity、Fragment、Service）之间进行通信，无需复杂的依赖注入。
处理异步任务：支持在不同的线程上处理事件，简化了异步任务的处理和 UI 更新。
粘性事件：提供粘性事件机制，这对于处理生命周期相关的事件非常有用。
易于集成和使用：集成简单，只需要添加依赖并遵循简单的使用规则即可。
体积小，速度快，高性能

三. 基本使用

1. 添加依赖：
在你的项目的
build.gradle
文件中添加 EventBus 的依赖。

dependencies {
    implementation 'org.greenrobot:eventbus:3.3.1' // 使用最新版本
}

2. 定义事件：
创建一个
Java
或
Kotlin
类来表示事件。这个类可以是简单的数据容器，也可以包含方法。

public class MessageEvent {
    private String message;
    public MessageEvent(String message) {
        this.message = message;
    }
    public String getMessage() {
        return message;
    }
}

3. 注册事件监听器：
在需要接收事件的组件（如 Activity、Fragment 或 Service）中注册监听器。

@Override
protected void onStart() {
    super.onStart();
    EventBus.getDefault().register(this);
}
@Override
protected void onStop() {
    super.onStop();
    EventBus.getDefault().unregister(this);
}

4. 定义事件处理方法：
在注册的组件中定义一个方法来处理事件。使用
@Subscribe
注解标记这个方法，并指定线程模式。这些方法将在发布事件时调用，
EventBus 3.x
可以自由定义方法名称。

@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(MessageEvent event) {
    // 处理事件，例如更新UI
    TextView textView = findViewById(R.id.text_view);
    textView.setText(event.getMessage());
}

5. 发送事件：
在需要的地方发送事件，比如在另一个 Activity 或者后台线程中。

EventBus.getDefault().post(new MessageEvent("Hello EventBus"));	// 发送事件

6. 处理事件的线程：
EventBus
允许你指定事件处理的线程。
ThreadMode
枚举提供了以下几种模式：

POSTING
：在发送事件的同一线程中处理事件（默认模式-避免了线程切换-开销最少）。
MAIN
：在主线程（UI线程）中处理事件, 如果在子线程发送消息 , 处理消息时会将线程切换成主线程。
MAIN_ORDERED
：在主线程（UI线程）中处理事件, 适用于需要保持事件处理顺序的场景。
BACKGROUND
：在后台线程中处理事件。
ASYNC
：在一个新的线程中异步处理事件。

7. 粘性事件：
粘性事件和普通事件的主要区别在于粘性事件能够跨越订阅者的生命周期，确保所有订阅者都能接收到最后一次的事件，而普通事件则只在它们被发送时活跃的订阅者可以接收。举个例子：

例如在
Activity1
中发送一个粘性事件
Event
，然后打开
Activity2
，在
Activity2
中注册
Event
的粘性事件订阅者，在注册后马上可以接收到该事件。而如果是普通事件的话是接收不到的，因为订阅者是在消息发送之后才注册的。

@Subscribe(sticky = true)
public void onStickyMessageEvent(MessageEvent event) {
    // 处理粘性事件
}

8. 取消粘性事件：
当不再需要粘性事件时，可以手动清除。

EventBus.getDefault().removeStickyEvent(MessageEvent.class);

9. 优先级：
可以在注册期间为订阅者提供优先级来更改事件传递的顺序。
priority：事件优先级， int 类型，默认为 0；数值越大，优先级越高，在相同线程模式(
ThreadMode
)下，优先级较高的订阅者将先于优先级较低的订阅者接收事件。
注意：优先级只有在相同线程模式下才有效。

@Subscribe(priority = 1);
public void onEvent(MessageEvent event) {
    ...
}

10. 取消事件传递：
可以通过从订阅者的事件处理方法中调用
cancelEventDelivery ( Object event )
来取消事件传递过程。任何进一步的事件传递都将被取消，后续订阅者将不会收到该事件。事件通常由优先级较高的订阅者取消，取消仅限于在发布线程 (ThreadMode.PostThread) 中运行的事件处理方法。
注意，只有 ThreadMode 为 POSTING 的订阅方法可以拦截消息。

// Called in the same thread (default)
@Subscribe
public void onEvent(MessageEvent event){
    // Process the event
    ...
    // Prevent delivery to other subscribers
    EventBus.getDefault().cancelEventDelivery(event) ;
}