SpringBoot自動配置原理,你真的懂嗎?(簡單易懂)

Posted on by

概述

上面博文（SpringBoot簡介與快速搭建）我們簡單的介紹瞭什麼是SpringBoot，以及如何使用SpringBoot，但是我們對於SpringBoot的基本原理並沒有介紹，這篇博文我們重點介紹SpringBoot是如何實現的自動配置。

依賴管理

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

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

它的父項目依賴，規定所有依賴的版本信息：

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

由此，我們發現springboot框架幾乎聲明瞭所有開發中常用的依賴的版本號，無需關註版本號，而且實現瞭自動版本仲裁機制，當然瞭我們也可以根據我們的需要，替換掉默認的依賴版本。

核心註解@SpringBootApplication

@SpringBootApplication
public class BootApplication {

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

在上面的啟動類中我們發現瞭一個陌生的註解@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或導入其他配置類，@SpringBootConfiguration其實代表當前類是一個配置類。

@EnableAutoConfiguration

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

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

1、AutoConfigurationPackage指定默認的包規則

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

AutoConfigurationPackage註解的作用是將 添加該註解的類所在的package 作為 自動配置package 進行管理。也就是說當SpringBoot應用啟動時默認會將啟動類所在的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方法。

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

接著看下PackageImport的構造器方法。

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、調用List configurations = getCandidateConfigurations(annotationMetadata, attributes)獲取到所有需要導入到容器中的配置類
3、利用工廠加載 Map<String, List> loadSpringFactories(@Nullable ClassLoader classLoader)；得到所有的組件
4、從META-INF/spring.factories位置來加載一個文件。
默認掃描我們當前系統裡面所有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會按照條件裝配規則（@Conditional），最終會按需配置。

小結：

SpringBoot為我們的應用程序啟用瞭三個功能：自動配置，組件掃描，以及能夠在”應用類”上定義額外的配置。

@ComponentScan

@Component在應用程序所在的軟件包上啟用掃描，指定掃描哪些Spring註解。

ServletWebServerFactoryAutoConfiguration為例

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

在這裡插入圖片描述

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

此時我們的Tomcat容器已經以Bean的形式被註入到瞭IOC容器中。

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

如果發現應用中不需要特定自動配置類，則可以使用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註釋的屬性，並指定完全限定的名稱（全類名字符串）。定義排除項，即可以是用哪個註釋級別也可以使用屬性來定義。

總結

  • SpringBoot預先加載META-INF/spring.factories中所有的自動配置類，xxxxxAutoConfiguration
  • 每個自動配置類按照條件進行生效，默認都會綁定配置文件指定的值。xxxxProperties裡面拿。xxxProperties和配置文件進行瞭綁定
  • 生效的配置類就會給容器中裝配很多組件，隻要容器中有這些組件，相當於有瞭這些功能
  • 定制化配置

用戶直接自己@Bean替換底層的組件

用戶根據這個組件是獲取的配置文件的什麼值，可以自行修改。

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

到此這篇關於SpringBoot自動配置原理,你真的懂嗎?的文章就介紹到這瞭,更多相關SpringBoot自動配置原理內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：