quarkus依賴註入之二：bean的作用域

来源:https://www.cnblogs.com/bolingcavalry/archive/2023/07/31/17589397.html
-Advertisement-
Play Games

### 歡迎訪問我的GitHub > 這裡分類和彙總了欣宸的全部原創(含配套源碼)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos) ### 關於bean的作用域（scope） - 官方資料：ht ...


歡迎訪問我的GitHub

這裡分類和彙總了欣宸的全部原創(含配套源碼)：https://github.com/zq2599/blog_demos

關於bean的作用域（scope）

  • 官方資料：https://lordofthejars.github.io/quarkus-cheat-sheet/#_injection

  • 作為《quarkus依賴註入》系列的第二篇，繼續學習一個重要的知識點：bean的作用域（scope），每個bean的作用域是唯一的，不同類型的作用域，決定了各個bean實例的生命周期，例如：何時何處創建，又何時何處銷毀

  • bean的作用域在代碼中是什麼樣的？回顧前文的代碼，如下，ApplicationScoped就是作用域，表明bean實例以單例模式一直存活（只要應用還存活著），這是業務開發中常用的作用域類型：

@ApplicationScoped
public class ClassAnnotationBean {

    public String hello() {
        return "from " + this.getClass().getSimpleName();
    }
}
  • 作用域有多種，如果按來源區分一共兩大類：quarkus內置和擴展組件中定義，本篇聚焦quarkus的內置作用域
  • 下麵是整理好的作用域一覽，接下來會逐個講解
graph LR L1(作用域) --> L2-1(內置) L1 --> L2-2(擴展組件) L2-1 --> L3-1(常規作用域) L2-1 --> L3-2(偽作用域) L3-1 --> L4-1(ApplicationScoped) L3-1 --> L4-2(RequestScoped) L3-1 --> L4-3(SessionScoped) L3-2 --> L4-4(Singleton) L3-2 --> L4-5(Dependent) L2-2 --> L3-6(例如 : TransactionScoped)

常規作用域和偽作用域

  • 常規作用域，quarkus官方稱之為normal scope，包括：ApplicationScoped、RequestScoped、SessionScoped三種
  • 偽作用域稱之為pseudo scope，包括：Singleton、RequestScoped、Dependent兩種
  • 接下來，用一段最平常的代碼來揭示常規作用域和偽作用域的區別
  • 下麵的代碼中，ClassAnnotationBean的作用域ApplicationScoped就是normal scope，如果換成Singleton就是pseudo scope了
@ApplicationScoped
public class ClassAnnotationBean {

    public String hello() {
        return "from " + this.getClass().getSimpleName();
    }
}
  • 再來看使用ClassAnnotationBean的代碼，如下所示，是個再平常不過的依賴註入
@Path("/classannotataionbean")
public class ClassAnnotationController {

    @Inject
    ClassAnnotationBean classAnnotationBean;

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String get() {
        return String.format("Hello RESTEasy, %s, %s",
                LocalDateTime.now(),
                classAnnotationBean.hello());
    }
}
  • 現在問題來了，ClassAnnotationBean是何時被實例化的？有以下兩種可能：

  1. 第一種：ClassAnnotationController被實例化的時候，classAnnotationBean會被註入，這時ClassAnnotationBean被實例化

  2. 第二種：get方法第一次被調用的時候，classAnnotationBean真正發揮作用，這時ClassAnnotationBean被實例化

  • 所以，一共有兩個時間點：註入時和get方法首次執行時，作用域不同，這兩個時間點做的事情也不同，下麵用表格來解釋
時間點 常規作用域 偽作用域
註入的時候 註入的是一個代理類，此時ClassAnnotationBean並未實例化 觸發ClassAnnotationBean實例化
get方法首次執行的時候 1. 觸發ClassAnnotationBean實例化
2. 執行常規業務代碼		 1. 執行常規業務代碼
  • 至此，您應該明白兩種作用域的區別了：偽作用域的bean，在註入的時候實例化，常規作用域的bean，在註入的時候並未實例化，只有它的方法首次執行的時候才會實例化，如下圖

