使用Guava EventBus实现Java组件间的通信

在构建企业应用程序时经常出现的一种情况是在一个过程成功后需要实现一系列业务流程,例如,如果您正在构建购物网站,则可能需要在产品付款成功后执行以下操作:

  1. 购买后减少商店中可用的物品数量。
  2. 向商店老板发送收据。
  3. 向买方发送收据。

在某些情况下,您可能希望这些过程对于产品购买而言是原子性的,也就是说,在发生产品购买之后,必须减少项目数量,如果在减少可用项目数量方面存在问题,则还原产品购买。通常会在事务中执行此操作以使流程原子化。

但在某些情况下,如果第二步失败了但第二步的重要性可能不足以使其恢复第一步的执行,例如,您可能不希望将收据发送给客户或卖方的过程影响付款过程。在这种情况下,您可能希望使处理两个流程的组件尽可能地分离,以便它们可以独立执行操作,这时事件总线就可以帮助我们来实现。

什么是事件总线?

事件总线是一种机制,它允许不同的组件彼此通信而不无需相互了解。组件可以将事件发送到Eventbus,而无需知道是谁来接听或有多少人来接听。组件也可以侦听Eventbus上的事件,而无需知道谁发送了事件。这样,组件可以相互通信而无需相互依赖。同样的也很容易替换其中一个组件。只要新组件了解正在发送和接收的事件,而这一过程其他组件永远不会知道。

在本文中,我们将使用Google Guava EventBus来展示如何在Java应用程序中解耦组件。

Guava EventBus

Guava的EventBus提供了一个发布-订阅事件机制,该机制允许对象通过观察者模式相互通信。EventBus避开了Java中常见的“事件监听器”模式,在Java中,一个对象实现了特定的接口,然后显式地向另一个对象订阅。

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

组件解耦

在我们的示例中,我们将通过模拟本文开头提到的付款过程来演示如何使用事件总线。

我们应用程序涉及的组件:

  • 第一部分应该处理与成功付款直接相关的流程,例如减少商店中剩余的物品数量。
  • 第二部分处理向客户发送收据。
  • 第三部分处理向卖方发送收据。

我们可以通过以不同的方法实现这些流程并将它们依次链接在一起,我们可以像这样实现:

但是这种方法的问题在于,这些组件没有正确地分离,并且在一个过程中发生错误时,可能会影响另一个过程。另外,如果我们必须添加更多要在成功付款后执行的流程,则必须手动添加方法调用,这样做并不好。我们将使用事件总线解决该问题。

这就是我们改进的样子:

支付组件和收据发送者组件互相完全不知道,事件总线负责将信息从发布者传送到所有订阅者。

Guava EventBus的实现

在展示如何实现前先介绍Guava EventBus中的一些重要概念:

  • 事件总线:这是委派负责将事件数据从一个组件传送到另一个组件的对象,通常,您需要一个事件总线的实例,以便生产者和订阅者使用同一事件总线,这是事件总线正常工作所必需的。您可以使用单例模式来确保仅创建此类的一个实例,并在需要事件总线的实例时使用IOC容器提供该实例。

注意:您可能具有Event的多个实例,但是如果您希望不同的事件总线处理不同的组件集,只需要保证发布者和订阅者必须使用相同的事件总线来通信。

  • 生产者:生产者负责发出事件,然后将这些事件传递到事件总线,并发送给订阅该事件的所有侦听器。

  • 侦听器:侦听器订阅事件,并在生产者发布该事件时触发该事件,您可以让侦听器方法同步或异步运行,具体取决于您使用的事件总线的类型。为了使同步运行的监听方法,你可以使用一个同步事件总线是默认EventBus类,要把它异步运行,你将不得不使用AsyncEventBus类,这是一个EventBus子类,它的构造需要一个executor将被用于在单独的线程上执行该方法。在我们的示例中,我们将使用默认EventBus。

  • 事件:在Guava事件总线中,事件只是使用类名唯一标识的对象。因此,要创建付款成功事件,我们只需创建一个PaymentSuccessfulEvent.java类,并在付款成功后发布该类的实例。

具体实现

  1. 将Google Guava库添加到您的项目中
<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>28.0-jre</version>
</dependency>
  1. 创建事件总线对象。它可以注册侦听器并发布事件。使用它就像实例化类一样简单:
EventBus eventBus = new EventBus();
  1. 创建付款成功事件。事件只是一个简单的类,每个事件都由类的名称标识。因此,让我们创建一个PaymentSuccessful事件。
public class PaymentSuccessfulEvent {
    private String action;

    PaymentSuccessfulEvent(String action) {
        this.action = action;
    }

    String getAction() {
        return action;
    }

    public void setAction(String action) {
        this.action = action;
    }
}
  1. 为“付款成功”事件创建侦听器。在Guava EventBus中,侦听器是一种用@Subscribe注解修饰的方法,用于接收特定事件,该方法接受与发布事件相同类型的对象作为参数。让我们创建一个付款成功事件监听器
public class PaymentSuccessfulEventListener {

    private static int eventsHandled;
    private static final Logger LOG = LoggerFactory.getLogger(PaymentSuccessfulEventListener.class);


    @Subscribe
    public void paymentEvent(PaymentSuccessfulEvent event) {
        LOG.info("do event [" + event.getAction() + "]");
        eventsHandled++;
    }


    int getEventsHandled() {
        return eventsHandled;
    }

    void resetEventsHandled() {
        eventsHandled = 0;
    }
}
  1. 注册事件侦听者。我们可以通过在EventBus上注册EventListener类来订阅事件:
PaymentSuccessfulEventListener listener = new PaymentSuccessfulEventListener();
eventBus.register(listener);
  1. 发布事件。这将触发所有将PaymentSuccessfulEvent作为其参数并且还具有@Subscribe注解的方法。
eventBus.post(paymentEvent);

完整测试类:

public class GuavaEventBusUnitTest {

    private PaymentSuccessfulEventListener listener;
    private EventBus eventBus;

    @Before
    public void setUp() {
        eventBus = new EventBus();
        listener = new PaymentSuccessfulEventListener();

        eventBus.register(listener);
    }

    @After
    public void tearDown() {
        eventBus.unregister(listener);
    }

    @Test
    public void paymentSuccessfulEvent_whenEventHandled_thenSuccess() {
        listener.resetEventsHandled();

        PaymentSuccessfulEvent paymentEvent = new PaymentSuccessfulEvent("PaymentSuccessful Event");
        eventBus.post(paymentEvent);

        assertEquals(1, listener.getEventsHandled());
    }

}

总结

在本文中我们使用了一个简单的示例讲解如何使用Guava EventBus。