Spring 事件处理机制

spring 事件处理机制

Spring框架对事件的发布与监听提供了相对完整的支持，它扩展了JDK中对自定义事件监听提供的基础框架，并与Spring的IOC特性作了整合，使得用户可以根据自己的业务特点进行相关的自定义，并依托Spring容器方便的实现监听器的注册和事件的发布，使得用户不用关心事件发布和监听的具体细节，降低了开发难度也简化了开发流程

基于Spring实现对自定义事件的发布监听

• 自定义事件类，Spring为容器内事件定义了一个抽象类ApplicationEvent，自定义的事件需要继承这个类，并且传入事件源作为参数，事件源可以用来存储包含该事件的一些相关信息

public class TaskFinishEvent extends ApplicationEvent {
    public TaskFinishEvent(Object source) {
        super(source);
    }

    public TaskFinishEvent(Object source, Clock clock) {
        super(source, clock);
    }
}

• 自定义事件监听器并向容器注册，Spring定义了一个ApplicationListener接口作为事件监听器的抽象，该接口是一个泛型接口，其实现类可以通过传入泛型参数指定该事件监听器要对哪些事件进行监听，内部只定义了一个抽象方法onApplicationEvent(evnt)，当监听的事件在容器中被发布，该方法将被调用，所有的事件监听器都必须向容器注册,容器能够对其进行识别并委托容器内真正的事件发布器进行管理

@Component
public class TaskFinishListener  implements ApplicationListener<TaskFinishEvent> {
    @Override
    public void onApplicationEvent(TaskFinishEvent event) {
        Task source = (Task) event.getSource();
        System.out.println(source);
    }
}

从 Spring 4.1 开始，可以使用 @EventListener 注解的方法，以自动注册与该方法签名匹配的 ApplicationListener（监听器类同样需要注册为 Spring 的组件）

@Component
public class TaskFinishListener{

    @EventListener
    public void listener1(TaskFinishEvent event) {
        Task source = (Task) event.getSource();
        System.out.println(source);
    }
}

• 发布事件类，发布事件的功能定义在ApplicationEventPublisher接口中，而ApplicationContext继承了该接口，所以可以通过实现ApplicationContextAware接口获取ApplicationContext实例，然后调用其发布事件方法

@Component
public class EventPublisher implements ApplicationContextAware {

    private ApplicationContext applicationContext;

    public void publishEvent(ApplicationEvent event){
        System.out.println("准备发布事件！！！");
        applicationContext.publishEvent(event);
        System.out.println("事件发布完毕！！！");
    }
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext=applicationContext;
    }
}

• 测试事件发布及监听

	@Autowired
    private EventPublisher eventPublisher;

    @Test
    public void test2(){
        Task task = new Task("用户统计","success");
        TaskFinishEvent taskFinishEvent = new TaskFinishEvent(task);
        eventPublisher.publishEvent(taskFinishEvent);
    }

@order 指定优先级

当 Spring 发布一个事件时，会调用所有能处理这个事件的事件监听器方法，可以使用 @Order 注解来指定事件监听器方法的优先级，数值越小，优先级越高。

@Component
public class TaskFinishListener{

    @EventListener
    @Order(1)
    public void listener1(TaskFinishEvent event) {
        System.out.println("listen1------");
        Task source = (Task) event.getSource();
        System.out.println(source);
    }

    @EventListener
    @Order(2)
    public void listen2(TaskFinishEvent event){
        System.out.println("listen2-------");
        Task source = (Task) event.getSource();
        System.out.println(source);
    }
}

异步

默认 spring 事件是同步的，这意味着发布者线程将阻塞，直到所有侦听器都完成对事件的处理为止。我们可以使用 @Async 注解来标注一个事件监听器方法，表示这个方法是一个异步方法，应该在独立的线程中执行。

• 在配置类（@Configuration 类之一或 @SpringBootApplication 类）中启用异步处理，才能使用 @Async 注解

@Configuration
@EnableAsync
public class MyConfig {
}

• 使用@Async 注解

@Component
public class TaskFinishListener{

    @EventListener
    @Async
    public void listener1(TaskFinishEvent event) {
        System.out.println("listen1------");
        Task source = (Task) event.getSource();
        System.out.println(source);
    }

    @EventListener
    @Async
    public void listen2(TaskFinishEvent event){
        System.out.println("listen2-------");
        Task source = (Task) event.getSource();
        System.out.println(source);
    }
}