Spring 中的自定义事件

本篇我们介绍Spring 中的自定义事件，编写和发布自己的自定义事件需要执行多个步骤。 按照本章给出的说明编写、发布和处理自定义 Spring 事件。

1. 使用我们在Spring 第一个示例创建的项目 FirstSpring。
2. 通过扩展 ApplicationEvent 创建一个事件类 CustomEvent。 此类必须定义一个默认构造函数，该构造函数应从 ApplicationEvent 类继承构造函数。
3. 一旦定义了事件类，就可以从任何类中发布它，比如实现 ApplicationEventPublisherAware 的 EventClassPublisher。 我们还需要在 XML 配置文件中将此类声明为 bean，以便容器可以将 bean 识别为事件发布者，因为它实现了 ApplicationEventPublisherAware 接口。
4. 发布的事件可以在一个类中被处理，假定 EventClassHandler 实现了 ApplicationListener 接口，而且实现了自定义事件的 onApplicationEvent 方法。
5. 在 src 文件夹中创建 bean 的配置文件 Beans.xml 和 MainApp 类，它可以作为一个 Spring 应用程序来运行。
6. 最后一步是创建的所有 Java 文件和 Bean 配置文件的内容，并运行应用程序，解释如下所示。

这是 CustomEvent.java 文件的内容

CustomEvent.java

package com.jiyik;

import org.springframework.context.ApplicationEvent;

public class CustomEvent extends ApplicationEvent{
   public CustomEvent(Object source) {
      super(source);
   }
   public String toString(){
      return "My Custom Event";
   }
}

以下是 CustomEventPublisher.java 文件的内容

CustomEventPublisher.java

package com.jiyik;

import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationEventPublisherAware;

public class CustomEventPublisher implements ApplicationEventPublisherAware {
   private ApplicationEventPublisher publisher;
   
   public void setApplicationEventPublisher (ApplicationEventPublisher publisher) {
      this.publisher = publisher;
   }
   public void publish() {
      CustomEvent ce = new CustomEvent(this);
      publisher.publishEvent(ce);
   }
}

以下是 CustomEventHandler.java 文件的内容

CustomEventHandler.java

package com.jiyik;

import org.springframework.context.ApplicationListener;

public class CustomEventHandler implements ApplicationListener<CustomEvent> {
   public void onApplicationEvent(CustomEvent event) {
      System.out.println(event.toString());
   }
}

以下是 MainApp.java 文件的内容

MainApp.java

package com.jiyik;

import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class MainApp {
   public static void main(String[] args) {
      ConfigurableApplicationContext context = 
         new ClassPathXmlApplicationContext("Beans.xml");
      
      CustomEventPublisher cvp = 
         (CustomEventPublisher) context.getBean("customEventPublisher");
      
      cvp.publish();  
      cvp.publish();
   }
}

以下是配置文件Beans.xml

Beans.xml

<?xml version = "1.0" encoding = "UTF-8"?>

<beans xmlns = "http://www.springframework.org/schema/beans"
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://www.springframework.org/schema/beans
   http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

   <bean id = "customEventHandler" class = "com.jiyik.CustomEventHandler"/>
   <bean id = "customEventPublisher" class = "com.jiyik.CustomEventPublisher"/>

</beans>

完成源代码和 bean 配置文件后，让我们运行应用程序。 如果应用程序一切正常，它将打印以下消息

y Custom Event
y Custom Event