image-20220313094309886

  • 接下來細看每個作用域

ApplicationScoped

  • ApplicationScoped算是最常用的作用域了，它修飾的bean，在整個應用中只有一個實例

RequestScoped

  • 這是與當前http請求綁定的作用域，它修飾的bean，在每次http請求時都有一個全新實例，來寫一段代碼驗證
  • 首先是bean類RequestScopeBean.java，註意作用域是RequestScoped，如下，在構造方法中列印日誌，這樣可以通過日誌行數知道實例化次數
package com.bolingcavalry.service.impl;

import io.quarkus.logging.Log;
import javax.enterprise.context.RequestScoped;

@RequestScoped
public class RequestScopeBean {

    /**
     * 在構造方法中列印日誌，通過日誌出現次數對應著實例化次數
     */
    public RequestScopeBean() {
        Log.info("Instance of " + this.getClass().getSimpleName());
    }

    public String hello() {
        return "from " + this.getClass().getSimpleName();
    }
}
  • 然後是使用bean的代碼，是個普通的web服務類
package com.bolingcavalry;

import com.bolingcavalry.service.impl.RequestScopeBean;
import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import java.time.LocalDateTime;

@Path("/requestscope")
public class RequestScopeController {

    @Inject
    RequestScopeBean requestScopeBean;

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String get() {
        return String.format("Hello RESTEasy, %s, %s",
                LocalDateTime.now(),
                requestScopeBean.hello());
    }
}
  • 最後是單元測試代碼RequestScopeControllerTest.java，要註意的是註解RepeatedTest，有了此註解，testGetEndpoint方法會重覆執行，次數是註解的value屬性值，這裡是10次
package com.bolingcavalry;

import com.bolingcavalry.service.impl.RequestScopeBean;
import io.quarkus.test.junit.QuarkusTest;
import org.junit.jupiter.api.RepeatedTest;
import org.junit.jupiter.api.Test;

import static io.restassured.RestAssured.given;
import static org.hamcrest.CoreMatchers.containsString;

@QuarkusTest
class RequestScopeControllerTest {

    @RepeatedTest(10)
    public void testGetEndpoint() {
        given()
                .when().get("/requestscope")
                .then()
                .statusCode(200)
                // 檢查body內容，是否含有ClassAnnotationBean.hello方法返回的字元串
                .body(containsString("from " + RequestScopeBean.class.getSimpleName()));
    }
}
  • 由於單元測試中介面會調用10次，按照RequestScoped作用域的定義，RequestScopeBean會實例化10次，執行單元測試試試吧
  • 執行結果如下圖，紅框4顯示每次http請求都會觸發一次RequestScopeBean實例化，符合預期，另外還有意外收穫，稍後馬上就會提到

image-20220313103932524

  • 另外，請重點關註藍框和藍色註釋文字，這是意外收穫，居然看到了代理類的日誌，看樣子代理類是繼承了RequestScopeBean類，於是父類構造方法中的日誌代碼也執行了，還把代理類的類名列印出來了
  • 從日誌可以看出：10次http請求，bean的構造方法執行了10次，代理類的構造方法只執行了一次，這是個重要結論：bean類被多次實例化的時候，代理類不會多次實例化

SessionScoped

  • SessionScoped與RequestScoped類似，區別是範圍，RequestScoped是每次http請求做一次實例化，SessionScoped是每個http會話，以下場景都在session範圍內，共用同一個bean實例：
  1. servlet的service方法
  2. servlet filter的doFileter方法
  3. web容器調用HttpSessionListener、AsyncListener、ServletRequestListener等監聽器

