Dubbo3的Spring適配原理與初始化流程原始碼解析

2022-11-27 14:01:30

引言

Dubbo 國內影響力最大的開源框架之一，非常適合構建大規模微服務叢集的，提供開發框架、高效能通訊、豐富服務治理等能力。同時 Dubbo 無縫支援 Spring、Spring Boot 模式的開發，這篇文章幫助大家理解 Dubbo 是怎麼和 Spring 做整合的，非常適合關心原理是先的開發者。

感興趣的朋友可以直接存取官網體驗 Spring+Dubbo 開發微服務

Spring Context Initialization

首先，我們先來看一下Spring context初始化主要流程，如下圖所示：

相關程式碼：org.springframework.context.support.AbstractApplicationContext#refresh()

簡單描述一下每個步驟包含的內容：

建立BeanFactory：讀取載入XML/註解定義的BeanDefinition。
prepareBeanFactory: 註冊提前載入的各種內建post-processor以及環境變數等。
invokeBeanFactoryPostProcessors: 載入BeanDefinitionRegistryPostProcessor和 BeanFactoryPostProcessor。注意這裡的載入順序比較複雜，還涉及到多次載入，詳細請檢視程式碼。常用於載入較早初始化的元件，如屬性設定器PropertyPlaceholderConfigurer和PropertySourcesPlaceholderConfigurer。還有一個比較重要的ConfigurationClassPostProcessor實現了BeanDefinitionRegistryPostProcessor介面，用於載入@Configuration類，解析@Bean定義並註冊BeanDefinition。這個階段常用於註冊自定義BeanDefinition。
registerBeanPostProcessors: 載入並註冊各種BeanPostProcessor，常用於修改或包裝(代理)bean範例，如Seata的GlobalTransactionScanner。
registerListeners: 載入並註冊ApplicationListener，處理earlyApplicationEvents
finishBeanFactoryInitialization: 註冊EmbeddedValueResolver，凍結設定
preInstantiateSingletons: 遍歷載入單例bean，也就是載入普通的bean，包括@Controller, @Service, DAO等。

FactoryBean

Spring容器支援兩種bean：普通bean和工廠bean(FactoryBean)。我們經常寫的@Controller/@Service這種被Spring直接初始化的bean就是普通bean，而FactoryBean則是先由Spring先建立FactoryBean範例，然後由其再建立最終的bean範例。

[Spring BeanFactory] --create---> [XxxFactoryBean instance] --create--> [Final Bean Instance]
FactoryBean介面如下：

public interface FactoryBean<T> {
  /**
   * Return an instance (possibly shared or independent) of the object managed by this factory.
   */
	T getObject() throws Exception;
  /**
   * Return the type of object that this FactoryBean creates, or null if not known in advance.
   * This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
   */
  Class<?> getObjectType();
}

BeanDefinition

Spring bean分為註冊和建立範例兩大階段。將從Spring XML/註解解析到的bean資訊放到BeanDefinition，然後將其註冊到BeanFactory，後面會根據BeanDefinition來初始化bean範例。不管是普通bean還是工廠bean，都是先註冊bean definition，然後按照依賴順序進行初始化。

兩者BeanDefinition的差異是：

普遍bean的BeanDefinition的beanClassName為最終bean的class
工廠bean的BeanDefinition的beanClassName為工廠bean的class

註冊Bean主要有幾種方式：

在Spring XML中定義< bean />，由Spring解析生成並BeanDefinition
在Spring java config中宣告@Bean方法，由Spring解析生成並BeanDefinition
呼叫BeanDefinitionRegistry.registerBeanDefinition()方法手工註冊BeanDefinition
通過SingletonBeanRegistry.registerSingleton()方法註冊bean範例。

注意：註冊bean範例與前面三種註冊BeanDefinition有本質的區別。打個比方，註冊BeanDefinition是新兒子，Spring會管理bean的初始化及依賴注入及解決屬性預留位置，呼叫BeanPostProcessor進行處理等。而註冊bean範例就是別人的兒子，Spring將其視為已經完成初始化的bean，不會解決其依賴和屬性預留位置。後面會講到Dubbo 2.7/3兩個版本Reference註解註冊bean的差異。

初始化bean

建立bean大概有下面幾個步驟：

建立範例 createBeanInstance
解決依賴 resolveDependency
解決屬性預留位置 applyPropertyValues

