首頁 > 軟體

Spring核心方法refresh的使用解析

2022-08-17 18:03:01

refresh 方法簡述

refresh()是 Spring 最核心的方法,沒有之一,上帝就是用這個方法創造了 Spring 的世界。

這是一個同步方法,用synchronized關鍵字來實現的。該方法包含以下12個核心方法(步驟)。

prepareRefresh()
obtainFreshBeanFactory()
prepareBeanFactory(beanFactory)
postProcessBeanFactory(beanFactory)
invokeBeanFactoryPostProcessors(beanFactory)
registerBeanPostProcessors(beanFactory)
initMessageSource()
initApplicationEventMulticaster()
onRefresh()
registerListeners()
finishBeanFactoryInitialization(beanFactory)
finishRefresh()

refresh 12個步驟說明

一、prepareRefresh()

該方法用於容器重新整理前的準備,包括設定上下文狀態,獲取屬性,驗證必要的屬性等。

// 設定啟動時間
this.startupDate = System.currentTimeMillis();
// 1交給子類實現,初始化屬性源
initPropertySources();
// 驗證所有標記為必須的屬性
getEnvironment().validateRequiredProperties();

開發者可以實現initPropertySources()方法,新增屬性或設定需要驗證的屬性,如:

System.out.println("開始校驗自定義設定");
getEnvironment().setRequiredProperties("my-name");

在執行驗證屬性時,將會校驗是否有my-name設定。

二、obtainFreshBeanFactory()

該方法獲取新的beanFactory。該方法很簡單,重新整理 BeanFactory 和獲取 getBeanFactory。

// 重新整理 BeanFactory
refreshBeanFactory();
// 獲取 getBeanFactory
return getBeanFactory();

這兩個方法都是需要子類去實現的,如果是基於 xml 設定的方法啟動,在重新整理階段將會做如下事情。

//建立 beanFactory
DefaultListableBeanFactory beanFactory = createBeanFactory();
// 指定序列化 id
beanFactory.setSerializationId(getId());
// 客製化 beanFactory,設定相關屬性,包括是否允許覆蓋同名稱的不同定義的物件以及迴圈依賴及設定 @Autowired 和 @Qualifier 註解解析器
customizeBeanFactory(beanFactory);
// 初始化 DocumentReader,並進行 XML 檔案的讀取及解析,生成 BeanDefinition
loadBeanDefinitions(beanFactory);

三、prepareBeanFactory(beanFactory)

該方法用於設定標準的 beanFactory ,設定 ClassLoader ,設定 SpEL 表示式解析器,新增忽略注入的介面,新增 bean ,新增 bean 後置處理器等。

