前言

随着SpringBoot的普及，Spring的使用也越來越廣，在某些場景下，我們無法通過注解或配置的形式直接擷取到某個Bean。比如，在某一些工具類、設計模式實作中需要使用到Spring容器管理的Bean，此時就需要直接擷取到對應的Bean。

本文為大家整理彙總了常見的擷取Bean的方式，并提供一些優劣分析，友善大家在使用到時有更好的選擇。同時，也會為大家适當的普及和拓展一些相關知識。

Spring的IoC容器

在Spring中，Bean的執行個體化、定位、配置應用程式中的對象及建立對象間的依賴關系，都是在IoC容器中進行的。是以，要在Spring中擷取Bean，本質上就是從IoC容器當中擷取Bean。

在Spring中，BeanFactory是IoC容器的實際代表者，該接口提供了IoC容器最基本功能。同時，Spring還提供了另外一種類型的容器：ApplicationContext容器。

ApplicationContext容器包括BeanFactory容器的所有功能（BeanFactory的子接口），提供了更多面向應用的功能，它提供了國際化支援和架構事件體系，更易于建立實際應用。

一般情況，我們稱BeanFactory為IoC容器，稱ApplicationContext為應用上下文。但有時為了友善，也将ApplicationContext稱為Spring容器。

通常不建議使用BeanFactory，但BeanFactory 仍然可以用于輕量級的應用程式，如移動裝置或基于applet的應用程式，其中它的資料量和速度是顯著。

BeanFactory與ApplicationContext的差別

BeanFactory是Spring架構的基礎設施，面向Spring本身。ApplicationContext則面向使用Spring架構的開發者，幾乎所有的應用場景都可以直接使用ApplicationContext，而非底層的BeanFactory。

另外，ApplicationContext的初始化和BeanFactory有一個重大的差別：

BeanFactory在初始化容器時，并未執行個體化Bean，直到第一次通路某個Bean時才執行個體目标Bean。這樣，我們就不能發現一些存在的Spring的配置問題。如果Bean的某一個屬性沒有注入，BeanFacotry加載後，直至第一次使用調用getBean方法才會抛出異常。

而ApplicationContext則在初始化應用上下文時就執行個體化所有單執行個體的Bean，相對應的，ApplicationContext的初始化時間會比BeanFactory長一些。

了解了上述的基本理論知識之後，我們就可以嘗試從IoC容器當中擷取Bean對象了。

方式一：通過BeanFactory擷取

通過BeanFactory來擷取Bean。基于xml配置檔案的時代，可以通過如下方式獲得BeanFactory，再通過BeanFactory來獲得對應的Bean。

BeanFactory beanFactory = new XmlBeanFactory(new ClassPathResource("applicationContext.xml"));
UserInfo userInfo = (UserInfo) beanFactory.getBean("userInfo");

有一定程式設計年齡的程式員，應該對此還有一些印象。這種寫法估計也隻會出現在古老的項目當中。鑒于xml形式配置檔案已經被基于注解形式所替代，同時XmlBeanFactory也被标注為廢棄。此種方式不推薦使用。

其實，不推薦的理由還有一個，在上面已經提到，盡量不要使用BeanFactory，而應該使用ApplicationContext。

方式二：通過BeanFactoryAware擷取

在上面的方式中，XmlBeanFactory已經被廢棄，但可以通過其他方式來獲得BeanFactory，然後再從BeanFactory中獲得指定的Bean。擷取BeanFactory執行個體最簡單的方式就是實作BeanFactoryAware接口。

BeanFactoryAware接口源碼：

public interface BeanFactoryAware extends Aware {

 /**
  * 初始化回調方法，Spring會自動将BeanFactory注入進去，接收之後即可使用BeanFactory
  */
 void setBeanFactory(BeanFactory beanFactory) throws BeansException;
}

BeanFactoryAware屬于org.springframework.beans.factory.Aware根标記接口，使用setter注入來在應用程式上下文啟動期間擷取對象。Aware接口是回調，監聽器和觀察者設計模式的混合，它表示Bean有資格通過回調方式被Spring容器通知。

這裡提供一個完整的工具類：

@Component
public class BeanFactoryHelper implements BeanFactoryAware {

 private static BeanFactory beanFactory;

