Spring Event 業務解耦神器，大大提高可擴展性，好用到爆！

来源:https://www.cnblogs.com/javastack/archive/2023/11/14/17831142.html
-Advertisement-
Play Games

來源：blog.csdn.net/weixin_42653522/article/details/117151913 1、前言 ApplicationContext 中的事件處理是通過 ApplicationEvent 類和 ApplicationListener 介面提供的。如果將實現了 Appl ...


來源：blog.csdn.net/weixin_42653522/article/details/117151913

1、前言

ApplicationContext 中的事件處理是通過 ApplicationEvent 類和 ApplicationListener 介面提供的。如果將實現了 ApplicationListener 介面的 bean 部署到容器中，則每次將 ApplicationEvent 發佈到ApplicationContext 時，都會通知到該 bean，這簡直是典型的觀察者模式。設計的初衷就是為了系統業務邏輯之間的解耦，提高可擴展性以及可維護性。

Spring 中提供了以下的事件

2、ApplicationEvent 與 ApplicationListener 應用

推薦一個開源免費的 Spring Boot 實戰項目：

https://github.com/javastacks/spring-boot-best-practice

實現

1、自定義事件類，基於 ApplicationEvent 實現擴展

public class DemoEvent extends ApplicationEvent {
    private static final long serialVersionUID = -2753705718295396328L;
    private String msg;

    public DemoEvent(Object source, String msg) {
        super(source);
        this.msg = msg;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}

2、定義 Listener 類，實現 ApplicationListener介面，並且註入到 IOC 中。等發佈者發佈事件時，都會通知到這個bean，從而達到監聽的效果。

@Component
public class DemoListener implements ApplicationListener<DemoEvent> {
    @Override
    public void onApplicationEvent(DemoEvent demoEvent) {
        String msg = demoEvent.getMsg();
        System.out.println("bean-listener 收到了 publisher 發佈的消息: " + msg);
    }
}

3、要發佈上述自定義的 event，需要調用 ApplicationEventPublisher 的 publishEvent 方法，我們可以定義一個實現 ApplicationEventPublisherAware 的類，並註入 IOC來進行調用。

@Component
public class DemoPublisher implements ApplicationEventPublisherAware {

    private ApplicationEventPublisher applicationEventPublisher;

    @Override
    public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
        this.applicationEventPublisher = applicationEventPublisher;
    }

    public void sendMsg(String msg) {
        applicationEventPublisher.publishEvent(new DemoEvent(this, msg));
    }
}

4、客戶端調用 publisher

@RestController
@RequestMapping("/event")
public class DemoClient implements ApplicationContextAware {
    private ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }

    @GetMapping("/publish")
    public void publish(){
        DemoPublisher bean = applicationContext.getBean(DemoPublisher.class);
        bean.sendMsg("發佈者發送消息......");
    }
}

輸出結果：

bean-listener 收到了 publisher 發佈的消息: 發佈者發送消息......

基於註解

我們可以不用實現 AppplicationListener 介面 ，在方法上使用 @EventListener 註冊事件。如果你的方法應該偵聽多個事件，並不使用任何參數來定義，可以在 @EventListener 註解上指定多個事件。

重寫 DemoListener 類如下：

public class DemoListener {
    @EventListener(value = {DemoEvent.class, TestEvent.class})
    public void processApplicationEvent(DemoEvent event) {
        String msg = event.getMsg();
        System.out.println("bean-listener 收到了 publisher 發佈的消息: " + msg);
    }
}
事件過濾

如果希望通過一定的條件對事件進行過濾，可以使用 @EventListener 的 condition 屬性。以下實例中只有 event 的 msg 屬性是 my-event 時才會進行調用。

@EventListener(value = {DemoEvent.class, TestEvent.class}, condition = "#event.msg == 'my-event'")
public void processApplicationEvent(DemoEvent event) {
     String msg = event.getMsg();
     System.out.println("bean-listener 收到了 publisher 發佈的消息: " + msg);
 }

