使用事件驱动进行代码解耦-Spring篇

时间 2019-11-06

标签使用事件驱动进行代码 spring 栏目 Spring 繁體版

原文原文链接

什么是事件驱动模型

事件驱动模型也就是咱们常说的观察者，或者发布-订阅模型；理解它的几个关键点：java

首先是一种对象间的一对多的依赖关系；
当一个对象的状态发生变化时，观察者（订阅者）都获得通知并作相应的处理；
观察者如何处理，目标无需干涉，松散耦合了它们之间的关系。

常见问题

好比说订单状态变化的时候，可以通知到邮件服务，短信服务，积分变化等等; 若是你是个新手，想象一下你去实现这个业务的代码怎么去实现？确定是一个OrderService里面引入积分Service，短信Service，邮件Service，还有不少不少Service，可能还要调用第三方接口。是否是发现问题所在了，Service耦合严重，又是还会出现循环引用的问题，代码超长，以致于不方便维护。spring

从如上例子能够看出，应该使用一个观察者来解耦这些Service之间的依赖关系，如图：
设计模式

图中增长了一个Listener来解耦OrderService和其余Service，即注册成功后，只须要通知相关的监听器，不须要关心它们如何处理，处理起来很是容易。这就是一个典型的事件处理模型-观察者模式，解耦目标对象和它的依赖对象，目标只须要通知它的依赖对象，具体怎么处理，依赖对象本身决定。好比是异步仍是同步，延迟仍是非延迟等。
其实上边其实也使用了DIP（依赖倒置原则），依赖于抽象，而不是具体。
仍是就是使用了IOC思想，即之前主动去建立它依赖的Service，如今只是被动等待别人注册进来。
主要目的是：松散耦合对象间的一对多的依赖关系。并发

经常使用事件驱动模型

设计模式里面的观察者模式app
JDK观察者模式异步
JavaBean事件驱动ide
spring事件驱动测试
......ui

JavaBean事件驱动

JavaBean规范提供了一种监听属性变化的事件驱动模型，提供操做JavaBean属性的类PropertyChangeSupport，PropertyEditorSupport以及PropertyChangeListener支持，PropertyEditorSupport就是目标，而PropertyChangeListener就是监听器。this

Spring提供的事件

Spring提供的事件驱动模型/观察者抽象：首先看一下Spring提供的事件驱动模型体系图，

具体表明者是ApplicationEvent：
一、其继承自JDK的EventObject，JDK要求全部事件将继承它，并经过source获得事件源，好比咱们的AWT事件体系也是继承自它；
二、系统默认提供了以下ApplicationEvent事件实现：

只有一个ApplicationContextEvent，表示Spring容器事件，且其又有以下实现：

ContextStartedEvent：Spring容器启动后触发的事件；
ContextStoppedEvent：Spring容器中止后触发的事件；
ContextRefreshedEvent：Spring容器初始化或刷新完成后触发的事件；
ContextClosedEvent：Spring容器关闭后触发的事件；

注：org.springframework.context.support.AbstractApplicationContext抽象类实现了LifeCycle的start和stop回调并发布ContextStartedEvent和ContextStoppedEvent事件。

事件发布

具体表明者是：ApplicationEventPublisher及ApplicationEventMulticaster，系统默认提供了以下实现：

一、ApplicationContext接口继承了ApplicationEventPublisher，并在AbstractApplicationContext实现了具体代码，实际执行是委托给ApplicationEventMulticaster（能够认为是多播）：

protected void publishEvent(Object event, @Nullable ResolvableType eventType) {
    //省略部分代码

    if (event instanceof ApplicationEvent) {
        applicationEvent = (ApplicationEvent)event;
    } else {
        applicationEvent = new PayloadApplicationEvent(this, event);
        if (eventType == null) {
            eventType = ((PayloadApplicationEvent)applicationEvent).getResolvableType();
        }
    }

    if (this.earlyApplicationEvents != null) {
        this.earlyApplicationEvents.add(applicationEvent);
    } else {
        this.getApplicationEventMulticaster().multicastEvent((ApplicationEvent)applicationEvent, eventType);
    }

    if (this.parent != null) {
        if (this.parent instanceof AbstractApplicationContext) {
            ((AbstractApplicationContext)this.parent).publishEvent(event, eventType);
        } else {
            this.parent.publishEvent(event);
        }
    }

}

咱们经常使用的ApplicationContext都继承自AbstractApplicationContext，如ClassPathXmlApplicationContext、XmlWebApplicationContext等，因此自动拥有这个功能。

