《设计模式之美》观察者模式（下）：如何实现一个异步非阻塞的EventBus框架？

王争《设计模式之美》学习笔记

异步非阻塞观察者模式的简易实现

• 关于上节课例子，我们实现异步非阻塞观察者模式，有两种方式：
  • 第一种：在每个 handleRegSuccess() 函数中创建一个新的线程执行代码逻辑
  • 第二种：在 UserController的register() 函数中使用线程池来执行每个观察者 handleRegSuccess() 函数

// 第一种实现方式，其他类代码不变，就没有再重复罗列
public class RegPromotionObserver implements RegObserver {
  private PromotionService promotionService; //依赖注入
  @Override
  public void handleRegSuccess(Long userId) {
    Thread thread = new Thread(new Runnable() {
      @Override
      public void run() {
      	promotionService.issueNewUserExperienceCash(userId);
      }
    });
    thread.start();
  }
}

// 第二种实现方式，其他类代码不变，就没有再重复罗列
public class UserController {
  private UserService userService; // 依赖注入
  private List<RegObserver> regObservers = new ArrayList<>();
  private Executor executor;
  public UserController(Executor executor) {
    this.executor = executor;
  }
  public void setRegObservers(List<RegObserver> observers) {
    regObservers.addAll(observers);
  }
  public Long register(String telephone, String password) {
    //省略输入参数的校验代码
    //省略userService.register()异常的try-catch代码
    long userId = userService.register(telephone, password);
    for (RegObserver observer : regObservers) {
      executor.execute(new Runnable() {
        @Override
        public void run() {
          observer.handleRegSuccess(userId);
        }
      });
    }
    return userId;
  }
}

• 对于第一种实现方式，频繁地创建和销毁线程比较耗时，并且并发线程数无法控制，创建过多的线程会导致堆栈溢出。
• 第二种实现方式，尽管利用了线程池解决了第一种实现方式的问题，但线程池、异步执行逻辑都耦合在了 register() 函数中，增加了这部分业务代码的维护成本。
• 针对异步非阻塞观察者模式，我们也可以将它抽象成框架来达到这样的效果，而这个框架就是我们这节课要讲的 EventBus。

EventBus框架功能需求介绍

• EventBus 翻译为“事件总线”，它提供了实现观察者模式的骨架代码。

使用 EventBus 重构上节用户注册例子

public class UserController {
  private UserService userService; // 依赖注入
  private EventBus eventBus;
  private static final int DEFAULT_EVENTBUS_THREAD_POOL_SIZE = 20;
  public UserController() {
    //eventBus = new EventBus(); // 同步阻塞模式
    eventBus = new AsyncEventBus(Executors.newFixedThreadPool(DEFAULT_EVENTBUS_THREAD_POOL_SIZE));// 异步非阻塞模式
  }
  public void setRegObservers(List<Object> observers) {
    for (Object observer : observers) {
      eventBus.register(observer);
    }
  }
  public Long register(String telephone, String password) {
    //省略输入参数的校验代码
    //省略userService.register()异常的try-catch代码
    long userId = userService.register(telephone, password);
    eventBus.post(userId);
    return userId;
  }
}

public class RegPromotionObserver {
  private PromotionService promotionService; //依赖注入
  @Subscribe
  public void handleRegSuccess(Long userId) {
  	promotionService.issueNewUserExperienceCash(userId);
  }
}

public class RegNotificationObserver {
  private NotificationService notificationService;
  @Subscribe
  public void handleRegSuccess(Long userId) {
    notificationService.sendInboxMessage(userId, "...");
  }
}

• 基于 EventBus，我们不需要定义 Observer 接口，任意类型的对象都可以注册到 EventBus 中，通过@Subscribe 注解来标明类中哪个函数可以接收被观察者发送的消息。
• EventBus 实现了同步阻塞的观察者模式，AsyncEventBus 继承自 EventBus，提供了异步非阻塞的观察者模式。
• EventBus类提供了 register() 函数用来注册观察者，unregister() 函数用来 EventBus 中删除某个观察者。
• EventBus类提供了post()函数，用来给观察者发送消息。
  • 跟经典的观察者模式的不同之处在于，当我们调用 post() 函数发送消息的时候，并非把消息发送给所有的观察者，而是发送给可匹配的观察者。
  • 所谓可匹配指的是，能接收的消息类型是发送消息（post 函数定义中的 event）类型的父类。
  • 当通过 register() 函数将 DObserver类对象注册到 EventBus 的时候，EventBus会根据@Subscribe 注解找到 f1() 和 f2()，并且将两个函数能接收的消息类型记录下来（PMsg->f1，QMsg->f2）。当我们通过 post() 函数发送消息（比如QMsg消息）的时候，EventBus 会通过之前的记录（QMsg->f2），调用相应的函数（f2）。

手把手实现一个EventBus框架

1.Subscribe

• Subscribe 是一个注解，用于标明观察者中的哪个函数可以接收消息。

2.ObserverAction

• ObserverAction 类用来表示@Subscribe 注解的方法，其中，target 表示观察者类，method 表示方法。它主要用在 ObserverRegistry 观察者注册表中。

3.ObserverRegistry

• ObserverRegistry 类就是前面讲到的 Observer 注册表，是最复杂的一个类，框架中几乎所有的核心逻辑都在这个类中。
• 其中，一个比较有技巧的地方是 CopyOnWriteArraySet 的使用：
  • CopyOnWriteArraySet，顾名思义，在写入数据的时候，会创建一个新的 set，并且将原始数据 clone 到新的 set 中，在新的 set 中写入数据完成之后，再用新的 set 替换老的 set。这样就能保证在写入数据的时候，不影响数据的读取操作，以此来决读写并发问题。
  • 除此之外，CopyOnWriteSet 还通过加锁的方式，避免了并发写冲突。

4.EventBus

• EventBus 实现的是阻塞同步的观察者模式。

5.AsyncEventBus

• 有了 EventBus，AsyncEventBus 的实现就非常简单了。为了实现异步非阻塞的观察者模式，它就不能再继续使用 MoreExecutors.directExecutor() 了，而是需要在构造函数中，由调用者注入线程池。