SpringBoot2入門自動設定原理及原始碼分析

2022-05-27 18:02:51

SpringBoot自動設定

之前為什麼會去了解一些底層註解，其實就是為了後續更好的瞭解 springboot 底層的一些原理，比如自動設定原理。

一、@SpringBootApplication

從 MainApplication 中的@SpringBootApplication開始。

進入@SpringBootApplication，可以看到這是一個合成註解(紅框中是要關注的)。

1. @SpringBootConfiguration

這個註解幹嘛的？

直接點進去，發現有一個@Configuration註解，那這不就是個設定類嘛。

進而也說明了，MainApplication 也是一個設定類。

2. @ComponentScan

這個已經很熟悉了，可以指定掃描哪些 Spring 註解。

只不過這裡，加了一些其他的過濾條件，暫時不關注。

3. @EnableAutoConfiguration

這個是最重要的註解了，聽名字就不一般，開啟自動設定。

點進去，發現也是一個合成註解(紅框需要關注)。

(1)@AutoConfigurationPackage

聽名字像是自動設定包？依舊點進去。

可以看到原來是匯入了一個叫Registrar的元件，繼續點進 Registrar。

這裡是利用Registrar()給容器中匯入一系列元件，也就是批次註冊元件。

在這裡打個斷點，debug 啟動一下。

registerBeanDefinitions()方法中有個傳參：

metadata，是註解的元資訊，可以看到這個註解是被標註在com.pingguo.boot.MainApplication。

而在registerBeanDefinitions()方法體內，new 了一個AutoConfigurationPackages.PackageImports()，裡面傳入的是元註解，通過getPackageNames()獲取到包名。

AutoConfigurationPackages.register(
    registry, (String[])(new AutoConfigurationPackages.PackageImports(metadata)).getPackageNames().toArray(new String[0])
);

在 idea 中可以單獨執行下片段程式碼

(new AutoConfigurationPackages.PackageImports(metadata)).getPackageNames()。

選中右擊，再點選 Evaluate。

得到的結果就是com.pingguo.boot。為什麼是這個？因為註解標註在MainApplication類，而這個類就屬於com.pingguo.boot。

拿到包名之後，封裝到陣列裡，也就是上述程式碼片段中的toArray(new String[0])，最後註冊進去。

所以，這裡的Registrar()就是把指定的包下的所有元件批次註冊到容器中。

(2)@Import(AutoConfigurationImportSelector.class)

上面指定好預設包規則之後，就需要去匯入需要的包了，利用的是AutoConfigurationImportSelector，繼續點進去看。

這裡有個selectImports方法，這個方法決定了要具體匯入哪些，返回的是一個陣列。

方法體內，又是呼叫了getAutoConfigurationEntry()方法來獲取設定入口，進而再通過getConfigurations()方法獲取具體設定，最終轉成陣列返回。

顯然getAutoConfigurationEntry()是個重點。

往下翻一點，就是getAutoConfigurationEntry()的實現，在這裡打個斷點(把上面的斷點取消掉)。

debug重新執行一下，往下走到getCandidateConfigurations()。

這裡是獲取所有候選設定，目前可以看到這裡是共有 127 個。

為什麼是這 127 個？其實是在組態檔裡寫死了，在 springboot 啟動時候，給容器載入的所有場景的設定類。

定義的位置是在這：spring-boot-autoconfigure2.3.4.RELEASEspring-boot-autoconfigure-2.3.4.RELEASE.jar!META-INFspring.factories

雖然這些一股腦的在啟動時候會去載入到容器，但是最終會按需開啟設定。

比如點開aop，看到@ConditionalOnClass({Advice.class})這個條件，是當存在Advice類時候才匯入元件，但實際上這裡並沒有Advice。

這就是基於 springboot 的按條件裝配@Conditional，根據規則最終實現按需裝配。

二、自動設定範例

分別用最終未生效、和生效的自動設定來加深理解。

1. 未生效的自動設定

比如 cache。

可以看到CacheAutoConfiguration上是加了幾個條件裝配的。

(1)@ConditionalOnClass({CacheManager.class})

在 idea 中使用ctrl+N搜尋一下CacheManager，發現是存在的，那麼這個條件滿足。

(2)@ConditionalOnBean({CacheAspectSupport.class})

這個條件是要求容器中存在CacheAspectSupport這個元件才可以。

現在來判斷一下是否存在這個元件，在 main 方法裡增加測試程式碼：

... ...
      String[] beanNamesForType = run.getBeanNamesForType(CacheAspectSupport.class);
      System.out.println("==CacheAspectSupport型別元件的數量==" + beanNamesForType.length);
... ...

執行檢視輸出。

發現數量等於 0，也就是不存在該型別的元件。

也就是說@ConditionalOnBean({CacheAspectSupport.class})這個條件不滿足，所以整個類CacheAutoConfiguration裡的設定都不生效。

2. 生效的自動設定

之前寫過 web 的demo，那麼 web 相關的設定自然是生效的，找到它。

這裡有不少字尾是**AutoConfiguration的設定，直接來看DispatcherServletAutoConfiguration。

@Configuration(proxyBeanMethods = false)：表示是一個設定類。
@ConditionalOnWebApplication(type = Type.SERVLET)：條件是否為一個 web 應用，而且是原生 SERVLET 型別的(因為springboot2還有webflux)，當前滿足條件。
@ConditionalOnClass({DispatcherServlet.class})：條件是否匯入了DispatcherServlet類，這裡也是有的。

還有 2 個註解直接沒見過，這裡不用太多關注，瞭解一下：

@AutoConfigureOrder：這個設定類的設定優先順序順序。
@AutoConfigureAfter：表示在xx之後才設定這個類，這裡就是在設定完ServletWebServerFactoryAutoConfiguration.class後，再設定當前的類。

所以，類上的幾個條件都是滿足的，就可以進一步到類中了，繼續往下找：

看到DispatcherServletConfiguration類上也有條件：

@Conditional({DispatcherServletAutoConfiguration.DefaultDispatcherServletCondition.class}):

別看這麼長，其實就是上面的一個類

@ConditionalOnClass({ServletRegistration.class}): 這個也存在。

@EnableConfigurationProperties({WebMvcProperties.class})：

這個很熟悉了，使用前面剛學習完不久，它並不是條件裝配，而是用來繫結外部組態檔的，點進去。

可以看到，會與組態檔中字首是spring.mvc的所有屬性進行繫結。

另外，還可以自動把元件註冊到容器中去。

這裡可以試一下，在 main 方法裡增加輸出：

String[] beanNamesForType1 = run.getBeanNamesForType(WebMvcProperties.class);
    System.out.println("==WebMvcProperties型別元件的數量==" + beanNamesForType1.length);

執行一下，果然是有一個：