此時，發送符合條件的消息，listener 才會偵聽到 publisher 發佈的消息。

bean-listener 收到了 publisher 發佈的消息: my-event

非同步事件監聽

前面提到的都是同步處理事件，那如果我們希望某個特定的偵聽器非同步去處理事件，如何做？

使用 @Async 註解可以實現類內方法的非同步調用，這樣方法在執行的時候，將會在獨立的線程中被執行，調用者無需等待它的完成，即可繼續其他的操作。

@EventListener
@Async
public void processApplicationEvent(DemoEvent event) {
    String msg = event.getMsg();
    System.out.println("bean-listener 收到了 publisher 發佈的消息: " + msg);
}

使用非同步監聽時，有兩點需要註意：

  • 如果非同步事件拋出異常，則不會將其傳播到調用方。
  • 非同步事件監聽方法無法通過返回值來發佈後續事件，如果需要作為處理結果發佈另一個事件，請插入 ApplicationEventPublisher 以手動發佈事件

3、好處及應用場景

ApplicationContext 在運行期會自動檢測到所有實現了 ApplicationListener 的 bean，並將其作為事件接收對象。當我們與 spring 上下文交互觸發 publishEvent 方法時，每個實現了 ApplicationListener 的 bean 都會收到 ApplicationEvent 對象，每個 ApplicationListener 可以根據需要只接收自己感興趣的事件。

這樣做有什麼好處呢？

在傳統的項目中，各個業務邏輯之間耦合性比較強，controller 和 service 間都是關聯關係，然而，使用 ApplicationEvent 監聽 publisher 這種方式，類間關係是什麼樣的？我們不如畫張圖來看看。

DemoPublisher 和 DemoListener 兩個類間並沒有直接關聯，解除了傳統業務邏輯兩個類間的關聯關係，將耦合降到最小。這樣在後期更新、維護時難度大大降低了。

ApplicationEvent 使用觀察者模式實現，那什麼時候適合使用觀察者模式呢？觀察者模式也叫 發佈-訂閱模式，例如，微博的訂閱，我們訂閱了某些微博賬號，當這些賬號發佈消息時，我們都會收到通知。

總結來說，定義對象間的一種一對多的依賴關係，當一個對象的狀態發生改變時，所有依賴於它的對象都得到通知並被自動更新，從而實現廣播的效果。

4、源碼閱讀

Spring中的事件機制流程

1、ApplicationEventPublisher是Spring的事件發佈介面，事件源通過該介面的pulishEvent方法發佈事件

2、ApplicationEventMulticaster就是Spring事件機制中的事件廣播器，它預設提供一個SimpleApplicationEventMulticaster實現，如果用戶沒有自定義廣播器，則使用預設的。它通過父類AbstractApplicationEventMulticaster的getApplicationListeners方法從事件註冊表（事件-監聽器關係保存）中獲取事件監聽器，並且通過invokeListener方法執行監聽器的具體邏輯

3、ApplicationListener就是Spring的事件監聽器介面，所有的監聽器都實現該介面，本圖中列出了典型的幾個子類。其中RestartApplicationListnener在SpringBoot的啟動框架中就有使用

4、在Spring中通常是ApplicationContext本身擔任監聽器註冊表的角色，在其子類AbstractApplicationContext中就聚合了事件廣播器ApplicationEventMulticaster和事件監聽器ApplicationListnener，並且提供註冊監聽器的addApplicationListnener方法

通過上圖就能較清晰的知道當一個事件源產生事件時，它通過事件發佈器ApplicationEventPublisher發佈事件，然後事件廣播器ApplicationEventMulticaster會去事件註冊表ApplicationContext中找到事件監聽器ApplicationListnener，並且逐個執行監聽器的onApplicationEvent方法，從而完成事件監聽器的邏輯。

來到ApplicationEventPublisher 的 publishEvent 方法內部