其中多次呼叫BeanPostProcessor進行處理，如果某些BeanPostProcessor此時還沒註冊，則可能導致遺漏處理了當前的bean。後面會講到dubbo 2.7中提前載入config bean導致的一系列問題。

其中關鍵邏輯請參考程式碼：AbstractAutowireCapableBeanFactory#doCreateBean()

解決依賴

在Spring註解流行起來之後，通常是使用@Autowire註解來注入依賴的bean。此種注入方式大概的流程如下：

查詢匹配屬性型別的beanName列表
根據@Qualifier/@Primary/propertyName等選擇合適的bean 關鍵邏輯請參考程式碼：DefaultListableBeanFactory#doResolveDependency()。

其中第一步，查詢匹配型別的beanName列表時會呼叫ListableBeanFactory#getBeanNamesForType()來列舉檢查所有的beanDefinition。檢查bean type的邏輯請檢視 AbstractBeanFactory#isTypeMatch()。涉及的邏輯比較複雜，這裡只簡單講一下重要的分支：

如果是普通bean，則檢查BeanDefinition的beanClass是否匹配
如果是FactoryBean，則通過多種方式來預測bean type

FactoryBean的型別預測主要包括下面幾種：

如果有DecoratedDefinition，則覆蓋BeanDefinition，檢查合併後的beanClass是否匹配
通過FactoryBean.OBJECT_TYPE_ATTRIBUTE屬性獲取beanType (since 5.2)
範例化這個FactoryBean，呼叫getObjectType()方法來獲取beanType 上面提到的第三種情況可能會出現範例化失敗（如解決屬性預留位置失敗）而被多次建立的問題，即每次預測bean type都會嘗試範例化，而每次都失敗，直到它所依賴的元件都就緒才成功。

Dubbo ReferenceBean本身也是一個FactoryBean，在2.7中經常因為預測bean type導致被自動初始化，後面會詳細講這個問題。

解決屬性

在Spring中一般是通過 PropertyPlaceholderConfigurer/PropertySourcesPlaceholderConfigurer來解決XML/@Value中的屬性預留位置${...}。二者都實現了BeanFactoryPostProcessor介面，會在invokeBeanFactoryPostProcessors階段被載入，然後遍歷處理所有BeanDefinition中的屬性預留位置。

[解析註冊BeanDefinition] => [PropertyResourceConfigurer 解決屬性預留位置] => [載入BeanPostProcessor] => [初始化單例bean]
由此可知，如果在PropertyPlaceholderConfigurer/PropertySourcesPlaceholderConfigurer載入前去初始化某個bean，則這個bean的屬性預留位置是不會被解決的。這個就是Dubbo config bean 被過早載入導致無法解決預留位置的根因。

Dubbo Spring的一些問題及解決辦法

Dubbo spring 2.7 初始化過程

初始化入口是ReferenceBean#prepareDubboConfigBeans()，即當第一個ReferenceBean初始化完成時，嘗試載入其他dubbo config bean。

    @Override
    public void afterPropertiesSet() throws Exception {
        // Initializes Dubbo's Config Beans before @Reference bean autowiring
        prepareDubboConfigBeans();
        // lazy init by default.
        if (init == null) {
        init = false;
        }
        // eager init if necessary.
        if (shouldInit()) {
        getObject();
        }
    }
    private void prepareDubboConfigBeans() {
        beansOfTypeIncludingAncestors(applicationContext, ApplicationConfig.class);
        beansOfTypeIncludingAncestors(applicationContext, ModuleConfig.class);
        beansOfTypeIncludingAncestors(applicationContext, RegistryConfig.class);
        beansOfTypeIncludingAncestors(applicationContext, ProtocolConfig.class);
        beansOfTypeIncludingAncestors(applicationContext, MonitorConfig.class);
        beansOfTypeIncludingAncestors(applicationContext, ProviderConfig.class);
        beansOfTypeIncludingAncestors(applicationContext, ConsumerConfig.class);
        beansOfTypeIncludingAncestors(applicationContext, ConfigCenterBean.class);
        beansOfTypeIncludingAncestors(applicationContext, MetadataReportConfig.class);
        beansOfTypeIncludingAncestors(applicationContext, MetricsConfig.class);
        beansOfTypeIncludingAncestors(applicationContext, SslConfig.class);
    }

存在的問題：

