深入了解Spring中g(shù)etBean()的五種方式

更新時(shí)間：2023年02月01日 15:24:11 作者：攻城獅susht

在本文中，我們將詳細(xì)介紹從BeanFactory中獲取bean的多種方式。簡(jiǎn)單地說(shuō)，正如方法的名稱(chēng)所表達(dá)的，getBean（）負(fù)責(zé)從Spring?IOC容器中獲取bean實(shí)例，希望對(duì)大家有所幫助

1.簡(jiǎn)介

在本文中，我們將詳細(xì)介紹從BeanFactory中獲取bean的多種方式。

簡(jiǎn)單地說(shuō)，正如方法的名稱(chēng)所表達(dá)的，getBean（）負(fù)責(zé)從Spring IOC容器中獲取bean實(shí)例。

2. 創(chuàng)建Bean容器

首先，讓我們定義一些用于測(cè)試的Spring bean。創(chuàng)建spring IOC容器有多種方式，但是在本文中，我們將使用基于注釋的Java配置:

@Configuration
class AnnotationConfig {
 
    @Bean(name = {"tiger", "kitty"})
    @Scope(value = "prototype")
    Tiger getTiger(String name) {
        return new Tiger(name);
    }
 
    @Bean(name = "lion")
    Lion getLion() {
        return new Lion("Hardcoded lion name");
    }
 
    interface Animal {}
}

我們創(chuàng)建了兩個(gè)bean。Lion具有默認(rèn)的單例作用域。Tiger被顯式地設(shè)置為prototype。另外，我們?yōu)槊總€(gè)bean定義了名稱(chēng)，這些名稱(chēng)將在后邊的實(shí)例中使用。

3. getBean（） API

BeanFactory提供了getBean()方法的5個(gè)方法，我們將在下面的小節(jié)中研究。

3.1. 按名稱(chēng)獲取Bean

讓我們看看如何使用名稱(chēng)獲取Lion Bean實(shí)例：

Object lion = context.getBean("lion");
 
assertEquals(Lion.class, lion.getClass());

在此方法中，我們根據(jù)bean名稱(chēng)獲取bean，如果在spring ico容器中存在和bean，則返回Object 類(lèi)的實(shí)例。否則，拋出如下異常

NoSuchBeanDefinitionException。

主要的缺點(diǎn)是，在獲取bean之后，我們必須將它轉(zhuǎn)換為所需的類(lèi)型。如果返回的bean的類(lèi)型與我們期望的不同，則可能會(huì)產(chǎn)生異常。

假設(shè)我們?cè)噲D用“tiger”這個(gè)名字來(lái)得到“lion”。當(dāng)我們將結(jié)果轉(zhuǎn)換為lion時(shí)，它會(huì)拋出一個(gè)ClassCastException:

assertThrows(ClassCastException.class, () -> {
    Tiger tiger = (Tiger) context.getBean("lion");
});

3.2.通過(guò)名稱(chēng)和類(lèi)型獲取Bean

在這里，我們需要指定所請(qǐng)求bean的名稱(chēng)和類(lèi)型：

Lion lion = context.getBean("lion", Lion.class);

與3.1的方法相比，此方法更安全，因?yàn)槲覀兛梢跃幾g階段就發(fā)現(xiàn)錯(cuò)誤而不是在運(yùn)行階段。

assertThrows(BeanNotOfRequiredTypeException.class, () -> 
    context.getBean("lion", Tiger.class));
}

3.3. 按類(lèi)型獲取Bean

使用getBean（）的第三種方式，僅指定bean類(lèi)型就足夠了

Lion lion = context.getBean(Lion.class);

在這種情況下，我們需要特別注意可能存在的歧義：

assertThrows(NoUniqueBeanDefinitionException.class, () -> 
    context.getBean(Animal.class));
}

在上面的示例中，由于Lion和Tiger都實(shí)現(xiàn)了Animal接口，因此僅指定類(lèi)型不足以明確確定結(jié)果。因此，我們得到一個(gè)NoUniqueBeanDefinitionException。即在同一個(gè)IOC 容器中，如果有相同類(lèi)型的多個(gè)bean，則不能通過(guò)類(lèi)型獲取bean。

3.4. 按名稱(chēng)和構(gòu)造函數(shù)參數(shù)對(duì)Bean進(jìn)行篩選

除了bean名稱(chēng)，我們還可以傳遞構(gòu)造函數(shù)參數(shù)：

Tiger tiger = (Tiger) context.getBean("tiger", "Siberian");

這個(gè)方法有點(diǎn)不同，因?yàn)樗贿m用于具有原型作用域的bean。

在單例的情況下，我們將得到BeanDefinitionStoreException異常。

因?yàn)樵蚥ean,每次從spring ioc容器中獲取bean都會(huì)返回一個(gè)新創(chuàng)建的實(shí)例，所以我們可以在調(diào)用getBean()時(shí)動(dòng)態(tài)地提供構(gòu)造函數(shù)參數(shù):

Tiger tiger = (Tiger) context.getBean("tiger", "Siberian");
Tiger secondTiger = (Tiger) context.getBean("tiger", "Striped");
 
assertEquals("Siberian", tiger.getName());
assertEquals("Striped", secondTiger.getName());

正如我們所看到的，根據(jù)我們?cè)谡?qǐng)求bean時(shí)指定的第二個(gè)參數(shù)，每個(gè)Tiger都有不同的名稱(chēng)。

3.5. 按類(lèi)型和構(gòu)造函數(shù)參數(shù)對(duì)Bean進(jìn)行篩選

此方法類(lèi)似于上一個(gè)方法，但是我們需要將類(lèi)型而不是名稱(chēng)作為第一個(gè)參數(shù)傳遞：

Tiger tiger = context.getBean(Tiger.class, "Shere Khan");
 
assertEquals("Shere Khan", tiger.getName());

與3.4相似，此方法僅適用于具有原型作用域的bean。

4.使用注意事項(xiàng)

getBean()盡管是在BeanFactory接口中定義的，但是getBean()方法大部分是通過(guò)ApplicationContext訪問(wèn)。通常，我們?cè)趹?yīng)用程序中不希望直接使用getBean()方法。

Bean應(yīng)該由容器管理。如果我們想使用它們中的一個(gè)，我們應(yīng)該依賴(lài)依賴(lài)注入，而不是直接調(diào)用ApplicationContext.getBean()。這樣，我們就可以避免將應(yīng)用程序邏輯與與框架相關(guān)的細(xì)節(jié)混合在一起。