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

依賴管理

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

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

它的父項目依賴,規定全部依賴的版本信息:spring

<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-dependencies</artifactId>
  <version>2.4.4</version>
</parent>
複製代碼

由此,咱們發現springboot框架幾乎聲明瞭全部開發中經常使用的依賴的版本號,無需關注版本號,並且實現了自動版本仲裁機制,固然了咱們也能夠根據咱們的須要,替換掉默認的依賴版本。springboot

核心註解@SpringBootApplication

@SpringBootApplication
public class BootApplication {

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

在上面的啓動類中咱們發現了一個陌生的註解@SpringBootApplication,這個註解的是什麼含義呢?咱們點進去看一下。markdown

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

其實@SpringBootApplication是上面三個註解的組合體,咱們對這三個註解理解清楚就能夠了,下面逐個進行解釋:app

@SpringBootConfiguration

@Configuration
public @interface SpringBootConfiguration {
複製代碼

@Configuration咱們並不陌生,它容許在上下文中註冊額外的bean或導入其餘配置類,@SpringBootConfiguration其實表明當前類是一個配置類。框架

@EnableAutoConfiguration

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

@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
複製代碼

一、AutoConfigurationPackage指定默認的包規則spring-boot

@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
複製代碼

AutoConfigurationPackage註解的做用是將 添加該註解的類所在的package做爲 自動配置package進行管理。也就是說當SpringBoot應用啓動時默認會將啓動類所在的package做爲自動配置的package。而後使用@Import註解將其注入到ioc容器中。這樣,能夠在容器中拿到該路徑。this

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方法。spa

方法的第二個參數經過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給容器中導入一系列組件,將指定的包下的全部組件導入進來。

二、@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);
			}
		}
複製代碼

一、利用getAutoConfigurationEntry(annotationMetadata);給容器中批量導入一些組件

二、調用List configurations = getCandidateConfigurations(annotationMetadata, attributes)獲取到全部須要導入到容器中的配置類

三、利用工廠加載 Map<String, List> loadSpringFactories(@Nullable ClassLoader classLoader);獲得全部的組件

四、從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

相關文章
相關標籤/搜索