事件的監聽與發佈_ZenDei技術網路在線

有些時候，我們希望某件事情發生的時候能夠觸發一個事件，讓這個事件幫我們做些事情。比如，在晚上十一點到晚上十二點這段時間，假如還有人在使用我們的軟體，我們就觸發一個事件播放一首美妙的音樂，希望用戶聽了之後能夠做個好夢，美美睡上一覺。而這，我們需要做好三件事情： 1.定義一個事件。 2.定義一個事件監聽 ...

有些時候，我們希望某件事情發生的時候能夠觸發一個事件，讓這個事件幫我們做些事情。比如，在晚上十一點到晚上十二點這段時間，假如還有人在使用我們的軟體，我們就觸發一個事件播放一首美妙的音樂，希望用戶聽了之後能夠做個好夢，美美睡上一覺。而這，我們需要做好三件事情：
1.定義一個事件。
2.定義一個事件監聽器：如果事件監聽器監聽到事件發佈了，就會觸發事件監聽器，播放一首美妙的音樂。
3.定義一個類：能夠判斷當前時間是否在晚上十一點與晚上十二點之間；如果是，就發佈事件。

這樣一來，我們期望的功能就能實現了。因此，我們首先需要做的，就是定義一個事件：

 1 public class MusicEvent extends ApplicationEvent {
 2     private String musicName = null;
 3 
 4     public MusicEvent(Object source) {
 5         super(source);
 6     }
 7 
 8     public String getMusicName() {
 9         return this.musicName;
10     }
11 
12     public void setMusicName(String musicName) {
13         this.musicName = musicName;
14     }
15 }

這是一個音樂事件，繼承了ApplicationEvent類。ApplicationEvent是Spring提供的一個事件抽象類，凡是事件都應繼承它。而我們的音樂事件繼承ApplicationEvent抽象類後，做了這些事情：
1.定義一個構造函數。構造函數只是簡單地調用父類的構造函數，把Object類型的參數傳給父類。Object類型的參數是事件發佈的事件源。
2.定義一個String類型的musicName屬性，用於存放這個事件應該播放的音樂名。

於是，音樂事件定義好了。下一步，我們需要定義一個事件監聽器：

1 public class MusicListener implements ApplicationListener<MusicEvent> {
2     @Override
3     public void onApplicationEvent(MusicEvent musicEvent) {
4         var musicName = musicEvent.getMusicName();
5         var playingMessage = String.format("正在為您播放音樂《%s》", musicName);
6         System.out.println(playingMessage);
7     }
8 }

這是一個音樂事件監聽器，實現了ApplicationListener介面。ApplicationListener是Spring提供的一個泛型介面，凡是事件監聽器都應實現它；其簽名如下：

1 @FunctionalInterface
2 public interface ApplicationListener<E extends ApplicationEvent> extends EventListener {
3     void onApplicationEvent(E event);
4 }

這是一個函數式泛型介面。實現這個介面的時候，需要指定一個繼承了ApplicationEvent類的子類。這樣，當指定類型的事件發佈的時候，事件監聽器就能監聽到指定類型的事件，調用onApplicationEvent方法進行處理。因此，音樂事件監聽器實現ApplicationListener<MusicEvent>介面的onApplicationEvent方法的時候，做了這些事情：
1.調用musicEvent事件的getMusicName方法獲取音樂名。
2.向控制台輸出一段文字，告訴用戶正在為您播放某首音樂。

這樣一來，一旦音樂事件監聽器監聽到音樂事件發佈了，就會觸發音樂事件監聽器，調用onApplicationEvent方法播放音樂。因此，下一步我們需要做的，就是發佈事件：

 1 public class MusicService implements ApplicationEventPublisherAware {
 2     private ApplicationEventPublisher publisher = null;
 3 
 4     @Override
 5     public void setApplicationEventPublisher(ApplicationEventPublisher publisher) {
 6         this.publisher = publisher;
 7     }
 8 
 9     public void play(String musicName) {
10         var hourOfDay = Calendar.getInstance().get(Calendar.HOUR_OF_DAY);
11         if (hourOfDay == 23) {
12             var musicEvent = new MusicEvent(this);
13             musicEvent.setMusicName(musicName);
14             publisher.publishEvent(musicEvent);
15         }
16     }
17 }

這段代碼定義了一個類，該類實現了ApplicationEventPublisherAware介面。這是一個Aware介面，能讓Spring容器註入ApplicationEventPublisher類型的Bean

ApplicationEventPublisher是個介面。在ApplicationContext實現的眾多介面中，其中就有ApplicationEventPublisher介面。因此，ApplicationContext也是ApplicationEventPublisher類型的。Spring容器註入的ApplicationEventPublisher類型的Bean其實就是ApplicationContext本身。