二、ApplicationContext自动到本地容器里找一个名字为”applicationEventMulticaster“的ApplicationEventMulticaster实现，若是没有本身new一个SimpleApplicationEventMulticaster，代码以下：

protected void initApplicationEventMulticaster() {
    ConfigurableListableBeanFactory beanFactory = this.getBeanFactory();
    if (beanFactory.containsLocalBean("applicationEventMulticaster")) {
        this.applicationEventMulticaster = (ApplicationEventMulticaster)beanFactory.getBean("applicationEventMulticaster", ApplicationEventMulticaster.class);
        if (this.logger.isDebugEnabled()) {
            this.logger.debug("Using ApplicationEventMulticaster [" + this.applicationEventMulticaster + "]");
        }
    } else {
        this.applicationEventMulticaster = new SimpleApplicationEventMulticaster(beanFactory);
        beanFactory.registerSingleton("applicationEventMulticaster", this.applicationEventMulticaster);
        if (this.logger.isDebugEnabled()) {
            this.logger.debug("Unable to locate ApplicationEventMulticaster with name 'applicationEventMulticaster': using default [" + this.applicationEventMulticaster + "]");
        }
    }

}

其中SimpleApplicationEventMulticaster发布事件的代码以下：

public void multicastEvent(ApplicationEvent event, @Nullable ResolvableType eventType) {
    ResolvableType type = eventType != null ? eventType : this.resolveDefaultEventType(event);
    Iterator var4 = this.getApplicationListeners(event, type).iterator();
    while(var4.hasNext()) {
        ApplicationListener<?> listener = (ApplicationListener)var4.next();
        Executor executor = this.getTaskExecutor();
        if (executor != null) {
            executor.execute(() -> {
                this.invokeListener(listener, event);
            });
        } else {
            this.invokeListener(listener, event);
        }
    }
}

能够看到若是给它一个executor（java.util.concurrent.Executor），它就能够异步支持发布事件了，不然就是同步发送。因此咱们发送事件只须要经过ApplicationContext.publishEvent便可，不必再建立本身的实现了。除非有必要。

监听器

具体表明者是：ApplicationListener。其继承自JDK的EventListener，JDK要求全部监听器将继承它。

@FunctionalInterface
public interface ApplicationListener<E extends ApplicationEvent> extends EventListener {
    void onApplicationEvent(E var1);
}

它只提供了onApplicationEvent方法，咱们须要在该方法实现内部判断事件类型来处理，或者指定某一个事件类型(泛型，实现ApplicationListener)，并无提供按顺序触发监听器的语义，因此Spring提供了另外一个接口SmartApplicationListener：

public interface Ordered {
    int getOrder();
}

public interface SmartApplicationListener extends ApplicationListener<ApplicationEvent>, Ordered {
    boolean supportsEventType(Class<? extends ApplicationEvent> var1);
    boolean supportsSourceType(@Nullable Class<?> var1);
}

该接口支持判断的事件类型、目标类型，及执行顺序。

另外，google guava事件机制使用介绍见文章：使用事件驱动进行代码解耦-Guava篇

Spring事件机制示例

本示例模拟订单生成与更新时会发送短信与站内信简单业务场景demo

1. 自定义一些接口以及POJO

/**
 * 业务事件发布者
 * @author dongsilin
 * @version 1.0
 * @date 2019/1/24
 */
public interface BizEventPublisher {

     /**
      * 发布同步事件
      * @param eventData
      */
     void publishEvent(Object eventData);

     /**
      * 发布异步事件
      * @param eventData
      */
     void publishEventAsync(Object eventData);

}


/**
 * 业务事件发布者
 * @author dongsilin
 * @version 1.0
 * @date 2019/1/24
 */
public interface BizEventPublisher {

     /**
      * 发布同步事件
      * @param eventData
      */
     void publishEvent(Object eventData);

     /**
      * 发布异步事件
      * @param eventData
      */
     void publishEventAsync(Object eventData);

}

/**
 * 业务事件类型
 * @author dongsilin
 * @version 1.0
 * @date 2019/1/24
 */
public enum BizEventType {

    ORDER_CREATE("订单-建立"),
    ORDER_UPDATE("订单-修改"),
    ;

    String describe;
    BizEventType(String describe) {
        this.describe = describe;
    }

}

/**
 * @author dongsilin
 * @version 1.0
 * @date 2019/1/24
 * 测试订单类
 */