Singleton

  • 提到Singleton，聰明的您是否想到了單例模式，這個scope也是此意：它修飾的bean，在整個應用中只有一個實例

  • Singleton和ApplicationScoped很像，它們修飾的bean，在整個應用中都是只有一個實例，然而它們也是有區別的：ApplicationScoped修飾的bean有代理類包裹，Singleton修飾的bean沒有代理類

  • Singleton修飾的bean沒有代理類，所以在使用的時候，對bean的成員變數直接讀寫都沒有問題（safely），而ApplicationScoped修飾的bean，請不要直接讀寫其成員變數，比較拿都是代理的東西，而不是bean的類自己的成員變數

  • Singleton修飾的bean沒有代理類，所以實際使用中性能會略好（slightly better performance）

  • 在使用QuarkusMock類做單元測試的時候，不能對Singleton修飾的bean做mock，因為沒有代理類去執行相關操作

  • quarkus官方推薦使用的是ApplicationScoped

  • Singleton被quarkus劃分為偽作用域，此時再回頭品味下圖，您是否恍然大悟：成員變數classAnnotationBean如果是Singleton，是沒有代理類的，那就必須在@Inject位置實例化，否則，在get方法中classAnnotationBean就是null，會空指針異常的

image-20220313094309886

  • 運行代碼驗證是否有代理類，找到剛纔的RequestScopeBean.java，將作用域改成Singleton，運行單元測試類RequestScopeControllerTest.java，結果如下圖紅框，只有RequestScopeBean自己構造方法的日誌
    image-20220313143317829

  • 再將作用域改成ApplicationScoped，如下圖藍框，代理類日誌出現

image-20220313143449144

Dependent

  • Dependent是個偽作用域，它的特點是：每個依賴註入點的對象實例都不同
  • 假設DependentClinetA和DependentClinetB都用@Inject註解註入了HelloDependent，那麼DependentClinetA引用的HelloDependent對象，DependentClinetB引用的HelloDependent對象，是兩個實例，如下圖，兩個hello是不同的實例
流程圖 (18)

Dependent的特殊能力

  • Dependent的特點是每個註入點的bean實例都不同，針對這個特點，quarkus提供了一個特殊能力：bean的實例中可以取得註入點的元數據
  • 對應上圖的例子，就是HelloDependent的代碼中可以取得它的使用者：DependentClientA和DependentClientB的元數據
  • 寫代碼驗證這個特殊能力
  • 首先是HelloDependent的定義，將作用域設置為Dependent，然後註意其構造方法的參數，這就是特殊能力所在，是個InjectionPoint類型的實例，這個參數在實例化的時候由quarkus容器註入，通過此參數即可得知使用HelloDependent的類的身份
@Dependent
public class HelloDependent {

    public HelloDependent(InjectionPoint injectionPoint) {
        Log.info("injecting from bean "+ injectionPoint.getMember().getDeclaringClass());
    }

    public String hello() {
        return this.getClass().getSimpleName();
    }
}
  • 然後是HelloDependent的使用類DependentClientA
@ApplicationScoped
public class DependentClientA {

    @Inject
    HelloDependent hello;

    public String doHello() {
        return hello.hello();
    }
}

  • DependentClientB的代碼和DependentClientA一模一樣，就不貼出來了

  • 最後寫個單元測試類驗證HelloDependent的特殊能力

@QuarkusTest
public class DependentTest {

    @Inject
    DependentClientA dependentClientA;

    @Inject
    DependentClientB dependentClientB;

    @Test
    public void testSelectHelloInstanceA() {
        Class<HelloDependent> clazz = HelloDependent.class;

        Assertions.assertEquals(clazz.getSimpleName(), dependentClientA.doHello());
        Assertions.assertEquals(clazz.getSimpleName(), dependentClientB.doHello());
    }
}
  • 運行單元測試，如下圖紅框，首先，HelloDependent的日誌列印了兩次，證明的確實例化了兩個HelloDependent對象，其次日誌的內容也準確的將註入點的類的信息列印出來

image-20220326172853871