// 設定 beanFactory 的類載入器
beanFactory.setBeanClassLoader(getClassLoader());
// 設定支援表示式解析器
beanFactory.setBeanExpressionResolver(new StandardBeanExpressionResolver(beanFactory.getBeanClassLoader()));
// 為 beanFactory 增加了一個預設的 propertyEditor ,這個主要是對 bean 的屬性等設定管理的一個工具
beanFactory.addPropertyEditorRegistrar(new ResourceEditorRegistrar(this, getEnvironment()));
// 新增部分BeanPostProcessor【ApplicationContextAwareProcessor】
beanFactory.addBeanPostProcessor(new ApplicationContextAwareProcessor(this));
//設定忽略的自動裝配的介面EnvironmentAware、EmbeddedValueResolverAware、xxx;
//這些介面的實現類不能通過型別來自動注入
beanFactory.ignoreDependencyInterface(EnvironmentAware.class);
beanFactory.ignoreDependencyInterface(EmbeddedValueResolverAware.class);
beanFactory.ignoreDependencyInterface(ResourceLoaderAware.class);
beanFactory.ignoreDependencyInterface(ApplicationEventPublisherAware.class);
beanFactory.ignoreDependencyInterface(MessageSourceAware.class);
beanFactory.ignoreDependencyInterface(ApplicationContextAware.class);
// 註冊可以解析的自動裝配;我們能直接在任何元件中自動注入
beanFactory.registerResolvableDependency(BeanFactory.class, beanFactory);
beanFactory.registerResolvableDependency(ResourceLoader.class, this);
beanFactory.registerResolvableDependency(ApplicationEventPublisher.class, this);
beanFactory.registerResolvableDependency(ApplicationContext.class, this);
// 增加對 AspectJ 的支援
if (beanFactory.containsBean(LOAD_TIME_WEAVER_BEAN_NAME)) {
    beanFactory.addBeanPostProcessor(new LoadTimeWeaverAwareProcessor(beanFactory));
    // Set a temporary ClassLoader for type matching.
    beanFactory.setTempClassLoader(new ContextTypeMatchClassLoader(beanFactory.getBeanClassLoader()));
}
// 環境資訊ConfigurableEnvironment
if (!beanFactory.containsLocalBean(ENVIRONMENT_BEAN_NAME)) {
    beanFactory.registerSingleton(ENVIRONMENT_BEAN_NAME, getEnvironment());
}
// 系統屬性,systemProperties【Map<String, Object>】
if (!beanFactory.containsLocalBean(SYSTEM_PROPERTIES_BEAN_NAME)) {
    beanFactory.registerSingleton(SYSTEM_PROPERTIES_BEAN_NAME, getEnvironment().getSystemProperties());
}
// 系統環境變數systemEnvironment【Map<String, Object>】
if (!beanFactory.containsLocalBean(SYSTEM_ENVIRONMENT_BEAN_NAME)) {
    beanFactory.registerSingleton(SYSTEM_ENVIRONMENT_BEAN_NAME, getEnvironment().getSystemEnvironment());
}

四、postProcessBeanFactory(beanFactory)

模板方法,此時,所有的 beanDefinition 已經載入,但是還沒有範例化允許在子類中對 beanFactory 進行擴充套件處理。

比如新增 ware 相關介面自動裝配設定,新增後置處理器等,是子類擴充套件 prepareBeanFactory(beanFactory) 的方法。

五、invokeBeanFactoryPostProcessors(beanFactory)

範例化並呼叫所有註冊的beanFactory後置處理器(實現介面BeanFactoryPostProcessor的bean,在beanFactory標準初始化之後執行)。

// 執行BeanFactoryPostProcessor的方法
PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(beanFactory, getBeanFactoryPostProcessors());

在invokeBeanFactoryPostProcessors方法中,Spring 會先去找到所有的實現了BeanDefinitionRegistryPostProcessor的 BeanFactory 後置處理器,然後先執行實現PriorityOrdered的,再執行實現了Ordered的。

其中最著名的就是ConfigurationClassPostProcessor,用來掃描被 @Component 和 @Bean 標記的物件,並註冊其 BeanDefinition 後設資料到 Spring 容器的 BeanDefinitionMap 中。然後再去獲取所有的 BeanFactory 後置處理器,去掉已經執行過的,也是根據排序依次執行。

該方法結束後,Spring 上下文中已經註冊並執行了 BeanFactory 後置處理器,也將一部分 BeanDefinition 註冊了進來。

六、registerBeanPostProcessors(beanFactory)

顧名思義,該方法是註冊 Bean 的後置處理器。

