SpringBoot自動配置原理,你真的懂嗎?

概述

上面博文(SpringBoot簡介與快速搭建)我們簡單的介紹了什么是SpringBoot,以及如何使用SpringBoot,但是我們對于SpringBoot的基本原理并沒有介紹,這篇博文我們重點介紹SpringBoot是如何實現(xiàn)的自動配置。


依賴管理

在我們的pom文件中最核心的依賴就一個:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.4</version>
    <relativePath/>
</parent>

它的父項目依賴,規(guī)定所有依賴的版本信息:

<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-dependencies</artifactId>
  <version>2.4.4</version>
</parent>

由此,我們發(fā)現(xiàn)springboot框架幾乎聲明了所有開發(fā)中常用的依賴的版本號,無需關(guān)注版本號,而且實現(xiàn)了自動版本仲裁機制,當然了我們也可以根據(jù)我們的需要,替換掉默認的依賴版本。


核心注解@SpringBootApplication

@SpringBootApplication
public class BootApplication {

    public static void main(String[] args) {
        SpringApplication.run(BootApplication.class, args);
    }
}

在上面的啟動類中我們發(fā)現(xiàn)了一個陌生的注解@SpringBootApplication,這個注解的是什么含義呢?我們點進去看一下。

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
      @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })

其實@SpringBootApplication是上面三個注解的組合體,我們對這三個注解理解清楚就可以了,下面逐個進行解釋:


@SpringBootConfiguration

@Configuration
public @interface SpringBootConfiguration {

@Configuration我們并不陌生,它允許在上下文中注冊額外的bean或?qū)肫渌渲妙?,@SpringBootConfiguration其實代表當前類是一個配置類。


@EnableAutoConfiguration

EnableAutoConfiguration的目的是啟動SpringBoot的自動配置機制。

@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

1、AutoConfigurationPackage指定默認的包規(guī)則

@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {

AutoConfigurationPackage注解的作用是將 添加該注解的類所在的package 作為 自動配置package 進行管理。也就是說當SpringBoot應(yīng)用啟動時默認會將啟動類所在的package作為自動配置的package。然后使用@Import注解將其注入到ioc容器中。這樣,可以在容器中拿到該路徑。

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {

   @Override
   public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
      register(registry, new PackageImports(metadata).getPackageNames().toArray(new String[0]));
   }

   @Override
   public Set<Object> determineImports(AnnotationMetadata metadata) {
      return Collections.singleton(new PackageImports(metadata));
   }

}

重點看下registerBeanDefinitions方法。

方法的第二個參數(shù)通過new PackageImport(metadata).getPackageName()方法設(shè)置。

接著看下PackageImport的構(gòu)造器方法。

PackageImports(AnnotationMetadata metadata) {
   AnnotationAttributes attributes = AnnotationAttributes
         .fromMap(metadata.getAnnotationAttributes(AutoConfigurationPackage.class.getName(), false));
   List<String> packageNames = new ArrayList<>(Arrays.asList(attributes.getStringArray("basePackages")));
   for (Class<?> basePackageClass : attributes.getClassArray("basePackageClasses")) {
      packageNames.add(basePackageClass.getPackage().getName());
   }
   if (packageNames.isEmpty()) {
      packageNames.add(ClassUtils.getPackageName(metadata.getClassName()));
   }
   this.packageNames = Collections.unmodifiableList(packageNames);
}

ClassUtils.getPackageName(metadata.getClassName())獲取標注@AutoConfigurationPackage注解的類的全限定名。

最后,利用Registrar給容器中導入一系列組件,將指定的包下的所有組件導入進來。

2、@Import(AutoConfigurationImportSelector.class)

使用Import自動導入所有符合自動配置條件的Bean定義并加載到IOC容器