擴展組件的作用域

  • quarkus的擴展組件豐富多彩，自己也能按照官方指引製作，所以擴展組件對應的作用域也隨著組件的不同而各不相同，就不在此列舉了，就舉一個例子吧：quarkus-narayana-jta組件中定義了一個作用域javax.transaction.TransactionScoped，該作用域修飾的bean，每個事物對應一個實例

  • 至此，quarkus作用域的瞭解和實戰已經完成，這樣一來，不論是使用bean還是創建bean，都能按業務需要來準確控制其生命周期了

歡迎關註博客園：程式員欣宸

學習路上，你不孤單，欣宸原創一路相伴...


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

-Advertisement-
Play Games
更多相關文章
  • 《痞子衡嵌入式半月刊》 第 79 期
    # 痞子衡嵌入式半月刊： 第 79 期 ![](https://raw.githubusercontent.com/JayHeng/pzh-mcu-bi-weekly/master/pics/pzh_mcu_bi_weekly.PNG) 這裡分享嵌入式領域有用有趣的項目/工具以及一些熱點新聞，農曆年 ...
  • Centos-搭建KMS(vlmcsd)激活伺服器
    大家好，我是痞子衡，是正經搞技術的痞子。今天痞子衡給大家介紹的是**恩智浦i.MX RT1170 FlexSPI NAND啟動時間**。 本篇是 i.MXRT1170 啟動時間評測第四彈，前三篇分別給大家評測了 [Raw NAND 啟動時間](https://www.cnblogs.com/henj ...
  • Mysql高級5-SQL優化
    一、插入數據優化 1.1 批量插入 如果有多條數據需要同時插入，不要每次插入一條，然後分多次插入，因為每執行一次插入的操作，都要進行資料庫的連接，多個操作就會連接多次，而一次批量操作只需要連接1次 1.2 手動提交事務 因為Mysql預設每執行一次操作，就會提交一次事務，這樣就會涉及到頻繁的事務的開 ...
  • Flutter狀態管理-FlyingRedux
    “莆仙小館”——莆田文化展示APP 文化展示程式目的在於應用科學技術助推家鄉優秀傳統文化的展示與交流。通過圖片、視頻、音頻等展示方式向用戶立體地展示一個文化城邦。傳統文化與科學技術的有效融合，順應了社會發展的需要。傳統文化與科學技術的有效融合是發展中國特色社會主義文化的客觀需要，是傳承中國優秀傳統文 ...
  • Angular: 樣式綁定
    # 解決方案 使用`ngClass`和`ngStyle`可以進行樣式的綁定。 ## ngStyle的使用 ngStyle 根據組件中的變數， isTextColorRed和fontSize的值來動態設置元素的顏色和字體大小 ```HTML This text has dynamic styles b ...
  • Flutter系列文章-Flutter進階2
    在本篇文章中，我們詳細介紹了 Flutter 進階的主題，包括導航和路由、狀態管理、非同步處理、HTTP請求和Rest API，以及數據持久化。這些主題在實際應用中都非常重要，幫助你構建更複雜、功能更強大的 Flutter 應用。 ...
  • 從0開發屬於自己的nestjs框架的mini 版 —— koa-decorator路由篇
    在SpringBoot的Controller中，可以使用註解@RequestBody來獲取POST請求中的JSON數據。我們可以將這個註解應用到一個Controller方法的參數上，Spring將會負責讀取請求正文中的數據，將其反序列化為一個Java對象，並將其作為Controller方法的參數傳遞 ...
  • 後端開發必知的11個線程安全小技巧
    對於從事後端開發的同學來說，線程安全問題是我們每天都需要考慮的問題。 線程安全問題通俗地講主要是在多線程的環境下，不同線程同時讀和寫公共資源（臨界資源）導致的數據異常問題。 比如：變數a=0，線程1給該變數+1，線程2也給該變數+1。此時，線程3獲取a的值有可能不是2，而是1。線程3這不就獲取了錯誤 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類