Android 事件总线(EventBus)

简介

在Android开发中，事件总线是一种通信模式，用于在应用程序的不同组件之间传递消息和事件。事件总线允许组件之间解耦，减少了它们之间的直接依赖关系，从而使应用程序更易于维护和扩展。事件总线模式通常包括以下关键组件：

1. 事件发布者（Event Publisher）：这是生成事件或消息的组件。事件发布者通常将事件发布到事件总线，而不需要知道哪些组件会接收这些事件。

2. 事件订阅者（Event Subscriber）：这是订阅事件的组件，它们监听事件总线以接收感兴趣的事件。事件订阅者只需关心它们感兴趣的事件，而不需要了解事件是如何生成的。

3. 事件总线（Event Bus）：事件总线是中介，负责接收事件并将它们分发给订阅了这些事件的组件。它维护了事件的发布和订阅关系，并确保事件传递到正确的订阅者。

Android中有多种事件总线库可供开发人员使用，其中最常用的是GreenRobot的EventBus和Square的Otto（已停止维护）。这些库提供了简单的API，允许开发人员实现事件总线模式，以实现组件之间的松耦合通信。

使用事件总线的好处包括：

• 解耦：组件之间不需要直接引用彼此，它们只需要连接到事件总线并订阅它们感兴趣的事件。

• 简化通信：事件总线提供了一种简单的方式来处理组件之间的通信，特别是在不同线程之间。

• 松耦合：组件之间的松耦合性使得更容易测试和维护应用程序。

EventBus 是一个事件总线库，它用于简化 Android 应用中Activity,Fragment,Thread,Service之间的通信。通过 EventBus，您可以实现发布-订阅模式，允许不同组件之间以一种松耦合的方式进行通信，从而提高代码的可维护性和可扩展性。尽管事件总线是一个强大的工具，但在使用它时需要小心，以避免滥用或过度使用。在某些情况下，事件总线可能会引入不必要的复杂性，因此应该根据具体的应用需求来决定是否使用它。

EventBus三要素

EventBus 的设计基于三个核心要素，这些要素有助于理解和使用 EventBus。这三个要素是：

1. 事件（Event）：

   • 事件是信息或数据的载体，它用于在不同组件之间传递信息。
   • 事件可以是任何普通的 Java 对象，通常是自定义的类。
   • 事件类通常包含数据和方法来访问和操作这些数据。
   • 事件是通过 EventBus 发布和传递的，订阅者可以根据需要订阅不同类型的事件。

   例如，一个简单的事件类可以如下所示：

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

2. 发布者（Publisher）：

   • 发布者是事件的发送方，它负责将事件发布到 EventBus 中，以便其他组件可以接收和处理这些事件。
   • 发布者使用 EventBus 的 post 方法来发布事件。

   例如，在某个地方的代码中，您可以使用以下方式发布事件：

   EventBus.getDefault().post(new MessageEvent("Hello, EventBus!"));
   

3. 订阅者（Subscriber）：

   • 订阅者是事件的接收方，它订阅了特定类型的事件，并在事件发生时执行相应的操作。
   • 订阅者需要注册到 EventBus 中，以便接收事件。通常，在组件的生命周期方法（如 onCreate）中注册，并在生命周期结束时（如 onDestroy）取消注册。
   • 订阅者使用 @Subscribe 注解标记其方法，以告知 EventBus 哪些方法应该处理哪些事件。
   • 事件处理方法可以包含一个或多个参数，参数类型决定了接收的事件类型。

   例如，以下是一个订阅者方法，用于处理 MessageEvent 类型的事件：

   @Subscribe
   public void onMessageEvent(MessageEvent event) {
       String message = event.getMessage();
       // 处理收到的消息
   }
   

这三个要素共同构成了 EventBus 的基本工作原理，允许在 Android 应用中实现组件之间的松耦合通信。通过事件、发布者和订阅者的组合，您可以实现更清晰、模块化和可维护的应用程序设计。

EventBus的4中ThreadMode(线程模型)

EventBus 提供了四种线程模型（ThreadMode），用于确定订阅者接收事件时所在的线程。选择适当的线程模型可以帮助您处理事件时的线程安全性和性能问题。以下是 EventBus 支持的四种线程模型：

1. POSTING（默认模式）：

   • 订阅者方法在发布事件的线程中执行。
   • 这是 EventBus 的默认线程模型。
   • 使用 POSTING 模式的订阅者方法应该尽量快速执行，以避免阻塞事件发布线程。

2. MAIN（主线程模型）：

   • 订阅者方法在主线程（UI 线程）中执行。
   • 这意味着您可以在订阅者方法中直接更新 UI，因为它在主线程上执行。
   • 请注意，在主线程上执行耗时操作会导致应用程序界面卡顿。

   @Subscribe(threadMode = ThreadMode.MAIN)
   public void onEventInMainThread(MessageEvent event) {
       // 在主线程上处理事件
   }
   

3. BACKGROUND（后台线程模型）：

   • 订阅者方法在一个后台线程中执行。
   • 如果事件是在主线程发布的，EventBus 会自动为您创建一个后台线程来执行订阅者方法。
   • 这可以用于执行不涉及 UI 更新的耗时操作，以避免阻塞主线程。

   @Subscribe(threadMode = ThreadMode.BACKGROUND)
   public void onEventInBackgroundThread(MessageEvent event) {
       // 在后台线程上处理事件
   }
   