@Override
        public void process(AnnotationMetadata annotationMetadata, DeferredImportSelector deferredImportSelector) {
            Assert.state(deferredImportSelector instanceof AutoConfigurationImportSelector,
                    () -> String.format("Only %s implementations are supported, got %s",
                            AutoConfigurationImportSelector.class.getSimpleName(),
                            deferredImportSelector.getClass().getName()));
            AutoConfigurationEntry autoConfigurationEntry = ((AutoConfigurationImportSelector) deferredImportSelector)
                    .getAutoConfigurationEntry(annotationMetadata);
            this.autoConfigurationEntries.add(autoConfigurationEntry);
            for (String importClassName : autoConfigurationEntry.getConfigurations()) {
                this.entries.putIfAbsent(importClassName, annotationMetadata);
            }
        }

1、利用getAutoConfigurationEntry(annotationMetadata);給容器中批量導入一些組件
2、調(diào)用List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes)獲取到所有需要導入到容器中的配置類
3、利用工廠加載 Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader);得到所有的組件
4、從META-INF/spring.factories位置來加載一個文件。
默認掃描我們當前系統(tǒng)里面所有META-INF/spring.factories位置的文件
spring-boot-autoconfigure-2.4.4.RELEASE.jar包里面也有META-INF/spring.factories

在這里插入圖片描述

文件里面寫死了spring-boot一啟動就要給容器中加載的所有配置類spring-boot-autoconfigure-2.4.4.RELEASE.jar/META-INF/spring.factories,一共130個自動配置類。

130個場景的所有自動配置,會在springboot啟動的時候默認全部加載。xxxxAutoConfiguration會按照條件裝配規(guī)則(@Conditional),最終會按需配置。

小結(jié):

SpringBoot為我們的應(yīng)用程序啟用了三個功能:自動配置,組件掃描,以及能夠在"應(yīng)用類"上定義額外的配置。


@ComponentScan

@Component在應(yīng)用程序所在的軟件包上啟用掃描,指定掃描哪些Spring注解。


ServletWebServerFactoryAutoConfiguration為例

在130個場景有我們比較熟悉兩個組件,ServletWebServerFactoryAutoConfiguration和WebMvcAutoConfiguration,我們以ServletWebServerFactoryAutoConfiguration為例,看一下SpringBoot是如何自動裝配的webServer。

在這里插入圖片描述

在注解中我們看到了大量以@Conditional開頭的注解,即條件裝配,滿足Conditional指定的條件,則進行組件注入。@EnableConfigurationProperties(ServerProperties.class)+@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true),讀取我們在配置文件編寫的屬性,并把它封裝到JavaBean中,以供隨時使用。

此時我們的Tomcat容器已經(jīng)以Bean的形式被注入到了IOC容器中。


如何禁用特定的自動配置類

如果發(fā)現(xiàn)應(yīng)用中不需要特定自動配置類,則可以使用exclude屬性@SpringBootApplication來禁用它們,如以下示例所示:

import org.springframework.boot.autoconfigure.*;
import org.springframework.boot.autoconfigure.jdbc.*;

@SpringBootApplication(exclude={DataSourceAutoConfiguration.class})
//@SpringBootApplication(excludeName = {"org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration"})
public class MyApplication {
}

如果該類不在類路徑中,則可以使用excludeName注釋的屬性,并指定完全限定的名稱(全類名字符串)。定義排除項,即可以使用哪個注釋級別也可以使用屬性來定義。


總結(jié)

  • SpringBoot預(yù)先加載META-INF/spring.factories中所有的自動配置類,xxxxxAutoConfiguration

  • 每個自動配置類按照條件進行生效,默認都會綁定配置文件指定的值。xxxxProperties里面拿。xxxProperties和配置文件進行了綁定

  • 生效的配置類就會給容器中裝配很多組件,只要容器中有這些組件,相當于有了這些功能

  • 定制化配置

    • 用戶直接自己@Bean替換底層的組件
    • 用戶根據(jù)這個組件是獲取的配置文件的什么值,可以自行修改。

EnableAutoConfiguration ---> 掃描xxxxxAutoConfiguration ---> 根據(jù)條件@Conditional裝配組件 --->根據(jù)xxxxProperties加載屬性值 ----> application.properties


作者:程序猿小亮

博主寫作不易,加個關(guān)注唄

求關(guān)注、求點贊,加個關(guān)注不迷路,感謝

點贊是對我最大的鼓勵
↓↓↓↓↓↓

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容