protected void publishEvent(Object event, @Nullable ResolvableType eventType) {
 if (this.earlyApplicationEvents != null) {
 this.earlyApplicationEvents.add(applicationEvent);
 }
 else {
  //
  getApplicationEventMulticaster().multicastEvent(applicationEvent, eventType);
 }
}

多播事件方法

@Override
public void multicastEvent(final ApplicationEvent event, @Nullable ResolvableType eventType) {
 ResolvableType type = (eventType != null ? eventType : resolveDefaultEventType(event));
 Executor executor = getTaskExecutor();
 // 遍歷所有的監聽者
 for (ApplicationListener<?> listener : getApplicationListeners(event, type)) {
  if (executor != null) {
   // 非同步調用監聽器
   executor.execute(() -> invokeListener(listener, event));
  }
  else {
   // 同步調用監聽器
   invokeListener(listener, event);
  }
 }
}

invokeListener

protected void invokeListener(ApplicationListener<?> listener, ApplicationEvent event) {
 ErrorHandler errorHandler = getErrorHandler();
 if (errorHandler != null) {
  try {
   doInvokeListener(listener, event);
  }
  catch (Throwable err) {
   errorHandler.handleError(err);
  }
 }
 else {
  doInvokeListener(listener, event);
 }
}

doInvokeListener

private void doInvokeListener(ApplicationListener listener, ApplicationEvent event) {
 try {
  // 這裡是事件發生的地方
  listener.onApplicationEvent(event);
 }
 catch (ClassCastException ex) {
  ......
 }
}

點擊 ApplicationListener 介面 onApplicationEvent 方法的實現，可以看到我們重寫的方法。

5、總結

Spring 使用反射機制，獲取了所有繼承 ApplicationListener 介面的監聽器，在 Spring 初始化時，會把監聽器都自動註冊到註冊表中。

Spring 的事件發佈非常簡單，我們來總結一下：

  • 定義一個繼承 ApplicationEvent 的事件
  • 定義一個實現 ApplicationListener 的監聽器或者使用 @EventListener 監聽事件
  • 定義一個發送者，調用 ApplicationContext 直接發佈或者使用 ApplicationEventPublisher 來發佈自定義事件

最後，發佈-訂閱模式可以很好的將業務邏輯進行解耦（上圖驗證過），大大提高了可維護性、可擴展性。

近期熱文推薦：

1.1,000+ 道 Java面試題及答案整理(2022最新版)

2.勁爆！Java 協程要來了。。。

3.Spring Boot 2.x 教程，太全了！

4.別再寫滿屏的爆爆爆炸類了，試試裝飾器模式，這才是優雅的方式！！

