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

這篇具有很好參考價(jià)值的文章主要介紹了quarkus依賴注入之二：bean的作用域。希望對(duì)大家有所幫助。如果存在錯(cuò)誤或未考慮完全的地方，請(qǐng)大家不吝賜教，您也可以點(diǎn)擊"舉報(bào)違法"按鈕提交疑問。

歡迎訪問我的GitHub

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

關(guān)于bean的作用域（scope）

官方資料：https://lordofthejars.github.io/quarkus-cheat-sheet/#_injection
作為《quarkus依賴注入》系列的第二篇，繼續(xù)學(xué)習(xí)一個(gè)重要的知識(shí)點(diǎn)：bean的作用域（scope），每個(gè)bean的作用域是唯一的，不同類型的作用域，決定了各個(gè)bean實(shí)例的生命周期，例如：何時(shí)何處創(chuàng)建，又何時(shí)何處銷毀
bean的作用域在代碼中是什么樣的？回顧前文的代碼，如下，ApplicationScoped就是作用域，表明bean實(shí)例以單例模式一直存活（只要應(yīng)用還存活著），這是業(yè)務(wù)開發(fā)中常用的作用域類型：

@ApplicationScoped
public class ClassAnnotationBean {

    public String hello() {
        return "from " + this.getClass().getSimpleName();
    }
}

作用域有多種，如果按來源區(qū)分一共兩大類：quarkus內(nèi)置和擴(kuò)展組件中定義，本篇聚焦quarkus的內(nèi)置作用域
下面是整理好的作用域一覽，接下來會(huì)逐個(gè)講解

graph LR L1(作用域) --> L2-1(內(nèi)置) L1 --> L2-2(擴(kuò)展組件) L2-1 --> L3-1(常規(guī)作用域) 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)

常規(guī)作用域和偽作用域

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

@ApplicationScoped
public class ClassAnnotationBean {

    public String hello() {
        return "from " + this.getClass().getSimpleName();
    }
}

再來看使用ClassAnnotationBean的代碼，如下所示，是個(gè)再平常不過的依賴注入

@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());
    }
}

現(xiàn)在問題來了，ClassAnnotationBean是何時(shí)被實(shí)例化的？有以下兩種可能：

第一種：ClassAnnotationController被實(shí)例化的時(shí)候，classAnnotationBean會(huì)被注入，這時(shí)ClassAnnotationBean被實(shí)例化
第二種：get方法第一次被調(diào)用的時(shí)候，classAnnotationBean真正發(fā)揮作用，這時(shí)ClassAnnotationBean被實(shí)例化

所以，一共有兩個(gè)時(shí)間點(diǎn)：注入時(shí)和get方法首次執(zhí)行時(shí)，作用域不同，這兩個(gè)時(shí)間點(diǎn)做的事情也不同，下面用表格來解釋

時(shí)間點(diǎn)	常規(guī)作用域	偽作用域
注入的時(shí)候	注入的是一個(gè)代理類，此時(shí)ClassAnnotationBean并未實(shí)例化	觸發(fā)ClassAnnotationBean實(shí)例化
get方法首次執(zhí)行的時(shí)候	1. 觸發(fā)ClassAnnotationBean實(shí)例化 2. 執(zhí)行常規(guī)業(yè)務(wù)代碼	1. 執(zhí)行常規(guī)業(yè)務(wù)代碼

至此，您應(yīng)該明白兩種作用域的區(qū)別了：偽作用域的bean，在注入的時(shí)候?qū)嵗?，常?guī)作用域的bean，在注入的時(shí)候并未實(shí)例化，只有它的方法首次執(zhí)行的時(shí)候才會(huì)實(shí)例化，如下圖

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

接下來細(xì)看每個(gè)作用域

ApplicationScoped

ApplicationScoped算是最常用的作用域了，它修飾的bean，在整個(gè)應(yīng)用中只有一個(gè)實(shí)例

RequestScoped

這是與當(dāng)前http請(qǐng)求綁定的作用域，它修飾的bean，在每次http請(qǐng)求時(shí)都有一個(gè)全新實(shí)例，來寫一段代碼驗(yàn)證
首先是bean類RequestScopeBean.java，注意作用域是RequestScoped，如下，在構(gòu)造方法中打印日志，這樣可以通過日志行數(shù)知道實(shí)例化次數(shù)

package com.bolingcavalry.service.impl;

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

@RequestScoped
public class RequestScopeBean {

    /**
     * 在構(gòu)造方法中打印日志，通過日志出現(xiàn)次數(shù)對(duì)應(yīng)著實(shí)例化次數(shù)
     */
    public RequestScopeBean() {
        Log.info("Instance of " + this.getClass().getSimpleName());
    }

    public String hello() {
        return "from " + this.getClass().getSimpleName();
    }
}

然后是使用bean的代碼，是個(gè)普通的web服務(wù)類

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());
    }
}

最后是單元測(cè)試代碼RequestScopeControllerTest.java，要注意的是注解RepeatedTest，有了此注解，testGetEndpoint方法會(huì)重復(fù)執(zhí)行，次數(shù)是注解的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內(nèi)容，是否含有ClassAnnotationBean.hello方法返回的字符串
                .body(containsString("from " + RequestScopeBean.class.getSimpleName()));
    }
}

由于單元測(cè)試中接口會(huì)調(diào)用10次，按照RequestScoped作用域的定義，RequestScopeBean會(huì)實(shí)例化10次，執(zhí)行單元測(cè)試試試吧
執(zhí)行結(jié)果如下圖，紅框4顯示每次http請(qǐng)求都會(huì)觸發(fā)一次RequestScopeBean實(shí)例化，符合預(yù)期，另外還有意外收獲，稍后馬上就會(huì)提到

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

