淺析Spring獲取Bean的九種方法詳解
前言
隨著SpringBoot的普及,Spring的使用也越來越廣,在某些場(chǎng)景下,我們無法通過注解或配置的形式直接獲取到某個(gè)Bean。比如,在某一些工具類、設(shè)計(jì)模式實(shí)現(xiàn)中需要使用到Spring容器管理的Bean,此時(shí)就需要直接獲取到對(duì)應(yīng)的Bean。
本文為大家整理匯總了常見的獲取Bean的方式,并提供一些優(yōu)劣分析,方便大家在使用到時(shí)有更好的選擇。同時(shí),也會(huì)為大家適當(dāng)?shù)钠占昂屯卣挂恍┫嚓P(guān)知識(shí)。
Spring的IoC容器
在Spring中,Bean的實(shí)例化、定位、配置應(yīng)用程序中的對(duì)象及建立對(duì)象間的依賴關(guān)系,都是在IoC容器中進(jìn)行的。因此,要在Spring中獲取Bean,本質(zhì)上就是從IoC容器當(dāng)中獲取Bean。
在Spring中,BeanFactory是IoC容器的實(shí)際代表者,該接口提供了IoC容器最基本功能。同時(shí),Spring還提供了另外一種類型的容器:ApplicationContext容器。
ApplicationContext容器包括BeanFactory容器的所有功能(BeanFactory的子接口),提供了更多面向應(yīng)用的功能,它提供了國際化支持和框架事件體系,更易于創(chuàng)建實(shí)際應(yīng)用。
一般情況,我們稱BeanFactory為IoC容器,稱ApplicationContext為應(yīng)用上下文。但有時(shí)為了方便,也將ApplicationContext稱為Spring容器。
通常不建議使用BeanFactory,但BeanFactory 仍然可以用于輕量級(jí)的應(yīng)用程序,如移動(dòng)設(shè)備或基于applet的應(yīng)用程序,其中它的數(shù)據(jù)量和速度是顯著。
BeanFactory與ApplicationContext的區(qū)別
BeanFactory是Spring框架的基礎(chǔ)設(shè)施,面向Spring本身。ApplicationContext則面向使用Spring框架的開發(fā)者,幾乎所有的應(yīng)用場(chǎng)合都可以直接使用ApplicationContext,而非底層的BeanFactory。
另外,ApplicationContext的初始化和BeanFactory有一個(gè)重大的區(qū)別:
BeanFactory在初始化容器時(shí),并未實(shí)例化Bean,直到第一次訪問某個(gè)Bean時(shí)才實(shí)例目標(biāo)Bean。這樣,我們就不能發(fā)現(xiàn)一些存在的Spring的配置問題。如果Bean的某一個(gè)屬性沒有注入,BeanFacotry加載后,直至第一次使用調(diào)用getBean方法才會(huì)拋出異常。
而ApplicationContext則在初始化應(yīng)用上下文時(shí)就實(shí)例化所有單實(shí)例的Bean,相對(duì)應(yīng)的,ApplicationContext的初始化時(shí)間會(huì)比BeanFactory長(zhǎng)一些。
了解了上述的基本理論知識(shí)之后,我們就可以嘗試從IoC容器當(dāng)中獲取Bean對(duì)象了。
通過BeanFactory獲取
通過BeanFactory來獲取Bean?;趚ml配置文件的時(shí)代,可以通過如下方式獲得BeanFactory,再通過BeanFactory來獲得對(duì)應(yīng)的Bean。
BeanFactory beanFactory = new XmlBeanFactory(new ClassPathResource("applicationContext.xml")); UserInfo userInfo = (UserInfo) beanFactory.getBean("userInfo");
有一定編程年齡的程序員,應(yīng)該對(duì)此還有一些印象。這種寫法估計(jì)也只會(huì)出現(xiàn)在古老的項(xiàng)目當(dāng)中。鑒于xml形式配置文件已經(jīng)被基于注解形式所替代,同時(shí)XmlBeanFactory也被標(biāo)注為廢棄。此種方式不推薦使用。
其實(shí),不推薦的理由還有一個(gè),在上面已經(jīng)提到,盡量不要使用BeanFactory,而應(yīng)該使用ApplicationContext。
通過BeanFactoryAware獲取
在上面的方式中,XmlBeanFactory已經(jīng)被廢棄,但可以通過其他方式來獲得BeanFactory,然后再從BeanFactory中獲得指定的Bean。獲取BeanFactory實(shí)例最簡(jiǎn)單的方式就是實(shí)現(xiàn)BeanFactoryAware接口。
BeanFactoryAware接口源碼:
public interface BeanFactoryAware extends Aware { /** * 初始化回調(diào)方法,Spring會(huì)自動(dòng)將BeanFactory注入進(jìn)去,接收之后即可使用BeanFactory */ void setBeanFactory(BeanFactory beanFactory) throws BeansException; }
BeanFactoryAware屬于org.springframework.beans.factory.Aware根標(biāo)記接口,使用setter注入來在應(yīng)用程序上下文啟動(dòng)期間獲取對(duì)象。Aware接口是回調(diào),監(jiān)聽器和觀察者設(shè)計(jì)模式的混合,它表示Bean有資格通過回調(diào)方式被Spring容器通知。
這里提供一個(gè)完整的工具類:
@Component public class BeanFactoryHelper implements BeanFactoryAware { private static BeanFactory beanFactory; /** * 重寫 BeanFactoryAware 接口的方法 * @param beanFactory :參數(shù)賦值給本地屬性之后即可使用 BeanFactory * @throws BeansException BeansException */ @Override public void setBeanFactory(BeanFactory beanFactory) throws BeansException { BeanFactoryHelper.beanFactory = beanFactory; } /** * 根據(jù)名稱獲取容器中的對(duì)象實(shí)例 * @param beanName :注入的實(shí)例必須已經(jīng)存在容器中,否則拋異常:NoSuchBeanDefinitionException * @return Object */ public static Object getBean(String beanName) { return beanFactory.getBean(beanName); } /** * 根據(jù) class 獲取容器中的對(duì)象實(shí)例 * @param requiredType :被注入的必須已經(jīng)存在容器中,否則拋異常:NoSuchBeanDefinitionException * @param <T> Class * @return 對(duì)象 */ public static <T> T getBean(Class<T> requiredType) { return beanFactory.getBean(requiredType); } /** * 判斷 spring 容器中是否包含指定名稱的對(duì)象 * @param beanName bean名稱 * @return 是否存在 */ public static boolean containsBean(String beanName) { return beanFactory.containsBean(beanName); } //其它需求皆可參考 BeanFactory 接口和它的實(shí)現(xiàn)類 }
在上述工具類中,便是基于BeanFactoryAware的特性,獲得了BeanFactory,然后再通過BeanFactory來獲得指定的Bean。
該方案滿足了獲取Bean的基本需求,但同時(shí)具有使用BeanFactory的缺點(diǎn)。根據(jù)前文介紹的BeanFactory特性,可酌情使用。
上面提供了兩種基于BeanFactory容器獲得Bean的方式,下面則通過ApplicationContext來獲取容器中的Bean,不同的是獲取ApplicationContext的方式的區(qū)別。
啟動(dòng)獲取ApplicationContext
在項(xiàng)目啟動(dòng)時(shí)先獲取ApplicationContext對(duì)象,然后將其存儲(chǔ)在一個(gè)地方,以便后續(xù)用到時(shí)進(jìn)行使用。
這里提供兩種場(chǎng)景的獲?。?/p>
基于xml配置bean的形式,適用于比較古老的項(xiàng)目,已經(jīng)很少使用了;
基于SpringBoot啟動(dòng)時(shí)獲取ApplicationContext對(duì)象;
基于xml的形式實(shí)現(xiàn):
// 其中applicationContext.xml 為配置容器的xml,不過現(xiàn)在一般很少使用了 ApplicationContext ac = new FileSystemXmlApplicationContext("applicationContext.xml");
這里等于直接初始化容器,并且獲得容器的引用。這種方式適用于采用Spring框架的獨(dú)立應(yīng)用程序,需要程序通過配置文件手工初始化Spring的情況。目前大多數(shù)Spring項(xiàng)目已經(jīng)不再采用xml配置,很少使用了。
基于SpringBoot啟動(dòng)實(shí)現(xiàn):
@SpringBootApplication public class ExampleApplication { public static void main(String[] args) { // 啟動(dòng)時(shí),保存上下文,并保存為靜態(tài) ConfigurableApplicationContext ac = SpringApplication.run(ExampleApplication.class, args); SpringContextUtil.setAc(ac); } }
對(duì)應(yīng)的SpringContextUtil類如下:
public class SpringContextUtil1 { private static ApplicationContext ac; public static <T> T getBean(String beanName, Class<T> clazz) { T bean = ac.getBean(beanName, clazz); return bean; } public static void setAc(ApplicationContext applicationContext){ ac = applicationContext; } }
兩種方式都是在啟動(dòng)Spring項(xiàng)目時(shí),直接獲取到ApplicationContext的引用,然后將其存儲(chǔ)到工具類當(dāng)中。在使用時(shí),則從工具類中獲取ApplicationContext容器,進(jìn)而從中獲得Bean對(duì)象。
通過繼承ApplicationObjectSupport
此種方式依舊是先獲得ApplicationContext容器,然后從中獲取Bean對(duì)象,只不過是基于繼承ApplicationObjectSupport類實(shí)現(xiàn)的。
具體實(shí)現(xiàn)代碼:
@Component public class SpringContextUtil extends ApplicationObjectSupport { public <T> T getBean(Class<T> clazz) { ApplicationContext ac = getApplicationContext(); if(ac == null){ return null; } return ac.getBean(clazz); } }
注意,這里的SpringContextUtil類需要實(shí)例化。
通過繼承WebApplicationObjectSupport
WebApplicationObjectSupport是ApplicationObjectSupport的一個(gè)實(shí)現(xiàn)類,提供了Web相關(guān)的支持。實(shí)現(xiàn)原理與ApplicationObjectSupport一樣。
具體實(shí)現(xiàn)代碼如下:
@Component public class SpringContextUtil extends WebApplicationObjectSupport { public <T> T getBean(Class<T> clazz) { ApplicationContext ac = getApplicationContext(); if(ac == null){ return null; } return ac.getBean(clazz); } }
對(duì)照基于ApplicationObjectSupport的實(shí)現(xiàn),除了繼承對(duì)象不同外,沒有其他區(qū)別,都是基于getApplicationContext方法來獲取。
通過WebApplicationContextUtils
Spring提供了工具類WebApplicationContextUtils,通過該類可獲取WebApplicationContext對(duì)象。
具體實(shí)現(xiàn)代碼如下:
public class SpringContextUtil2 { public static <T> T getBean(ServletContext request, String name, Class<T> clazz){ WebApplicationContext webApplicationContext = WebApplicationContextUtils.getRequiredWebApplicationContext(request); // 或者 WebApplicationContext webApplicationContext1 = WebApplicationContextUtils.getWebApplicationContext(request); // webApplicationContext1.getBean(name, clazz) T bean = webApplicationContext.getBean(name, clazz); return bean; } }
這個(gè)方法很常見于SpringMVC構(gòu)建的Web項(xiàng)目中,適用于Web項(xiàng)目的B/S結(jié)構(gòu)。
通過ApplicationContextAware
通過實(shí)現(xiàn)ApplicationContextAware接口,在Spring容器啟動(dòng)時(shí)將ApplicationContext注入進(jìn)去,從而獲取ApplicationContext對(duì)象,這種方法也是常見的獲取Bean的一種方式,推薦使用。
具體實(shí)現(xiàn)代碼如下:
@Component public class SpringContextUtil3 implements ApplicationContextAware { private static ApplicationContext ac; @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { ac = applicationContext; } public static <T> T getBean(Class<T> clazz) { T bean = ac.getBean(clazz); return bean; } }
這種方式與前面通過BeanFactoryAware獲得BeanFactory的思路一致。
通過ContextLoader
使用ContextLoader提供的getCurrentWebApplicationContext方法,也是常用的獲取WebApplicationContext的一種方法。
具體實(shí)現(xiàn)代碼如下:
WebApplicationContext wac = ContextLoader.getCurrentWebApplicationContext(); wac.getBean(beanID);
該方法常見于SpringMVC實(shí)現(xiàn)的Web項(xiàng)目中。該方式是一種不依賴于Servlet,不需要注入的方式。但是需要注意一點(diǎn),在服務(wù)器啟動(dòng)時(shí)和Spring容器初始化時(shí),不能通過該方法獲取Spring容器。
通過BeanFactoryPostProcessor
Spring工具類,方便在非Spring管理環(huán)境中獲取Bean。
@Component public final class SpringUtils implements BeanFactoryPostProcessor{ /** Spring應(yīng)用上下文環(huán)境 */ private static ConfigurableListableBeanFactory beanFactory; @Override public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException{ SpringUtilsS.beanFactory = beanFactory; } /** * 獲取對(duì)象 * * @param name * @return Object 一個(gè)以所給名字注冊(cè)的bean的實(shí)例 * @throws BeansException * */ @SuppressWarnings("unchecked") public static <T> T getBean(String name) throws BeansException{ return (T) beanFactory.getBean(name); } /** * 獲取類型為requiredType的對(duì)象 * * @param clz * @return * @throws BeansException * */ public static <T> T getBean(Class<T> clz) throws BeansException{ T result = (T) beanFactory.getBean(clz); return result; } /** * 如果BeanFactory包含一個(gè)與所給名稱匹配的bean定義,則返回true * * @param name * @return boolean */ public static boolean containsBean(String name){ return beanFactory.containsBean(name); } /** * 判斷以給定名字注冊(cè)的bean定義是一個(gè)singleton還是一個(gè)prototype。 如果與給定名字相應(yīng)的bean定義沒有被找到,將會(huì)拋出一個(gè)異常(NoSuchBeanDefinitionException) * * @param name * @return boolean * @throws NoSuchBeanDefinitionException * */ public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException{ return beanFactory.isSingleton(name); } /** * @param name * @return Class 注冊(cè)對(duì)象的類型 * @throws NoSuchBeanDefinitionException * */ public static Class<?> getType(String name) throws NoSuchBeanDefinitionException{ return beanFactory.getType(name); } /** * 如果給定的bean名字在bean定義中有別名,則返回這些別名 * * @param name * @return * @throws NoSuchBeanDefinitionException * */ public static String[] getAliases(String name) throws NoSuchBeanDefinitionException{ return beanFactory.getAliases(name); } /** * 獲取aop代理對(duì)象 * * @param invoker * @return */ @SuppressWarnings("unchecked") public static <T> T getAopProxy(T invoker){ return (T) AopContext.currentProxy(); } }
其中ConfigurableListableBeanFactory接口,也屬于BeanFactory的子接口。
小結(jié)
在本文中介紹了9種從Spring容器中獲取Bean的方法,雖然每種方式實(shí)現(xiàn)各有不同,但從本質(zhì)上來講,無非就是通過BeanFactory或ApplicationContext獲取Bean,只不過獲取BeanFactory或ApplicationContext容器的方式不同而已。
那么,你是否意識(shí)到,學(xué)習(xí)一項(xiàng)技術(shù)或一個(gè)實(shí)現(xiàn)方式,只要把握住它的根本,無論形式如何變化,都萬變不離其宗。而這里“宗”就是IoC容器。
到此這篇關(guān)于淺析Spring獲取Bean的九種方法詳解的文章就介紹到這了,更多相關(guān)Spring獲取Bean內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
如何使用Jenkins編譯并打包SpringCloud微服務(wù)目錄
這篇文章主要介紹了如何使用Jenkins編譯并打包SpringCloud微服務(wù)目錄,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-11-11java判斷中文字符串長(zhǎng)度的簡(jiǎn)單實(shí)例
下面小編就為大家?guī)硪黄猨ava判斷中文字符串長(zhǎng)度的簡(jiǎn)單實(shí)例。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-01-01Java實(shí)現(xiàn)PDF導(dǎo)出功能的示例代碼
這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)PDF導(dǎo)出功能的相關(guān)知識(shí),文中的示例代碼講解詳細(xì),具有一定的學(xué)習(xí)價(jià)值,感興趣的小伙伴可以了解下2023-09-09Java的Comparable,Comparator和Cloneable三大接口詳解
這篇文章主要為大家詳細(xì)介紹了Java的Comparable,Comparator和Cloneable的接口,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下,希望能夠給你帶來幫助2022-03-03java 中 阻塞隊(duì)列BlockingQueue詳解及實(shí)例
這篇文章主要介紹了java 中 阻塞隊(duì)列BlockingQueue詳解及實(shí)例的相關(guān)資料,需要的朋友可以參考下2017-03-03關(guān)于junit單元測(cè)試@Test的使用方式
這篇文章主要介紹了關(guān)于junit單元測(cè)試@Test的使用方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-07-07Java實(shí)現(xiàn)的不同圖片居中剪裁生成同一尺寸縮略圖功能示例
這篇文章主要介紹了Java實(shí)現(xiàn)的不同圖片居中剪裁生成同一尺寸縮略圖功能,涉及java針對(duì)圖片的讀取、屬性修改等相關(guān)操作技巧,需要的朋友可以參考下2017-09-09