1.概述

在本文中,我们将讨论如何在Spring中使用自定义事件

事件(Events)是框架中最容易被忽视的功能之一,但也是更有用的功能之一。

与Spring中的许多其他事情一样,事件发布是ApplicationContext提供的功能之一

  • 事件需要扩展自ApplicationEvent
  • 事件的发布者需要注入一个ApplicationEventPublisher对象。
  • 监听器需要实现ApplicationListener接口

2. 自定义事件

在Spring中, 我们可以创建和发布自定义事件(默认情况下是同步的)。

2.1 一个简单的应用程序事件

让我们创建一个简单的事件类,仅仅存储了事件的消息。事件类中包含一个消息字段。

我们来看一下:

public class CustomSpringEvent extends ApplicationEvent {
    private String message;

    public CustomSpringEvent(Object source, String message) {
        super(source);
        this.message = message;
    }
    public String getMessage() {
        return message;
    }
}

2.2 发布者

现在,让我们创建该事件的发布者。发布者创建事件对象,并将其发布给正在监听的监听器。

对于发布事件,发布者可以简单地注入ApplicationEventPublisher并使用publishEvent() 方法:

@Component
public class CustomSpringEventPublisher {
    @Autowired
    private ApplicationEventPublisher applicationEventPublisher;

    public void publishCustomEvent(final String message) {
        System.out.println("Publishing custom event. ");
        CustomSpringEvent customSpringEvent = new CustomSpringEvent(this, message);
        applicationEventPublisher.publishEvent(customSpringEvent);
    }
}

我们也可以发布者类实现ApplicationEventPublisherAware接口来获取ApplicationEventPublisher。这样Spring会在程序启动时通过ApplicationEventPublisherAware接口的setApplicationEventPublisher方法帮我们注入ApplicationEventPublisher

通常,使用*@Autowire*注入发布者会简单一些。

2.3 监听器

最后,让我们创建监听器。

监听器的需要时一个Spring管理的bean并实现 ApplicationListener接口:

@Component
public class CustomSpringEventListener implements ApplicationListener<CustomSpringEvent> {
    @Override
    public void onApplicationEvent(CustomSpringEvent event) {
        System.out.println("ripjava.com: 收到消息-" + event.getMessage());
    }
}

我们的自定义监听器是如何通过自定义事件的泛型进行参数化的。这使onApplicationEvent()方法类型安全。这也避免了必须检查对象是否是特定事件类的实例并进行强制转换。

而且,spring事件默认是同步的,也就是说我们发布者类的publishCustomEvent()会被阻塞,直到所有的监听器完成事件为止。

2.4 测试

我们来测试一下:

@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = { CustomEventConfig.class }, loader = AnnotationConfigContextLoader.class)
public class CustomSpringEventTest {

    @Autowired
    private CustomSpringEventPublisher publisher;

    @Test
    public void testCustomSpringEvents() {
        publisher.publishCustomEvent("hello ripjava.com");
    }

}

输出如下:

ripjava.com: 准备发布自定义事件 
ripjava.com: 收到消息-hello ripjava.com

3. 注解驱动的事件监听器

从Spring 4.2开始,事件监听器不必是实现ApplicationListener接口 ,可以通过@EventListener注解在Spring管理的bean的任何公共方法上注册事件监听:

@Component
public class AnnotationDrivenContextStartedListener {
    @EventListener(CustomSpringEvent.class)
    public void handleContextStart(CustomSpringEvent event) {
        System.out.println("ripjava.com: @EventListener收到消息-" + event.getMessage());
    }
}

和实现接口一样,方法签名声明其使用的事件类型。默认情况下也是同步调用。

可以使用@Async迅速变成异步调用。但是这需要在Spring中开启异步支持。

4. 总结

在本文中,我们介绍了在Spring中处理事件的基础知识。

创建一个简单的自定义事件,将其发布,然后在监听器中进行处理。

最后,和往常一样,代码可以在Github上找到。