另外，請(qǐng)重點(diǎn)關(guān)注藍(lán)框和藍(lán)色注釋文字，這是意外收獲，居然看到了代理類的日志，看樣子代理類是繼承了RequestScopeBean類，于是父類構(gòu)造方法中的日志代碼也執(zhí)行了，還把代理類的類名打印出來了
從日志可以看出：10次http請(qǐng)求，bean的構(gòu)造方法執(zhí)行了10次，代理類的構(gòu)造方法只執(zhí)行了一次，這是個(gè)重要結(jié)論：bean類被多次實(shí)例化的時(shí)候，代理類不會(huì)多次實(shí)例化

SessionScoped

SessionScoped與RequestScoped類似，區(qū)別是范圍，RequestScoped是每次http請(qǐng)求做一次實(shí)例化，SessionScoped是每個(gè)http會(huì)話，以下場(chǎng)景都在session范圍內(nèi)，共享同一個(gè)bean實(shí)例：

servlet的service方法
servlet filter的doFileter方法
web容器調(diào)用HttpSessionListener、AsyncListener、ServletRequestListener等監(jiān)聽器

Singleton

提到Singleton，聰明的您是否想到了單例模式，這個(gè)scope也是此意：它修飾的bean，在整個(gè)應(yīng)用中只有一個(gè)實(shí)例
Singleton和ApplicationScoped很像，它們修飾的bean，在整個(gè)應(yīng)用中都是只有一個(gè)實(shí)例，然而它們也是有區(qū)別的：ApplicationScoped修飾的bean有代理類包裹，Singleton修飾的bean沒有代理類
Singleton修飾的bean沒有代理類，所以在使用的時(shí)候，對(duì)bean的成員變量直接讀寫都沒有問題（safely），而ApplicationScoped修飾的bean，請(qǐng)不要直接讀寫其成員變量，比較拿都是代理的東西，而不是bean的類自己的成員變量
Singleton修飾的bean沒有代理類，所以實(shí)際使用中性能會(huì)略好（slightly better performance）
在使用QuarkusMock類做單元測(cè)試的時(shí)候，不能對(duì)Singleton修飾的bean做mock，因?yàn)闆]有代理類去執(zhí)行相關(guān)操作
quarkus官方推薦使用的是ApplicationScoped
Singleton被quarkus劃分為偽作用域，此時(shí)再回頭品味下圖，您是否恍然大悟：成員變量classAnnotationBean如果是Singleton，是沒有代理類的，那就必須在@Inject位置實(shí)例化，否則，在get方法中classAnnotationBean就是null，會(huì)空指針異常的

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

運(yùn)行代碼驗(yàn)證是否有代理類，找到剛才的RequestScopeBean.java，將作用域改成Singleton，運(yùn)行單元測(cè)試類RequestScopeControllerTest.java，結(jié)果如下圖紅框，只有RequestScopeBean自己構(gòu)造方法的日志
再將作用域改成ApplicationScoped，如下圖藍(lán)框，代理類日志出現(xiàn)

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

Dependent

Dependent是個(gè)偽作用域，它的特點(diǎn)是：每個(gè)依賴注入點(diǎn)的對(duì)象實(shí)例都不同
假設(shè)DependentClinetA和DependentClinetB都用@Inject注解注入了HelloDependent，那么DependentClinetA引用的HelloDependent對(duì)象，DependentClinetB引用的HelloDependent對(duì)象，是兩個(gè)實(shí)例，如下圖，兩個(gè)hello是不同的實(shí)例

Dependent的特殊能力

Dependent的特點(diǎn)是每個(gè)注入點(diǎn)的bean實(shí)例都不同，針對(duì)這個(gè)特點(diǎn)，quarkus提供了一個(gè)特殊能力：bean的實(shí)例中可以取得注入點(diǎn)的元數(shù)據(jù)
對(duì)應(yīng)上圖的例子，就是HelloDependent的代碼中可以取得它的使用者：DependentClientA和DependentClientB的元數(shù)據(jù)
寫代碼驗(yàn)證這個(gè)特殊能力
首先是HelloDependent的定義，將作用域設(shè)置為Dependent，然后注意其構(gòu)造方法的參數(shù)，這就是特殊能力所在，是個(gè)InjectionPoint類型的實(shí)例，這個(gè)參數(shù)在實(shí)例化的時(shí)候由quarkus容器注入，通過此參數(shù)即可得知使用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一模一樣，就不貼出來了
最后寫個(gè)單元測(cè)試類驗(yàn)證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());
    }
}

運(yùn)行單元測(cè)試，如下圖紅框，首先，HelloDependent的日志打印了兩次，證明的確實(shí)例化了兩個(gè)HelloDependent對(duì)象，其次日志的內(nèi)容也準(zhǔn)確的將注入點(diǎn)的類的信息打印出來

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

擴(kuò)展組件的作用域

quarkus的擴(kuò)展組件豐富多彩，自己也能按照官方指引制作，所以擴(kuò)展組件對(duì)應(yīng)的作用域也隨著組件的不同而各不相同，就不在此列舉了，就舉一個(gè)例子吧：quarkus-narayana-jta組件中定義了一個(gè)作用域javax.transaction.TransactionScoped，該作用域修飾的bean，每個(gè)事物對(duì)應(yīng)一個(gè)實(shí)例
至此，quarkus作用域的了解和實(shí)戰(zhàn)已經(jīng)完成，這樣一來，不論是使用bean還是創(chuàng)建bean，都能按業(yè)務(wù)需要來準(zhǔn)確控制其生命周期了