前言
隨著SpringBoot的普及，Spring的使用也越來越廣，在某些場景下，我們無法通過注解或配置的形式直接獲取到某個Bean。比如，在某一些工具類、設(shè)計模式實現(xiàn)中需要使用到Spring容器管理的Bean，此時就需要直接獲取到對應(yīng)的Bean。
本文為大家整理匯總了常見的獲取Bean的方式，并提供一些優(yōu)劣分析，方便大家在使用到時有更好的選擇。同時，也會為大家適當(dāng)?shù)钠占昂屯卣挂恍┫嚓P(guān)知識。
Spring的IoC容器
在Spring中，Bean的實例化、定位、配置應(yīng)用程序中的對象及建立對象間的依賴關(guān)系，都是在IoC容器中進(jìn)行的。因此，要在Spring中獲取Bean，本質(zhì)上就是從IoC容器當(dāng)中獲取Bean。
在Spring中，BeanFactory是IoC容器的實際代表者，該接口提供了IoC容器最基本功能。同時，Spring還提供了另外一種類型的容器：ApplicationContext容器。
ApplicationContext容器包括BeanFactory容器的所有功能（BeanFactory的子接口），提供了更多面向應(yīng)用的功能，它提供了國際化支持和框架事件體系，更易于創(chuàng)建實際應(yīng)用。
一般情況，我們稱BeanFactory為IoC容器，稱ApplicationContext為應(yīng)用上下文。但有時為了方便，也將ApplicationContext稱為Spring容器。
通常不建議使用BeanFactory，但BeanFactory 仍然可以用于輕量級的應(yīng)用程序，如移動設(shè)備或基于applet的應(yīng)用程序，其中它的數(shù)據(jù)量和速度是顯著。
BeanFactory與ApplicationContext的區(qū)別
BeanFactory是Spring框架的基礎(chǔ)設(shè)施，面向Spring本身。ApplicationContext則面向使用Spring框架的開發(fā)者，幾乎所有的應(yīng)用場合都可以直接使用ApplicationContext，而非底層的BeanFactory。
另外，ApplicationContext的初始化和BeanFactory有一個重大的區(qū)別：
BeanFactory在初始化容器時，并未實例化Bean，直到第一次訪問某個Bean時才實例目標(biāo)Bean。這樣，我們就不能發(fā)現(xiàn)一些存在的Spring的配置問題。如果Bean的某一個屬性沒有注入，BeanFacotry加載后，直至第一次使用調(diào)用getBean方法才會拋出異常。
而ApplicationContext則在初始化應(yīng)用上下文時就實例化所有單實例的Bean，相對應(yīng)的，ApplicationContext的初始化時間會比BeanFactory長一些。
了解了上述的基本理論知識之后，我們就可以嘗試從IoC容器當(dāng)中獲取Bean對象了。
方式一：通過BeanFactory獲取
通過BeanFactory來獲取Bean。基于xml配置文件的時代，可以通過如下方式獲得BeanFactory，再通過BeanFactory來獲得對應(yīng)的Bean。
BeanFactory beanFactory = new XmlBeanFactory(new ClassPathResource("applicationContext.xml"));
UserInfo userInfo = (UserInfo) beanFactory.getBean("userInfo");有一定編程年齡的程序員，應(yīng)該對此還有一些印象。這種寫法估計也只會出現(xiàn)在古老的項目當(dāng)中。鑒于xml形式配置文件已經(jīng)被基于注解形式所替代，同時XmlBeanFactory也被標(biāo)注為廢棄。此種方式不推薦使用。
其實，不推薦的理由還有一個，在上面已經(jīng)提到，盡量不要使用BeanFactory，而應(yīng)該使用ApplicationContext。
方式二：通過BeanFactoryAware獲取
在上面的方式中，XmlBeanFactory已經(jīng)被廢棄，但可以通過其他方式來獲得BeanFactory，然后再從BeanFactory中獲得指定的Bean。獲取BeanFactory實例最簡單的方式就是實現(xiàn)BeanFactoryAware接口。
BeanFactoryAware接口源碼：
public interface BeanFactoryAware extends Aware {
/**
* 初始化回調(diào)方法，Spring會自動將BeanFactory注入進(jìn)去，接收之后即可使用BeanFactory
*/
void setBeanFactory(BeanFactory beanFactory) throws BeansException;
}BeanFactoryAware屬于org.springframework.beans.factory.Aware根標(biāo)記接口，使用setter注入來在應(yīng)用程序上下文啟動期間獲取對象。Aware接口是回調(diào)，監(jiān)聽器和觀察者設(shè)計模式的混合，它表示Bean有資格通過回調(diào)方式被Spring容器通知。
這里提供一個完整的工具類：
@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ù)名稱獲取容器中的對象實例
* @param beanName ：注入的實例必須已經(jīng)存在容器中，否則拋異常：NoSuchBeanDefinitionException
* @return Object
*/
public static Object getBean(String beanName) {
return beanFactory.getBean(beanName);
}
/**
* 根據(jù) class 獲取容器中的對象實例
* @param requiredType ：被注入的必須已經(jīng)存在容器中，否則拋異常：NoSuchBeanDefinitionException
* @param <T> Class
* @return 對象
*/
public static <T> T getBean(Class<T> requiredType) {
return beanFactory.getBean(requiredType);
}
/**
* 判斷 spring 容器中是否包含指定名稱的對象
* @param beanName bean名稱
* @return 是否存在
*/
public static boolean containsBean(String beanName) {
return beanFactory.containsBean(beanName);
}
//其它需求皆可參考 BeanFactory 接口和它的實現(xiàn)類
}
在上述工具類中，便是基于BeanFactoryAware的特性，獲得了BeanFactory，然后再通過BeanFactory來獲得指定的Bean。
該方案滿足了獲取Bean的基本需求，但同時具有使用BeanFactory的缺點。根據(jù)前文介紹的BeanFactory特性，可酌情使用。
上面提供了兩種基于BeanFactory容器獲得Bean的方式，下面則通過ApplicationContext來獲取容器中的Bean，不同的是獲取ApplicationContext的方式的區(qū)別。
方式三：啟動獲取ApplicationContext
在項目啟動時先獲取ApplicationContext對象，然后將其存儲在一個地方，以便后續(xù)用到時進(jìn)行使用。
這里提供兩種場景的獲取：
- 基于xml配置bean的形式，適用于比較古老的項目，已經(jīng)很少使用了；
- 基于SpringBoot啟動時獲取ApplicationContext對象；
基于xml的形式實現(xiàn)：
// 其中applicationContext.xml 為配置容器的xml，不過現(xiàn)在一般很少使用了
ApplicationContext ac = new FileSystemXmlApplicationContext("applicationContext.xml");
這里等于直接初始化容器，并且獲得容器的引用。這種方式適用于采用Spring框架的獨立應(yīng)用程序，需要程序通過配置文件手工初始化Spring的情況。目前大多數(shù)Spring項目已經(jīng)不再采用xml配置，很少使用了。
基于SpringBoot啟動實現(xiàn)：
@SpringBootApplication
public class ExampleApplication {
public static void main(String[] args) {
// 啟動時，保存上下文，并保存為靜態(tài)
ConfigurableApplicationContext ac = SpringApplication.run(ExampleApplication.class, args);
SpringContextUtil.setAc(ac);
}
}
對應(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;
}
}兩種方式都是在啟動Spring項目時，直接獲取到ApplicationContext的引用，然后將其存儲到工具類當(dāng)中。在使用時，則從工具類中獲取ApplicationContext容器，進(jìn)而從中獲得Bean對象。
方式四：通過繼承ApplicationObjectSupport
此種方式依舊是先獲得ApplicationContext容器，然后從中獲取Bean對象，只不過是基于繼承ApplicationObjectSupport類實現(xiàn)的。
具體實現(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類需要實例化。
方式五：通過繼承WebApplicationObjectSupport
WebApplicationObjectSupport是ApplicationObjectSupport的一個實現(xiàn)類，提供了Web相關(guān)的支持。實現(xiàn)原理與ApplicationObjectSupport一樣。
具體實現(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);
}
}
對照基于ApplicationObjectSupport的實現(xiàn)，除了繼承對象不同外，沒有其他區(qū)別，都是基于getApplicationContext方法來獲取。
方式六：通過WebApplicationContextUtils
Spring提供了工具類WebApplicationContextUtils，通過該類可獲取WebApplicationContext對象。
具體實現(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;
}
}這個方法很常見于SpringMVC構(gòu)建的Web項目中，適用于Web項目的B/S結(jié)構(gòu)。
方式七：通過ApplicationContextAware
通過實現(xiàn)ApplicationContextAware接口，在Spring容器啟動時將ApplicationContext注入進(jìn)去，從而獲取ApplicationContext對象，這種方法也是常見的獲取Bean的一種方式，推薦使用。
具體實現(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的一種方法。
具體實現(xiàn)代碼如下：
WebApplicationContext wac = ContextLoader.getCurrentWebApplicationContext();
wac.getBean(beanID);
該方法常見于SpringMVC實現(xiàn)的Web項目中。該方式是一種不依賴于Servlet，不需要注入的方式。但是需要注意一點，在服務(wù)器啟動時和Spring容器初始化時，不能通過該方法獲取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;
}
/**
* 獲取對象
*
* @param name
* @return Object 一個以所給名字注冊的bean的實例
* @throws BeansException
*
*/
@SuppressWarnings("unchecked")
public static <T> T getBean(String name) throws BeansException{
return (T) beanFactory.getBean(name);
}
/**
* 獲取類型為requiredType的對象
*
* @param clz
* @return
* @throws BeansException
*
*/
public static <T> T getBean(Class<T> clz) throws BeansException{
T result = (T) beanFactory.getBean(clz);
return result;
}
/**
* 如果BeanFactory包含一個與所給名稱匹配的bean定義，則返回true
*
* @param name
* @return boolean
*/
public static boolean containsBean(String name){
return beanFactory.containsBean(name);
}
/**
* 判斷以給定名字注冊的bean定義是一個singleton還是一個prototype。 如果與給定名字相應(yīng)的bean定義沒有被找到，將會拋出一個異常（NoSuchBeanDefinitionException）
*
* @param name
* @return boolean
* @throws NoSuchBeanDefinitionException
*
*/
public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException{
return beanFactory.isSingleton(name);
}
/**
* @param name
* @return Class 注冊對象的類型
* @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代理對象
*
* @param invoker
* @return
*/
@SuppressWarnings("unchecked")
public static <T> T getAopProxy(T invoker){
return (T) AopContext.currentProxy();
}
}
其中ConfigurableListableBeanFactory接口，也屬于BeanFactory的子接口。
小結(jié)
在本文中介紹了9種從Spring容器中獲取Bean的方法，雖然每種方式實現(xiàn)各有不同，但從本質(zhì)上來講，無非就是通過BeanFactory或ApplicationContext獲取Bean，只不過獲取BeanFactory或ApplicationContext容器的方式不同而已。
那么，你是否意識到，學(xué)習(xí)一項技術(shù)或一個實現(xiàn)方式，只要把握住它的根本，無論形式如何變化，都萬變不離其宗。而這里“宗”就是IoC容器。