5.《Java開發手冊（嵩山版）》最新發佈，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • C++ 中 <iterator> <functional> <numeric> 庫好用的函數
    C++ 中 <iterator> <functional> <numeric> 庫好用的函數 泰褲辣！ <iterator> 簡述：迭代器省代碼用的。 std::advance 記憶方法：advance－前進。 形如：advance(it, step)，表示 it 迭代器自增 step 步。 實現類 ...
  • Python學習 —— 內置數據類型
    寫在前面 接上文《Python學習 —— 初步認知》，有需要請自取：Python學習 —— 初步認知 在這篇文章中，我們一起深入瞭解Python中常用的內置數據類型。Python是一種功能強大的編程語言，它提供了多種內置數據類型，用於存儲和操作數據。這些數據類型包括數字、字元串、序列和映射等。熟練掌 ...
  • Python中的賦值表達式
    賦值表達式（assignment expression）是Python 3.8新引入的語法，它會用到海象操作符（walrus operator）。 這種寫法可以解決某些持續已久的代碼重覆問題。a = b是一條普通的賦值語句，讀作a equals b，而a := b則是賦值表達式，讀作a walrus ...
  • 因為懶得百度，我選擇自己寫篇博文教自己配置JAVA環境
    1.首先是準備施法材料 JDK的下載地址：https://www.oracle.com/java/technologies/downloads/ 然後選擇自己的想要的版本和英雄（系統） 選擇x64 Compressed Archive免安裝版本進行下載（解壓就用，免除瘋狂確認的煩惱） 解壓到某個位置 ...
  • 妙用 FutureTask + 線程池：輕鬆解決介面超時問題！
    來源：blog.csdn.net/qq_44384533/article/details/112324224 之前紅包權益領取查詢的介面超時了，因為有用戶訂購的權益有點多 解決方案 用線程池+ FutureTask將1個查詢拆分成多個小查詢 選擇FutureTask是因為它具有僅執行1次run()方 ...
  • java異常處理機制(三)常見異常
    NullPointerException（空指針異常）：當試圖調用實例方法或訪問實例變數時，對象引用為 null 時拋出。ArithmeticException（算術異常）：當試圖做出違反算術規則的操作時拋出，比如除以零。ClassCastException（類轉換異常）：當試圖將對象強制轉換為不是... ...
  • JDK11 升級 JDK17 最全實踐乾貨來了
    從JDK11到JDK17，到底帶來了哪些特性呢？亞毫秒級的ZGC效果到底怎麼樣呢？值得我們升級嗎？而且升級過程會遇到哪些問題呢？帶著這些問題，本篇文章將帶來完整的JDK11升級JDK17最全實踐。 ...
  • 大廠都是怎麼做Redis重試的？
    0 前言 潛心打造國內一流，國際領先的技術乾貨。 文章收錄在我的 GitHub 倉庫，歡迎Star/fork： JavaEdge-Interview 受網路和運行環境影響，應用程式可能遇到暫時性故障，如瞬時網路抖動、服務暫時不可用、服務繁忙導致超時等。 自動重試機制可大幅避免此類故障，保障操作成功執 ...
一周排行
    -Advertisement-
    Play Games
  • WPF 已知問題 監聽 WMI 事件導致觸摸失效
    示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後，項目結構如下所示： MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread]特性
    [STAThread] 特性用於需要與 COM 組件交互的應用程式，尤其是依賴單線程模型（如 Windows Forms 應用程式）的組件。在 STA 模式下，線程擁有自己的消息迴圈，這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • UWP WinUI3 傳入 AddHandler 的 RoutedEventHandler 類型與事件所需不匹配將拋出參數異常
    在WinForm中使用全局異常捕獲處理 在WinForm應用程式中，全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理，可以有效地捕獲並處理未預見的異常，從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • .NET 多版本 WinForm 開源控制項庫 SunnyUI
    前言 給大家推薦一款開源的 Winform 控制項庫，可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫，同時也提供了工具類庫、擴展 ...
  • .net core8 使用Swagger（附當前源碼）
    說明 該文章是屬於OverallAuth2.0系列文章，每周更新一篇該系列文章（從0到1完成系統開發）。 該系統文章，我會儘量說的非常詳細，做到不管新手、老手都能看懂。 說明：OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友，請關註我吧(*^▽^*) ...
  • WPF 什麼時候 VisualTreeHelper.GetDescendantBounds 將返回無窮大
    一、下載安裝 1.下載git 必須先下載並安裝git，再TortoiseGit下載安裝 git安裝參考教程：https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit，Git客戶端，32/6 ...
  • C# 開源教程帶你輕鬆掌握數據結構與演算法
    前言 在項目開發過程中，理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼，還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程：Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 第22篇 生成proto文件bat腳本
    1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 記一次 .NET某上位機視覺程式 卡死分析
    一：背景 1. 講故事 前段時間有位朋友找到我，說他的窗體程式在客戶這邊出現了卡死，讓我幫忙看下怎麼回事？dump也生成了，既然有dump了那就上 windbg 分析吧。 二：WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死，入口門檻很低，後續往下分析就不一定了，不管怎麼說先用 !clrsta ...
  • 醫學DICOM文件與PACS系統進行數據傳輸
    前言 人工智慧時代，人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API，工具不僅易於集成，還具備高效處理能力。 本文將介紹一款如何利用這些API，為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...
所有分類