// 把這件事委託給 PostProcessorRegistrationDelegate 來處理
PostProcessorRegistrationDelegate.registerBeanPostProcessors(beanFactory, this);
// 1. 獲取所有的 Bean 後置處理器的名字
String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanPostProcessor.class, true, false);
// 2. 對 Bean 後置處理器分類
List<BeanPostProcessor> priorityOrderedPostProcessors = new ArrayList<>();
List<BeanPostProcessor> internalPostProcessors = new ArrayList<>();
List<String> orderedPostProcessorNames = new ArrayList<>();
List<String> nonOrderedPostProcessorNames = new ArrayList<>();
// 3. 註冊 Bean 後置處理器
registerBeanPostProcessors(beanFactory, priorityOrderedPostProcessors);
registerBeanPostProcessors(beanFactory, orderedPostProcessors);
registerBeanPostProcessors(beanFactory, nonOrderedPostProcessors);
registerBeanPostProcessors(beanFactory, internalPostProcessors);
// 4. 註冊 ApplicationListener 探測器
beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(applicationContext));

獲取所有的 Bean 後置處理器的名字。

對 Bean 後置處理器分類。執行完分類之後,所有的priorityOrderedPostProcessors都將成為一個 Bean 進入 Spring 容器中。

  • priorityOrderedPostProcessors是所有實現了PriorityOrdered介面的後置處理器。
  • internalPostProcessors是所有內建的後置處理器。
  • orderedPostProcessorNames實現了ordered介面的後置處理器。
  • nonOrderedPostProcessorNames沒有排序的後置處理器。

七、initMessageSource()

為上下文初始化 Message 源,即對不同語言的訊息體進行國際化處理。

八、initApplicationEventMulticaster()

初始化事件廣播器,並放入 applicationEventMulticaster bean 中

九、onRefresh()

模板方法,在容器重新整理的時候可以自定義邏輯,不同的Spring容器做不同的事情。

十、registerListeners()

註冊監聽器。

// 1. 新增指定的監聽器
for (ApplicationListener<?> listener : getApplicationListeners()) {
    getApplicationEventMulticaster().addApplicationListener(listener);
}
// 2. 獲取所有實現 ApplicationListener 的廣播器,並新增
String[] listenerBeanNames = getBeanNamesForType(ApplicationListener.class, true, false);
for (String listenerBeanName : listenerBeanNames) {
    getApplicationEventMulticaster().addApplicationListenerBean(listenerBeanName);
}

十一、finishBeanFactoryInitialization(beanFactory)

範例化所有剩餘的非懶載入單例,比如invokeBeanFactoryPostProcessors方法中根據各種註解解析出來的類,在這個時候都會被初始化。範例化的過程各種BeanPostProcessor開始起作用。

// 1. 凍結所有的 bean,已經註冊的 bean 定義將不會被修改或任何進一步的處理
beanFactory.freezeConfiguration();
// 2. 範例化所有剩餘的非懶載入的 bean
beanFactory.preInstantiateSingletons();
// 3.獲取容器中所有 beanDefinition 的名稱
List<String> beanNames = new ArrayList<>(this.beanDefinitionNames);
for (String beanName : beanNames) {
    // 根據 beanName 獲取 BeanDefinition
    RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
    // 不是抽象的 && 是單例的 && 不是懶載入的
    if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
        if (isFactoryBean(beanName)) {
            // 如果是 FactoryBean,就先獲取 FactoryBean 範例
            Object bean = getBean(FACTORY_BEAN_PREFIX + beanName);
            if (bean instanceof FactoryBean) {
                …………
            }
        }
        else {
            // 如果不是 FactoryBean,就直接獲取 Bean
            getBean(beanName);
        }
    }
}

十二、finishRefresh()

refresh做完之後需要做的其他事情。

// 清除上下文資源快取(如掃描中的ASM後設資料) scanning).
clearResourceCaches();
// 初始化上下文的生命週期處理器,並重新整理(找出Spring容器中實現了Lifecycle介面的bean並執行start()方法)
initLifecycleProcessor();
getLifecycleProcessor().onRefresh();
// 釋出ContextRefreshedEvent事件告知對應的ApplicationListener進行響應的操作
publishEvent(new ContextRefreshedEvent(this));

以上為個人經驗,希望能給大家一個參考,也希望大家多多支援it145.com。 


IT145.com E-mail:sddin#qq.com