ApplicationListener

Spring的Enent机制。相当于Spring提供的观察者模式。

目录

• 原理分析
• 事件
• 发布器
• 监听
  • ApplicationListener
  • @EventListener

原理分析

Spring的事件发布与监听主要由3部分组成。

• 事件：ApplicationEvent
• 发布器：ApplicationEventPublisher
• 监听：ApplicationListener

事件

定义一个统一的事件（理解为基类），用于扩展事件

@Getter
@Setter
public class MarsAppicationEvent extends ApplicationEvent implements Serializable {

    private static final long serialVersionUID = -8965489051151591696L;
    private MarsEvent marsEvent;

    public MarsAppicationEvent(Object source, MarsEvent marsEvent) {
        super(source);
        this.marsEvent = marsEvent;
    }

    public static MarsAppicationEvent of(Object source, MarsEvent marsEvent) {
        return new MarsAppicationEvent(source, marsEvent);
    }

}

事件这里定义了一个监听器接口，纯粹是为了业务扩展

public interface MarsEvent extends Serializable, Runnable {

    default String getBusinessId() {
        return null;
    }

    default MarsEventType getEventType() {
        return MarsEventTypeEnum.BUSINESS;
    }
}

监听器接口中使用的事件类型接口和枚举实现

public interface MarsEventType {

    String getEventType();
}

@Getter
@AllArgsConstructor
public enum MarsEventTypeEnum implements MarsEventType {

    BUSINESS("business");


    private final String eventType;

}

发布器

使用Spring的ApplicationEventPublisher接口发布事件。

说明：ApplicationEventPublisher是ApplicationContext 的父接口，所以这里直接使用注入方式，获取Spring提供的实例。定义为static纯粹是为了使用方便（习惯而已）。

@Component
public class MarsApplicationPubliser {

    private static ApplicationEventPublisher staticApplicationEventPublisher;

    public MarsApplicationPubliser(ApplicationEventPublisher applicationEventPublisher) {
        this.staticApplicationEventPublisher = applicationEventPublisher;
    }

    public static void publish(MarsAppicationEvent event){
        staticApplicationEventPublisher.publishEvent(event);
    }

}

监听

事件监听可以通过ApplicationListener接口或者@EventListener注解方式来实现。

ApplicationListener

@Slf4j
@Component
public class MarsApplicationListener implements ApplicationListener<MarsAppicationEvent> {

    /**
     * Handle an application event.
     *
     * @param event the event to respond to
     */
    @Override
    public void onApplicationEvent(@NonNull MarsAppicationEvent event) {
        log.info("监听到 {}", event);
        MarsEvent listener = event.getMarsEvent();
        listener.run();
    }
}

@EventListener

@Service
@Slf4j
public class MarsApplicationListener4Annotation {

    /**
     * Handle an application event.
     *
     * @param event the event to respond to
     */
    @EventListener(MarsAppicationEvent.class)
    public void onApplicationEvent(@NonNull MarsAppicationEvent event) {
        log.info("监听到 {}", event);
    }
}