Spring 简明教程

Custom Events in Spring

编写和发布自定义事件需要进行很多步骤。遵循本章提供的指导编写、发布和处理 Custom Spring 事件。

Steps	Description
1	在创建的项目中使用名称 SpringExample 创建一个项目，并在 src 文件夹下创建一个包 com.tutorialspoint 。所有类都将在此包下创建。
2	使用 Add External JARs 选项添加必需的 Spring 库，如 Spring Hello World Example 章节中所述。
3	通过扩展 ApplicationEvent 创建一个事件类 CustomEvent。此类必须定义一个默认构造函数，该函数应从 ApplicationEvent 类继承构造函数。
4	一旦定义了事件类，便可以从任何类（例如，实现了 ApplicationEventPublisherAware 的 EventClassPublisher）发布该事件。还需要在 XML 配置文件中将此类声明为 bean，以便容器可以将该 bean 识别为事件发布者，因为它实现了 ApplicationEventPublisherAware 接口。
5	可以再一个类中（例如，实现了 ApplicationListener 接口，并为自定义事件实现了 onApplicationEvent 方法的 EventClassHandler）处理已发布的事件。
6	在 src 文件夹下创建 bean 配置文件 Beans.xml，以及一个作为 Spring 应用程序运行的 MainApp 类。
7	最后一步是创建所有 Java 文件和 Bean 配置文件的内容，并按如下所述运行应用程序。

下面是 CustomEvent.java 文件的内容

package com.tutorialspoint;

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 文件的内容

package com.tutorialspoint;

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 文件的内容

package com.tutorialspoint;

import org.springframework.context.ApplicationListener;

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

以下是 MainApp.java 文件的内容

package com.tutorialspoint;

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

<?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.tutorialspoint.CustomEventHandler"/>
   <bean id = "customEventPublisher" class = "com.tutorialspoint.CustomEventPublisher"/>

</beans>

完成源文件和 Bean 配置文件创建后，我们运行该应用程序。如果您的应用程序一切正常，它将打印以下消息−

y Custom Event
y Custom Event