SpringEvent優(yōu)雅解耦時連續(xù)兩個bug的解決方案

更新時間：2022年12月12日 11:29:04 作者：程序員拾山

這篇文章主要為大家介紹了SpringEvent優(yōu)雅解耦時連續(xù)兩個bug的解決方法，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

1，基本原理

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

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

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

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

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

2，廣播器Multicaster：當事件發(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對事件進行監(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輕松標記一個方法作為監(jiā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());
    }
}

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

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

如@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ā)布這個事件，我們啟動項目看下控制臺是否會打印日志：