1，基本原理

日常開發(fā)中，我們有時會使用SpringEvent對業(yè)務(wù)解耦，使我們的代碼更加高內(nèi)聚低耦合，不過如果對其運(yùn)行原理不清楚，那么在使用的過程中，一不留神就會出現(xiàn)一些bug。

今天我們回顧一下SpringEvent使用的基本原理，需要優(yōu)化的點，以及非常常見的兩種錯誤。

Spring的事件模式其實很簡單，我們創(chuàng)建一個Event事件，當(dāng)Event發(fā)生時，廣播器對事件進(jìn)行發(fā)布，然后對應(yīng)的Listener進(jìn)行處理即可。

Spring的事件一共有三個組件：

1，Event：用于定于我們的事件，比如ApplicationEvent或者通過繼承ApplicationEvent定義我們自己的事件。

2，廣播器Multicaster：當(dāng)事件發(fā)生時，將事件廣播出去。

3，監(jiān)聽器Listener：監(jiān)聽和處理廣播器廣播的事件。

2，基本用法

第一步，首先定義一個Event事件，

@Getter
@Setter
public class MessageEvent extends ApplicationEvent {
    private String content;
    public MessageEvent(String content) {
        super(new Object());
        this.content = content;
    }
}

第二步，定義一個Listener對事件進(jìn)行監(jiān)聽，

@Component
public class MessageListener {
    @EventListener
    public void listen(MessageEvent messageEvent) {
        System.out.println("收到消息：" + messageEvent.getContent());
    }
}

最后在我們的業(yè)務(wù)邏輯需要的地方，就可以發(fā)布事件了。

@RestController
@RequestMapping(value = "/demo")
public class DemoController {
    @Resource
    private ApplicationContext applicationContext;
    @PostMapping(value = "/send")
    public ResponseEntity sendMessage() {
        //.....
        //處理一些業(yè)務(wù)邏輯之后，發(fā)送通知消息
        MessageEvent messageEvent = new MessageEvent("發(fā)布一條測試消息");
        this.applicationContext.publishEvent(messageEvent);
        return ResponseEntity.ok().build();
    }
}

3，需要注意的點

一，對于同一個Event，我們可以定義多個Listener，多個Listener之間可以通過@Order來指定順序，order的Value值越小，執(zhí)行的優(yōu)先級就越高。

二，我們可以使用@EventListener輕松標(biāo)記一個方法作為監(jiān)聽器，但是默認(rèn)情況下，它是同步執(zhí)行的，所以如果發(fā)布事件的方法處于事務(wù)中，那么事務(wù)會在監(jiān)聽器方法執(zhí)行完畢之后才提交。

有些情況下，我們希望事件發(fā)布之后就由監(jiān)聽器去處理，而不要影響原有的事務(wù)，也就是說希望事務(wù)及時提交。

這時我們可以使用@TransactionalEventListener來定義一個監(jiān)聽器。

@Component
public class MessageListener {
    //上層事務(wù)執(zhí)行完畢之后再執(zhí)行
    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT, fallbackExecution = true)
    public void listen(MessageEvent messageEvent) {
        System.out.println(Thread.currentThread().getName());
        System.out.println("收到消息：" + messageEvent.getContent());
    }
}

三，默認(rèn)情況下，@EventListener定義的方法是同步執(zhí)行的，如果我們想通過異步的方式執(zhí)行一個監(jiān)聽器的方法，可以在方法上加上@Async注解（記得在啟動類上加上@EnableAsync開啟異步執(zhí)行配置）。

需要注意的是，使用@Async時，必須為其配置線程池，否則用的還是默認(rèn)的線程。

如@Async(value = "taskExecutor")，此時Listener就會被分配到taskExecutor的線程池中執(zhí)行。

使用@Async異步執(zhí)行的同時，還會帶來另外兩個問題，需要大家注意：

1，如果Listener執(zhí)行過程中拋出了異常，由于是異步執(zhí)行，異常并不會被事件發(fā)布方捕獲。

2，異步執(zhí)行時，方法的返回值不能用來發(fā)布后續(xù)事件，如果需要處理結(jié)果去發(fā)布另一個事件，需要我們手動去發(fā)布。

4，常見錯誤一：錯誤的監(jiān)聽一個并不會拋出的事件

有時我們希望監(jiān)聽Spring的啟動事件，做一些初始化操作。于是有的同學(xué)可能定義了這樣一個Listener：

@Component
public class MessageListener {
    @EventListener
    public void listen2(ContextStartedEvent event) {
        System.out.println("Spring啟動了，" + event.toString());
    }
}

不過，雖然名字看起來似乎是一個上下文啟動時的事件，但是Spring啟動時并不會發(fā)布這個事件，我們啟動項目看下控制臺是否會打印日志：

可以看到，Spring項目啟動后，并沒有打印任何日志。

其實Spring項目啟動后發(fā)布的真正Event是ContextRefreshedEvent，我們修改下代碼再看一下結(jié)果：

這時，控制臺打印出了我們想要的日志。

在創(chuàng)建監(jiān)聽事件時，一定要確保監(jiān)聽的Event是正確的，否則就會監(jiān)聽不到對應(yīng)的事件。

5，常見錯誤二：由于異常導(dǎo)致的事件傳播丟失

即使我們保證事件會被監(jiān)聽器真正的捕獲，但是某些情況下，事件會因為異常導(dǎo)致傳播丟失。

如上圖所示，我們定義了兩個Listener，原本期望按照order定義的順序，將消息傳播依次傳播。然而因為一些原因，Listener1中的方法拋出了異常，導(dǎo)致Listener2無法接收到消息了。

這是因為：默認(rèn)情況下處理器的執(zhí)行是順序執(zhí)行的，在執(zhí)行過程中，如果一個監(jiān)聽器執(zhí)行拋出了異常，則后續(xù)監(jiān)聽器就得不到被執(zhí)行的機(jī)會了。

我們可以通過SimpleApplicationEventMulticaster中的multicastEvent方法看一下事件是如何傳播的，

通過上圖可以看出，如果在沒有定義線程池的情況下，在invokeListener方法中會調(diào)用doInvokeListener方法去執(zhí)行真正的邏輯，在doInvokeListener方法中，如果拋出了異常，會導(dǎo)致后的Listener失效。

針對異常這種情況又該如何處理我們的代碼呢？

有三種方法：

1，使用try catch捕獲異常，只要Listener方法不拋出異常，自然每個Listener都可以收到廣播的消息。

2，使用@Async異步執(zhí)行，通過上面的源碼可以看到，如果定義的線程池，那么每一個Listener都會在一個線程中執(zhí)行，每個線程之后是相互獨立的，自然不會影響別人。

3，通過ErrorHandler處理掉異常，保證后面的Listener不受影響。

總結(jié)

本文主要講解了SpringEvent基本的使用方法，和平常開發(fā)中可能會遇到的一些問題。總的來說，Spring為了讓大家用的更輕松，考慮了各種可能發(fā)生的情況，但是如果大家不了解背后的實現(xiàn)原理，就可能發(fā)生一些本不該出現(xiàn)的bug。