Google Guava与事件总线操作相关的类

最新推荐文章于 2021-03-03 23:13:27 发布

LifeIsForSharing

最新推荐文章于 2021-03-03 23:13:27 发布

阅读量317

点赞数

分类专栏： Google Guava 文章标签： EventBus Subscribe Listener register DeadEvent

本文链接：https://blog.csdn.net/sl1992/article/details/105513704

版权

Google Guava 专栏收录该内容

15 篇文章 4 订阅

订阅专栏

文章目录

1.示例
2.一分钟指南
- 2.1对于监听器
- 2.2对于生产者
3.术语表
4.常见问题

事件总线：组件之间的发布-订阅式通信，而无需组件之间进行显式注册。

EventBus允许组件之间的发布-订阅式通信，而无需组件之间进行显式注册（因此彼此了解）。它是专门为使用显式注册替代传统的Java进程内事件分发而设计的。它不是一个通用的发布-订阅系统，也不打算用于进程间通信。

1.示例

// Class is typically registered by the container.
class EventBusChangeRecorder {
  @Subscribe public void recordCustomerChange(ChangeEvent e) {
    recordChange(e.getChange());
  }
}
// somewhere during initialization
eventBus.register(new EventBusChangeRecorder());
// much later
public void changeCustomer()
  ChangeEvent event = getChangeEvent();
  eventBus.post(event);
}

2.一分钟指南

将现有的基于EventListener的系统转换为使用EventBus很容易。

2.1对于监听器

要监听事件的特定类型（例如，CustomerChangeEvent）…

…在传统的Java事件中：实现用事件定义的接口，例如CustomerChangeEventListener。
…使用EventBus：创建一个接受CustomerChangeEvent作为其唯一参数的方法，并使用@Subscribe注解对其进行标记。

要向事件生产者注册你的监听器方法…

…在传统的Java事件中：将对象传递给每个生产者的registerCustomerChangeEventListener方法。这些方法很少在公共接口中定义，因此，除了知道每个可能的生产者之外，还必须知道其类型。
…使用EventBus：将对象传递给EventBus上的EventBus.register(Object)方法。你需要确保你的对象与事件生产者共享一个EventBus实例。

要监听常见事件超类型（例如EventObject或Object）…

…在传统的Java事件中：不容易。
…使用EventBus：事件会自动调度给任何超类型的监听器，允许接口类型的监听器或Object的“通配符监听器”。

要监听和检测没有监听器的情况下调度的事件…

…在传统的Java事件中：将代码添加到每个事件调度方法中（可能使用AOP）。
…使用EventBus：订阅DeadEvent。EventBus将通知你任何已发布但尚未传递的事件。（方便调试）

2.2对于生产者

为了跟踪事件的监听器…

…在传统的Java事件中：编写代码以管理对象的监听器列表，包括同步，或使用诸如EventListenerList之类的工具类。
…使用EventBus：EventBus为你做了这些。

要将事件调度给监听器…

…在传统的Java事件中：编写一个将事件调度给每个事件监听器的方法，包括错误隔离和（如果需要）异步性。
…使用EventBus：将事件对象传递到EventBus的EventBus.post(Object)方法。

3.术语表

EventBus系统和代码使用以下术语来讨论事件分发：

事件	可能发布到总线的任何对象。
订阅	向`EventBus`注册监听器的行为，以便它的处理方法将接收事件。
监听器	通过暴露处理方法接收事件的对象。
处理方法	`EventBus`用于传递已发布事件的公共方法。处理方法由`@Subscribe`注解标记。
发布事件	通过`EventBus`使事件对给任何监听器可用。

4.常见问题

4.1为什么我必须创建自己的事件总线，而不是使用单例？

EventBus没有指定你如何使用它；没有什么可以阻止你的应用程序为每个组件使用单独的EventBus实例，或者使用单独的实例按上下文或主题来分隔事件。这也使得在测试中设置和销毁EventBus对象变得很简单。

当然，如果你希望拥有一个进程范围内的EventBus单例，那么没有什么可以阻止你这样做。只需让你的容器（例如Guice）在全局范围内创建EventBus作为一个单例（或将其存储在静态字段中，如果你喜欢这样操作的话）。

简而言之，EventBus不是单例的，因为我们不想为你做出这样的决定。你喜欢怎么用就怎么用。

4.2我可以从事件总线上注销一个监听器吗？

可以，使用EventBus.unregister，但是我们发现很少需要它：

大多数监听器是在启动或延迟初始化时注册的，并在应用程序的生命周期内都存在。
特定作用域的EventBus实例可以处理临时事件分发（例如，在请求作用域内的对象之间分发事件）
为了进行测试，可以轻松创建和销毁EventBus实例，从而无需显式地注销。

4.3为什么使用注解来标记处理方法，而不是要求监听器实现接口？

我们认为，事件总线的@Subscribe注解传达的意图与实现接口一样明确（或者可能更明确），同时让你可以随意在任意位置放置事件处理程序方法，并为它们提供意图公开的名称。

传统的Java事件使用一个监听器接口，该接口通常只使用几种方法——通常是一种。这有许多缺点：

任何一个类只能实现对给定事件单个响应。
监听器接口方法可能会冲突。
该方法必须以事件（例如handleChangeEvent）命名，而不是以其用途（例如recordChangeInJournal）命名。
每个事件通常都有其自己的接口，而没有用于一系列事件（例如，所有UI事件）的公共父接口。

整洁地实现这一点上的困难引出了一种模式，该模式在Swing应用程序中尤其常见，即使用微小的匿名类来实现事件监听器接口。

比较这两种情况：

class ChangeRecorder {
  void setCustomer(Customer cust) {
    cust.addChangeListener(new ChangeListener() {
      public void customerChanged(ChangeEvent e) {
        recordChange(e.getChange());
      }
    };
  }
}

与

// Class is typically registered by the container.
class EventBusChangeRecorder {
  @Subscribe public void recordCustomerChange(ChangeEvent e) {
    recordChange(e.getChange());
  }
}

在第二种情况下，意图实际上更加清晰：干扰代码更少，事件处理具有清晰且有意义的名称。

4.4通用`Handler<T>`接口怎么样呢？

有些人为EventBus监听器提出了一个通用的Handler<T>接口。Java使用类型擦除会遇到问题，更不用说可用性方面的问题了。

假设接口看起来像下面这样：

interface Handler<T> {
  void handleEvent(T event);
}

由于擦除的原因，没有单个类可以使用不同的类型参数多次实现通用接口。这是对传统Java事件的巨大倒退，在传统Java事件中，即使actionPerformed和keyPressed不是很有意义的名称，至少你可以实现这两种方法！

4.5`EventBus` 不会破坏静态类型并消除自动重构支持吗？

有些人对EventBus的register(Object)和post(Object)方法对Object类型的使用感到抓狂。

这里使用Object对象有一个很好的理由：事件总线库对事件监听器（如在register(Object)中）或事件本身（在post(Object)中）的类型没有任何限制。

另一方面，事件处理方法必须显式声明它们的参数类型——所需的事件类型（或其超类型之一）。因此，搜索对事件类的引用将立即找到该事件的所有处理方法，而重命名该类型将影响IDE视图（以及创建该事件的任何代码）中的所有处理程序方法。

的确，你可以随意重命名@Subscribed事件处理方法。事件总线不会停止此操作，也不会做任何传播重命名的操作，因为对于事件总线，处理方法的名称无关紧要。当然，直接调用这些方法的测试代码将受到重命名的影响——但这正是重构工具的作用所在。我们将其视为特性，而不是错误bug：能够随意重命名处理方法，可以使它们的含义更清晰。