4. ASYNC（异步线程模型）：

   • 订阅者方法总是在一个新的后台线程中执行。
   • 使用 ASYNC 模式可以确保订阅者方法不会阻塞事件发布线程或主线程。
   • 这适用于需要执行耗时操作的情况。

   @Subscribe(threadMode = ThreadMode.ASYNC)
   public void onEventInAsyncThread(MessageEvent event) {
       // 在异步线程上处理事件
   }
   

选择适当的线程模型取决于您的需求。通常，如果事件处理需要更新 UI，则应使用 MAIN 模型。如果事件处理可能会耗时较长，则可以考虑使用 BACKGROUND 或 ASYNC 模型来将处理操作移到后台线程，以保持应用的响应性。注意，不同线程模型的选择可能会影响您的事件处理代码的编写方式。

黏性事件

黏性事件（Sticky Events）是 EventBus 中的一种特殊事件，与普通事件不同之处在于它们会在事件发布后仍然保留在事件总线中，直到被显式移除或消耗。黏性事件的主要用途是允许订阅者在订阅之前接收最新的事件状态，即使事件已经发生，就是在发送事件之后在订阅事件也能收到该事件。

以下是黏性事件的关键特性和用法：

1. 事件保留：普通事件在发布后，如果没有被订阅者接收，将会被丢弃。而黏性事件会一直保留在事件总线中，直到被手动移除。

2. 获取最新状态：黏性事件允许订阅者在订阅时获取最新的事件状态，即使事件在订阅之前已经发布。这对于获取应用程序的当前状态非常有用。

3. 手动移除：黏性事件可以手动从事件总线中移除，以避免它们在不再需要时继续存在。

以下是在 EventBus 中使用黏性事件的示例：

发布黏性事件：

EventBus.getDefault().postSticky(new MessageEvent("Sticky Event"));

订阅黏性事件：

@Subscribe(sticky = true)
public void onStickyEvent(MessageEvent event) {
    // 处理黏性事件，可以获取最新状态
}

手动移除黏性事件：

// 从事件总线中移除指定类型的黏性事件
EventBus.getDefault().removeStickyEvent(MessageEvent.class);

// 或者，移除所有的黏性事件
EventBus.getDefault().removeAllStickyEvents();

通过使用黏性事件，您可以更灵活地处理事件，特别是在需要获取最新状态或在订阅之前获取事件状态时。请谨慎使用黏性事件，确保在适当的时候移除它们，以避免不必要的内存占用和事件处理。

基本用法

以下是使用 EventBus 学习的一些建议步骤：

1. 导入 EventBus 库：首先，您需要在您的 Android 项目中导入 EventBus 库。您可以通过 Gradle 在您的项目中添加 EventBus 依赖。

   implementation 'org.greenrobot:eventbus:3.2.0'
   

2. 创建事件类：您需要定义事件类，这些事件类将用于在不同组件之间传递信息。事件类通常是一个普通的 Java 类，不需要实现任何接口或继承特定的父类。例如：

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

3. 注册和注销事件：在您的组件（Activity、Fragment 或其他类）中，您需要注册和注销 EventBus。通常，这是在组件的 onCreate 和 onDestroy 方法中完成的。

   @Override
   public void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       EventBus.getDefault().register(this);
   }
   
   @Override
   public void onDestroy() {
       super.onDestroy();
       EventBus.getDefault().unregister(this);
   }
   

4. 发布事件：当您想要发送事件时，您可以使用 EventBus 的 post 方法。

   EventBus.getDefault().post(new MessageEvent("Hello, EventBus!"));
   

5. 订阅事件：要订阅事件并处理它们，您需要在订阅者方法上添加 @Subscribe 注解，并在方法中定义处理逻辑。

   @Subscribe
   public void onMessageEvent(MessageEvent event) {
       String message = event.getMessage();
       // 处理收到的消息
   }
   

6. 启用事件分发：在订阅者方法中处理事件时，确保在主线程上执行 UI 操作，以避免线程不安全的情况。可以使用 @Subscribe(threadMode = ThreadMode.MAIN) 注解确保在主线程上处理事件。

   @Subscribe(threadMode = ThreadMode.MAIN)
   public void onMessageEvent(MessageEvent event) {
       // 在主线程上处理事件
   }
   

7. 使用粘性事件：EventBus 还支持粘性事件，这些事件会在订阅者注册后立即收到，无论事件何时发布。使用 @Subscribe(sticky = true) 注解来订阅粘性事件。

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

8. 处理异常：在订阅者方法中处理事件时，确保处理异常情况，以避免应用崩溃。

9. Proguard 配置：如果您使用了 Proguard 来混淆代码，确保配置文件包含 EventBus 类的规则，以避免混淆导致的问题。

这是 EventBus 的基本使用方法。请注意，EventBus 可能不是最佳的通信方法，具体取决于您的应用需求和架构。如果您的应用需要更强大的通信和状态管理，考虑使用其他库或架构模式，如 LiveData、ViewModel、RxJava、或 Jetpack Compose 的状态管理。