沒有一個固定的初始化時機，而是與ReferenceBean初始化相關。如果ReferenceBean被過早初始化，經常出現dubbo設定丟失、屬性預留位置未解決等錯誤。
可能在BeanPostProcessor載入完成前初始化ReferenceBean，將導致類似Seata這種通過BeanPostProcessor機制的元件攔截失敗。

Dubbo spring 3的初始化過程

Dubbo 3 中進行大量重構，上面的痛點問題已經被解決，初始化主要流程如下：

[Spring解析XML/@Configuration class註冊BeanDefinition] => [載入BeanFactoryPostProcessor(包含PropertyResourceConfigurer)]
=> [1.解析@DubboReference/@DubboService註解並註冊BeanDefinition]
=> [載入並註冊BeanPostProcessor]
=> [載入ApplicationListener] => [2.載入DubboConfigBeanInitializer初始化config bean]
=> [初始化單例bean] => [依賴注入ReferenceBean]
=> [3.監聽ContextRefreshedEvent事件，啟動dubbo框架]

主要包含3個階段：

在BeanFactoryPostProcessor階段解析@DubboReference/@DubboService註解並註冊BeanDefinition。因為此時還是BeanDefinition處理階段，故註冊的ReferenceBean可以被後續載入的業務bean使用@Autowire依賴注入。同時，也擴充套件支援在@Configuration bean 方法使用@DubboReference/@DubboService註解。
在載入完所有PropertyResourceConfigurer和BeanPostProcessor之後才會執行DubboConfigBeanInitializer初始化config bean，解決了屬性預留位置未解決和BeanPostProcessor攔截失敗的問題。
監聽在Spring context事件，在其載入完畢時啟動dubbo框架。

支援在@Configuration bean 方法使用@DubboReference/@DubboService註解

參考Dubbo spring 3的初始化過程的第1階段。

屬性預留位置解決失敗

參考Dubbo spring 3的初始化過程的第2階段。

ReferenceBean被過早初始化問題

預測ReferenceBean beanType導致 Dubbo ReferenceBean本身也是一個FactoryBean，在2.7中經常因為預測bean type導致被自動初始化。例如使用者自定義的某個BeanFactoryPostProcessor bean使用了@Autowire註解依賴注入某個業務bean，而且這個自定義的BeanFactoryPostProcessor bean優先順序比解決屬性預留位置的PropertyResourceConfigurer高，則此時出現解決屬性預留位置失敗。

Dubbo 3中ReferenceBean通過下面兩種方式解決預測type的問題:

FactoryBean的型別預測主要包括下面幾種：

如果有DecoratedDefinition，則覆蓋BeanDefinition，檢查合併後的beanClass是否匹配

通過FactoryBean.OBJECT_TYPE_ATTRIBUTE屬性獲取beanType (since 5.2)

ReferenceBean被直接依賴導致過早初始</strong> 如果在Dubbo config bean初始化前被依賴自動建立ReferenceBean範例，並建立一個Lazy proxy類注入到依賴的類中，不需要解決屬性預留位置，不會拉起Dubbo框架。其他的config bean則固定在PropertyResourceConfigurer和BeanPostProcessor載入完成後才會執行初始化，避免了上述問題。

Reference註解可能出現@Autowire注入失敗的問題

在Dubbo 2.7中，在BeanPostProcessor中解析@DubboReference/@Reference註解，建立並注入ReferenceBean範例到Spring容器。這種方式有幾個問題：

@DubboReference/@Reference註解與XML定義的< dubbo:reference />初始化方式不一致，前者是由dubbo初始化，後者是由Spring容器負責初始化。

執行時機導致的依賴注入失敗問題。按照正常的在invokeBeanFactoryPostProcessors階段註冊完畢所有BeanDefinition，而dubbo 2.7的ReferenceAnnotationBeanPostProcessor 是在BeanPostProcessor執行時才建立ReferenceBean，可能出現某些比它早初始化的bean使用@Autowire注入失敗的情況。

在Dubbo 3中，改成在BeanFactoryPostProcessor解析@DubboReference/@Reference註解並註冊ReferenceBean的BeanDefinition，記錄欄位將要注入的referenceBeanName。在BeanPostProcessor執行時通過BeanFactory().getBean(referenceBeanName)獲取到ReferenceBean範例。

以上就是Dubbo3的Spring適配原理與初始化流程原始碼解析的詳細內容，更多關於Dubbo3 Spring適配初始化流程的資料請關注it145.com其它相關文章！