問題在於，ApplicationEventPublisher是幹嘛的？為什麼需要註入一個ApplicationEventPublisher類型的Bean？

簡單來說，ApplicationEventPublisher就是一個事件發佈器，專門用於發佈事件的。其定義了一個 void publishEvent(ApplicationEvent event) 方法，能夠發佈ApplicationEvent類型的事件。

因此，MusicService的play方法做了這件事情：獲取當前時間的小時，判斷當前時間的小時是否等於23，以此判斷當前時間是不是在晚上十一點到晚上十二點之間。如果是，則進行事件的發佈；否則什麼也不做。事件發佈的流程是這樣的：
1.創建一個MusicEvent類型的事件。
2.以MusicEvent類型的事件為參數，調用ApplicationEventPublisher的publishEvent方法發佈事件。

因此，我們只要調用MusicService的play方法就能發佈事件了。從而觸發音樂事件監聽器，讓音樂事件監聽器播放音樂。為此，我們需要寫個Java配置類，告訴Spring容器創建相應的Bean：

 1 @Configuration
 2 public class AppConfig {
 3     @Bean("musicService")
 4     public MusicService produceMusicService() {
 5         return new MusicService();
 6     }
 7 
 8     @Bean("musicListener")
 9     public MusicListener produceMusicListener() {
10         return new MusicListener();
11     }
12 }

之後，我們只需要在main函數里使用Java配置類創建一個Spring容器，從Spring容器里拿到ID為musicService的Bean之後調用Bean的play方法就能發佈事件了：

1 public class Main {
2     public static void main(String[] args) {
3         try (var context = new AnnotationConfigApplicationContext(AppConfig.class)) {
4             var musicService = context.getBean("musicService", MusicService.class);
5             musicService.play("Dream");
6         }
7     }
8 }

我們調用ID為musicService的Bean的play方法發佈了一個音樂事件，使音樂事件監聽器監聽到音樂事件之後播放那首名為《Dream》的音樂。

需要註意的是，事件的發佈與監聽是同步的。也就是說，play方法發佈事件之後需要等到監聽器完成事件的處理之後才能接著往下執行。還有，現在的事件是通過繼承ApplicationEvent抽象類實現的，事件監聽器則是通過實現ApplicationListener介面實現的。我們也能使用@EventListener註解做同樣的事情，只要對MusicEvent和MusicListner稍做改動就行。

具體而言，MusicEvent已經不需要繼承ApplicationEvent抽象類了。可以把它改成一個普通的類：

 1 public class MusicEvent {
 2     private String musicName = null;
 3 
 4     public String getMusicName() {
 5         return this.musicName;
 6     }
 7 
 8     public void setMusicName(String musicName) {
 9         this.musicName = musicName;
10     }
11 }

同樣的，MusicListener也不需要實現ApplicationListener介面。可以把它改成一個普通的類，再把@EventListener註解加到MusicListener的方法上即可：

1 public class MusicListener {
2     @EventListener
3     public void onMusicEvent(MusicEvent musicEvent) {
4         var musicName = musicEvent.getMusicName();
5         var playingMessage = String.format("正在為您播放音樂《%s》", musicName);
6         System.out.println(playingMessage);
7     }
8 }

MusicListener再也沒有實現ApplicationListener介面，而是定義了onMusicEvent方法，再在方法上面添加@EventListener註解，就能監聽MusicEvent事件。另外，如果希望監聽器非同步處理髮布的事件，可往監聽器方法添加@Async註解，如下所示：

1 public class MusicListener {
2     @Async
3     @EventListener
4     public void onMusicEvent(MusicEvent musicEvent) {
5         var musicName = musicEvent.getMusicName();
6         var playingMessage = String.format("正在為您播放音樂《%s》", musicName);
7         System.out.println(playingMessage);
8     }
9 }

於是，關於如何添加自定義事件的介紹就告一段落了。需要瞭解的是，Spring還內置了些事件：
1.ContextRefreshedEvent：Spring容器完成初始化或刷新之後就會發佈這個事件。
2.ContextStartedEvent：Spring容器調用start()方法啟動之後就會發佈這個事件。
3.ContextStoppedEvent：Spring容器調用stop()方法停止之後就會發佈這個事件。
4.ContextClosedEvent：Spring容器調用close()方法關閉之後就會發佈這個事件。
5.RequestHandledEvent：Web請求完成處理之後就會發佈這個事件。
6.ServletRequestHandledEvent：和RequestHandledEvent一樣，也是Web請求完成處理之後就會發佈這個事件。只是這個事件多了一些Servlet的上下文信息。