@Data
public class Order {
    private long orderId;
    private long userId;
    public Order(long orderId, long userId) {
        this.setOrderId(orderId);
        this.setUserId(userId);
    }
}

2. 自定义业务事件，包含事件通用数据属性

/**
 * @author dongsilin
 * @version 1.0
 * @date 2019/1/24
 * 自定义应用业务事件
 * @param <S>
 */
@Data
public class BizEvent<S> extends ApplicationEvent implements EventExecutor<S> {

    private BizEventType eventType;
    private S data;

    private BizEvent(BizEventType eventType, S data) {
        super(eventType);
        this.eventType = eventType;
        this.data = data;
    }

    public static<S> BizEvent of(BizEventType eventType, S data) {
        return new BizEvent(eventType, data);
    }

    @Override
    public void executeEvent(Consumer<S> executor) {
        executor.accept(data);
    }

}

3. 业务事件发布配置管理

/**
 * @author dongsilin
 * @version 1.0
 * @date 2019/1/24
 * 业务事件发布配置管理
 */
@Slf4j
@Component
public class BizEventPublisherConfiguration implements BizEventPublisher{

    /** 注入事件发布管理器，用于发布自定义业务事件 */
    @Autowired
    private ApplicationEventPublisher eventPublisher;

    /** 异步事件执行线程池 */
    private ExecutorService executor = new ThreadPoolExecutor(
        Runtime.getRuntime().availableProcessors(),
        Runtime.getRuntime().availableProcessors() * 2,
        5L,
        TimeUnit.SECONDS,
        new LinkedBlockingQueue<>(),
        new ThreadFactoryBuilder().setNameFormat("spring-event-executor-pool-%d").build()
    );

    @Override
    public void publishEvent(Object eventData) {
        eventPublisher.publishEvent(eventData);
    }

    @Override
    public void publishEventAsync(Object eventData) {
        executor.submit(() -> eventPublisher.publishEvent(eventData));
    }
}

4. 业务事件监听配置管理

/**
 * @author dongsilin
 * @version 1.0
 * @date 2019/1/24
 * 业务事件监听配置管理
 */
@Slf4j
@Component
public class BizEventListenerConfiguration implements ApplicationListener<BizEvent> {

    @Autowired
    private TestMsgService msgService;

    /**
     * 收到事件执行
     * @param bizEvent
     */
    @Override
    public void onApplicationEvent(BizEvent bizEvent) {
        switch (bizEvent.getEventType()) {
            // 订单建立，发送短信，.......
            case ORDER_CREATE: bizEvent.executeEvent((data) -> {
                msgService.sendPhoneMsg((Order) data);
            });break;
            // 订单修改，站内信提醒，.......
            case ORDER_UPDATE: bizEvent.executeEvent((data) -> {
                msgService.sendWebMsg((Order) data);
            });break;

            default: bizEvent.executeEvent((data) -> {
                log.info("onApplicationEvent bizEvent.data = {}", data);
            });
        }
    }

}

5. 定义两个测试service，TestOrderService 和 TestMsgService

/**
 * @author dongsilin
 * @version 1.0
 * @date 2019/1/24
 */
@Slf4j
@Service
public class TestOrderService {

    @Autowired
    private BizEventPublisher bizEventPublisher;

    public void create(Order order) {
        ......
        log.info("TestOrderService create order = {}", order);
        bizEventPublisher.publishEvent(BizEvent.of(BizEventType.ORDER_CREATE, order));
    }

    public void update(Order order) {
        ......
        log.info("TestOrderService update order = {}", order);
        bizEventPublisher.publishEventAsync(BizEvent.of(BizEventType.ORDER_UPDATE, order));
    }

}

/**
 * @author dongsilin
 * @version 1.0
 * @date 2019/1/24
 */
@Slf4j
@Service
public class TestMsgService {


    public void sendPhoneMsg(Order order) {
        ......
        log.info("TestMsgService sendPhoneMsg order = {}", order);
    }

    public void sendWebMsg(Order order) {
        ......
        log.info("TestMsgService sendWebMsg order = {}", order);
    }
}

此处TestOrderService 中并无强制依赖注入TestMsgService，而是经过发布事件的方式将事件数据发布到事件管理中心，由事件管理者来统一管理事件处理方式，解决了各个业务service严重耦合的场景，实现软件开发中的“高内聚-低耦合”原则。

经过如上，大致了解了Spring的事件机制，可使用该机制很是简单的完成事件流程。