Spring 中标准事件与自定义事件

Java有货

共 4098字,需浏览 9分钟

 ·

2021-07-29 04:23

简介


ApplicationContext是通过ApplicationEvent 类和ApplicationListener接口提供的。如果将实现ApplicationListener接口的 bean 部署到上下文中,则每次 ApplicationEvent将 发布到 时ApplicationContext,都会通知该 bean。本质上,这是标准的观察者设计模式。、

从 Spring 4.2 开始,事件基础结构得到了显着改进,并提供了基于注释的模型以及发布任意事件(即不一定从 扩展的对象ApplicationEvent)的能力。当此类对象发布时,我们会为您将其包装在一个事件中。

下表描述了 Spring 提供的标准事件:

您还可以创建和发布自己的自定义事件。以下示例显示了一个扩展 SpringApplicationEvent基类的简单类:

public class BlockedListEvent extends ApplicationEvent {
private final String address; private final String content;
public BlockedListEvent(Object source, String address, String content) { super(source); this.address = address; this.content = content; }
// accessor and other methods...}

要发布自定义ApplicationEvent,调用publishEvent()上的方法 ApplicationEventPublisher。通常,这是通过创建一个实现ApplicationEventPublisherAware并将其注册为 Spring bean的类来完成的 。以下示例显示了这样一个类:

public class EmailService implements ApplicationEventPublisherAware {
private List<String> blockedList; private ApplicationEventPublisher publisher;
public void setBlockedList(List<String> blockedList) { this.blockedList = blockedList; }
public void setApplicationEventPublisher(ApplicationEventPublisher publisher) { this.publisher = publisher; }
public void sendEmail(String address, String content) { if (blockedList.contains(address)) { publisher.publishEvent(new BlockedListEvent(this, address, content)); return; } // send email... }}

在配置时,Spring 容器会检测到EmailService实现 ApplicationEventPublisherAware并自动调用 setApplicationEventPublisher(). 实际上,传入的参数是Spring容器本身。您正在通过其ApplicationEventPublisher界面与应用程序上下文进行 交互。

要接收 custom ApplicationEvent,您可以创建一个实现 ApplicationListener并将其注册为 Spring bean 的类。以下示例显示了这样一个类:

public class BlockedListNotifier implements ApplicationListener<BlockedListEvent> {
private String notificationAddress;
public void setNotificationAddress(String notificationAddress) { this.notificationAddress = notificationAddress; }
public void onApplicationEvent(BlockedListEvent event) { // notify appropriate parties via notificationAddress... }}

请注意,ApplicationListener它通常使用自定义事件的类型进行参数化(BlockedListEvent在前面的示例中)。这意味着该 onApplicationEvent()方法可以保持类型安全,避免任何向下转型的需要。您可以根据需要注册任意数量的事件侦听器,但请注意,默认情况下,事件侦听器会同步接收事件。这意味着该publishEvent()方法会阻塞,直到所有侦听器都完成对事件的处理。这种同步和单线程方法的一个优点是,当侦听器接收到事件时,如果事务上下文可用,它就会在发布者的事务上下文中运行。

总而言之,当调用 bean的sendEmail()方法时emailService,如果有任何电子邮件消息应该被阻止,BlockedListEvent则会发布一个自定义事件类型 。该blockedListNotifierbean被注册为 ApplicationListener接收的BlockedListEvent,在这一点上,可以通知有关各方。

Spring 的事件机制是为同一应用程序上下文中 Spring bean 之间的简单通信而设计的。然而,对于更复杂的企业集成需求,单独维护的 Spring Integration项目为构建基于众所周知的 Spring 编程模型的轻量级、面向模式、事件驱动的架构提供了完整的支持 。

基于注解的事件监听器


您可以使用@EventListener注释在托管 bean 的任何方法上注册事件侦听器 。该BlockedListNotifier可改写如下:

public class BlockedListNotifier {
private String notificationAddress;
public void setNotificationAddress(String notificationAddress) { this.notificationAddress = notificationAddress; }
@EventListener public void processBlockedListEvent(BlockedListEvent event) { // notify appropriate parties via notificationAddress... }}

方法签名再次声明了它侦听的事件类型,但这次使用了灵活的名称并且没有实现特定的侦听器接口。只要实际事件类型在其实现层次结构中解析您的泛型参数,也可以通过泛型缩小事件类型。

如果您的方法应该侦听多个事件,或者您想定义它时根本不带参数,则还可以在注释本身上指定事件类型。以下示例显示了如何执行此操作:

@EventListener({ContextStartedEvent.class, ContextRefreshedEvent.class})public void handleContextStart() {    // ...}

还可以通过使用condition定义SpEL表达式的注释的属性添加额外的运行时过滤,该属性应该匹配以实际调用特定事件的方法。

以下示例显示了如何重写我们的通知程序,使其仅content在事件的属性等于时才被调用 my-event

@EventListener(condition = "#blEvent.content == 'my-event'")public void processBlockedListEvent(BlockedListEvent blEvent) {    // notify appropriate parties via notificationAddress...}

如果您需要发布一个事件作为处理另一个事件的结果,您可以更改方法签名以返回应该发布的事件,如以下示例所示:

@EventListenerpublic ListUpdateEvent handleBlockedListEvent(BlockedListEvent event) {    // notify appropriate parties via notificationAddress and    // then publish a ListUpdateEvent...}

项目实战代码地址https://github.com/yanghaiji/IT-Demo

浏览 36
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报