 /**
  * 重寫 BeanFactoryAware 接口的方法
  * @param beanFactory ：參數指派給本地屬性之後即可使用 BeanFactory
  * @throws BeansException BeansException
  */
 @Override
 public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
  BeanFactoryHelper.beanFactory = beanFactory;
 }
 /**
  * 根據名稱擷取容器中的對象執行個體
  * @param beanName ：注入的執行個體必須已經存在容器中，否則抛異常：NoSuchBeanDefinitionException
  * @return Object
  */
 public static Object getBean(String beanName) {
  return beanFactory.getBean(beanName);
 }
 /**
  * 根據 class 擷取容器中的對象執行個體
  * @param requiredType ：被注入的必須已經存在容器中，否則抛異常：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 接口和它的實作類
}

在上述工具類中，便是基于BeanFactoryAware的特性，獲得了BeanFactory，然後再通過BeanFactory來獲得指定的Bean。

該方案滿足了擷取Bean的基本需求，但同時具有使用BeanFactory的缺點。根據前文介紹的BeanFactory特性，可酌情使用。

上面提供了兩種基于BeanFactory容器獲得Bean的方式，下面則通過ApplicationContext來擷取容器中的Bean，不同的是擷取ApplicationContext的方式的差別。

方式三：啟動擷取ApplicationContext

在項目啟動時先擷取ApplicationContext對象，然後将其存儲在一個地方，以便後續用到時進行使用。

這裡提供兩種場景的擷取：

基于xml配置bean的形式，适用于比較古老的項目，已經很少使用了；
基于SpringBoot啟動時擷取ApplicationContext對象；

基于xml的形式實作：

// 其中applicationContext.xml 為配置容器的xml，不過現在一般很少使用了
ApplicationContext ac = new FileSystemXmlApplicationContext("applicationContext.xml");

這裡等于直接初始化容器，并且獲得容器的引用。這種方式适用于采用Spring架構的獨立應用程式，需要程式通過配置檔案手工初始化Spring的情況。目前大多數Spring項目已經不再采用xml配置，很少使用了。

基于SpringBoot啟動實作：

@SpringBootApplication
public class ExampleApplication {

    public static void main(String[] args) {
        // 啟動時，儲存上下文，并儲存為靜态
        ConfigurableApplicationContext ac = SpringApplication.run(ExampleApplication.class, args);
        SpringContextUtil.setAc(ac);
    }
}

對應的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的引用，然後将其存儲到工具類當中。在使用時，則從工具類中擷取ApplicationContext容器，進而從中獲得Bean對象。

方式四：通過繼承ApplicationObjectSupport

此種方式依舊是先獲得ApplicationContext容器，然後從中擷取Bean對象，隻不過是基于繼承ApplicationObjectSupport類實作的。

具體實作代碼：

@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的一個實作類，提供了Web相關的支援。實作原理與ApplicationObjectSupport一樣。

具體實作代碼如下：

@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的實作，除了繼承對象不同外，沒有其他差別，都是基于getApplicationContext方法來擷取。

方式六：通過WebApplicationContextUtils

Spring提供了工具類WebApplicationContextUtils，通過該類可擷取WebApplicationContext對象。

具體實作代碼如下：

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建構的Web項目中，适用于Web項目的B/S結構。

方式七：通過ApplicationContextAware

通過實作ApplicationContextAware接口，在Spring容器啟動時将ApplicationContext注入進去，進而擷取ApplicationContext對象，這種方法也是常見的擷取Bean的一種方式，推薦使用。

具體實作代碼如下：

@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的一種方法。

具體實作代碼如下：

WebApplicationContext wac = ContextLoader.getCurrentWebApplicationContext();
wac.getBean(beanID);

該方法常見于SpringMVC實作的Web項目中。該方式是一種不依賴于Servlet，不需要注入的方式。但是需要注意一點，在伺服器啟動時和Spring容器初始化時，不能通過該方法擷取Spring容器。

方式九：通過BeanFactoryPostProcessor

Spring工具類，友善在非Spring管理環境中擷取Bean。

@Component
public final class SpringUtils implements BeanFactoryPostProcessor{
    
    /** Spring應用上下文環境 */
    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。 如果與給定名字相應的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的子接口。

小結

在本文中介紹了9種從Spring容器中擷取Bean的方法，雖然每種方式實作各有不同，但從本質上來講，無非就是通過BeanFactory或ApplicationContext擷取Bean，隻不過擷取BeanFactory或ApplicationContext容器的方式不同而已。

那麼，你是否意識到，學習一項技術或一個實作方式，隻要把握住它的根本，無論形式如何變化，都萬變不離其宗。而這裡“宗”就是IoC容器。

原文：https://mp.weixin.qq.com/s/KNvcWj4C-ju5Y6EkKe2jhg

如果感覺本文對你有幫助，點贊關注支援一下

Spring容器擷取Bean的9種方式，你能get幾種？

前言

Spring的IoC容器

BeanFactory與ApplicationContext的差別

方式一：通過BeanFactory擷取

方式二：通過BeanFactoryAware擷取

方式三：啟動擷取ApplicationContext

方式四：通過繼承ApplicationObjectSupport

方式五：通過繼承WebApplicationObjectSupport

方式六：通過WebApplicationContextUtils

方式七：通過ApplicationContextAware

方式八：通過ContextLoader

方式九：通過BeanFactoryPostProcessor

小結

繼續閱讀

MyBatis-Plus 之AR模式

馴服爛代碼_馴服Tomcat：Tomcat 5的過濾技巧

基于Springboot+VUE+Mysql的大學生校園疫情防控管理系統

Using MessageConverter

馴服爛代碼_C＃中的馴服配置

Spring Cloud整合Sleuth，當請求完成後，Zipkin沒有鍊路資訊

JAVA自學之路——馬士兵

Rabbitmq指令行手動建立隊列

整合 Spring 開發架構及服務端技術

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

Spring資料和Redis

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法