詳解SpringBoot自動(dòng)裝配原理

運(yùn)行原理

為了研究，我們正常從父項(xiàng)目的pom.xml開(kāi)始進(jìn)行研究。

pom.xml

父依賴(lài) spring-boot-starter-parent主要用來(lái)管理項(xiàng)目的資源過(guò)濾和插件

<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>2.2.5.RELEASE</version>
  <relativePath/> <!-- lookup parent from repository -->
</parent>

點(diǎn)父依賴(lài)進(jìn)去查看，發(fā)現(xiàn)還有一個(gè)父依賴(lài)spring-boot-dependencies，這里的這個(gè)父依賴(lài)才是真正管理springboot應(yīng)用里面的所有依賴(lài)版本的地方，是springboot的版本控制中心。

<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-dependencies</artifactId>
  <version>2.2.5.RELEASE</version>
  <relativePath>../../spring-boot-dependencies</relativePath>
</parent>

啟動(dòng)器：spring-boot-starter-xxx:springboot的場(chǎng)景啟動(dòng)器

spring-boot-starter-web：導(dǎo)入web依賴(lài)的組件

<dependency>    <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

主程序

@SpringBootApplication

作用：標(biāo)注這是一個(gè)springboot主程序類(lèi)，說(shuō)明這是一個(gè)springboot應(yīng)用，springboot就是運(yùn)行這個(gè)類(lèi)的mian方法啟動(dòng)的springboot應(yīng)用。

@SpringBootApplication //標(biāo)注這是一個(gè)主程序類(lèi)，說(shuō)明這是一個(gè)springboot應(yīng)用
public class Springboot01HelloworldApplication {

  public static void main(String[] args) {
    //這里啟動(dòng)了一個(gè)服務(wù)，而不是執(zhí)行了一個(gè)方法。
    SpringApplication.run(Springboot01HelloworldApplication.class, args);
  }
}

點(diǎn)@SpringBootApplication繼續(xù)研究，會(huì)發(fā)現(xiàn)有@SpringBootConfiguration，@EnableAutoConfiguration，@ComponentScan這三個(gè)注解

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

1.@ComponentScan: spring自動(dòng)掃描包

這個(gè)我們?cè)趕pring配置文件中見(jiàn)到過(guò)，它用來(lái)自動(dòng)掃描并加載符合條件的組件或者bean，并將bean加載到IOC容器中。

2.@SpringBootConfiguration: springboot的配置類(lèi)

標(biāo)注在某個(gè)類(lèi)上，說(shuō)明這個(gè)類(lèi)是springboot的配置類(lèi)，在這里它就說(shuō)明SpringBootApplication這個(gè)類(lèi)是springboot的配置類(lèi)。

我們繼續(xù)點(diǎn)@SpringBootConfiguration進(jìn)去查看，會(huì)發(fā)現(xiàn) @Configuration這個(gè)注解

2.1 @Configuration：配置類(lèi)，用來(lái)配置spring的xml文件

我們繼續(xù)點(diǎn)@Configuration進(jìn)去查看，會(huì)發(fā)現(xiàn) @Component這個(gè)注解。

2.2 @Component:組件，說(shuō)明啟動(dòng)類(lèi)本身也是一個(gè)組件，負(fù)責(zé)啟動(dòng)應(yīng)用。

至此，@SpringBootConfiguration這條線(xiàn)，我們研究完了。

3.@EnableAutoConfiguration：開(kāi)啟自動(dòng)裝配，通過(guò)@EnableAutoConfiguration來(lái)幫我們自動(dòng)配置之前我們需要配置的東西。
我們繼續(xù)點(diǎn)@EnableAutoConfiguration進(jìn)去查看，會(huì)發(fā)現(xiàn) @AutoConfigurationPackage和@Import({AutoConfigurationImportSelector.class}) 這兩個(gè)注解。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
  String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

  Class<?>[] exclude() default {};

  String[] excludeName() default {};
}

3.1 @AutoConfigurationPackage自動(dòng)裝配包

繼續(xù)點(diǎn)進(jìn)去查看，出現(xiàn)@Import({Registrar.class})這個(gè)注解

3.1.1 @Import({Registrar.class})： spring底層注解，給容器導(dǎo)入一個(gè)組件

Registrar.class： 將主啟動(dòng)類(lèi)所在包及所在包下面的所有子包里面所有的組件都掃描到Spring容器。

至此，@AutoConfigurationPackage這條線(xiàn)我們也研究完了。

3.2 @Import({AutoConfigurationImportSelector.class}): 給容器導(dǎo)入組件

AutoConfigurationImportSelector.class：自動(dòng)裝配導(dǎo)入選擇器。

導(dǎo)入的選擇器分析：

1.我們點(diǎn)進(jìn)去AutoConfigurationImportSelector.class這個(gè)類(lèi)的源碼進(jìn)行探究，

2.我們點(diǎn)擊getCandidateConfigurations進(jìn)一步分析

  protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
    Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
    return configurations;
  }

2.1 使用了getSpringFactoriesLoaderFactoryClass()方法，返回一開(kāi)始我們看到的啟動(dòng)自動(dòng)配置文件的注解類(lèi)EnableAutoConfiguration.class

  protected Class<?> getSpringFactoriesLoaderFactoryClass() {
    return EnableAutoConfiguration.class;
  }

2.2 發(fā)現(xiàn)它調(diào)用了SpringFactoriesLoader類(lèi)的靜態(tài)方法，我們點(diǎn)擊loadFactoryNames進(jìn)入loadFactoryNames()

public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
    ClassLoader classLoaderToUse = classLoader;
    if (classLoader == null) {
      classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();
    }

    String factoryTypeName = factoryType.getName();
    return (List)loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());
  }

發(fā)現(xiàn)它又調(diào)用了loadSpringFactories()方法，點(diǎn)進(jìn)去查看

 private static Map<String, List<String>> loadSpringFactories(ClassLoader classLoader) {
    Map<String, List<String>> result = (Map)cache.get(classLoader);
    if (result != null) {
      return result;
    } else {
      HashMap result = new HashMap();

      try {
        Enumeration urls = classLoader.getResources("META-INF/spring.factories");

        while(urls.hasMoreElements()) {
          URL url = (URL)urls.nextElement();
          UrlResource resource = new UrlResource(url);
          Properties properties = PropertiesLoaderUtils.loadProperties(resource);
          Iterator var6 = properties.entrySet().iterator();

          while(var6.hasNext()) {
            Entry<?, ?> entry = (Entry)var6.next();
            String factoryTypeName = ((String)entry.getKey()).trim();
            String[] factoryImplementationNames = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());
            String[] var10 = factoryImplementationNames;
            int var11 = factoryImplementationNames.length;

            for(int var12 = 0; var12 < var11; ++var12) {
              String factoryImplementationName = var10[var12];
              ((List)result.computeIfAbsent(factoryTypeName, (key) -> {
                return new ArrayList();
              })).add(factoryImplementationName.trim());
            }
          }
        }

        result.replaceAll((factoryType, implementations) -> {
          return (List)implementations.stream().distinct().collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList));
        });
        cache.put(classLoader, result);
        return result;
      } catch (IOException var14) {
        throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var14);
      }
    }
  }

源碼分析：

1. MultiValueMap<String, String> result = (MultiValueMap)cache.get(classLoader);獲得classLoader，我們返回可以看到這里得到的就是EnableAutoConfiguration標(biāo)注的類(lèi)本身
2. Enumeration<URL> urls = classLoader != null ? classLoader.getResources("META-INF/spring.factories") : ClassLoader.getSystemResources("META-INF/spring.factories");獲取一個(gè)資源 "META-INF/spring.factories"
3. while循環(huán)，讀取到的資源遍歷，封裝成為一個(gè)Properties
   

spring.factories文件

WebMvcAutoConfiguration

我們?cè)谏厦娴淖詣?dòng)配置類(lèi)隨便找一個(gè)打開(kāi)看看，比如 ：WebMvcAutoConfiguration

都是大家熟悉的配置，所以，自動(dòng)配置真正實(shí)現(xiàn)是從classpath中搜尋所有的META-INF/spring.factories配置文件 ，并將其中對(duì)應(yīng)的 org.springframework.boot.autoconfigure. 包下的配置項(xiàng)，通過(guò)反射實(shí)例化為對(duì)應(yīng)標(biāo)注了 @Configuration的JavaConfig形式的IOC容器配置類(lèi) ， 然后將這些都匯總成為一個(gè)實(shí)例并加載到IOC容器中。

總結(jié)

1. SpringBoot在啟動(dòng)的時(shí)候從類(lèi)路徑下的META-INF/spring.factories中獲取EnableAutoConfiguration指定的值
2. 將這些值作為自動(dòng)配置類(lèi)導(dǎo)入容器，自動(dòng)配置類(lèi)就生效，幫我們進(jìn)行自動(dòng)配置工作；
3. 整個(gè)J2EE的整體解決方案和自動(dòng)配置都在springboot-autoconfigure的jar包中；
4. 它會(huì)給容器中導(dǎo)入非常多的自動(dòng)配置類(lèi) （xxxAutoConfiguration）, 就是給容器中導(dǎo)入這個(gè)場(chǎng)景需要的所有組件 ， 并配置好這些組件 ；
5. 有了自動(dòng)配置類(lèi) ， 免去了我們手動(dòng)編寫(xiě)配置注入功能組件等的工作；
   

主啟動(dòng)類(lèi)

SpringApplication

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

分析：

1. SpringbootApplication.class：應(yīng)用參數(shù)的入口
2. args：命令行參數(shù)
3. 該方法返回的是一個(gè)ConfigurableApplicationContext對(duì)象
   

SpringApplication主要做的事情：

1. 推斷應(yīng)用的類(lèi)型是普通的項(xiàng)目還是Web項(xiàng)目
2. 查找并加載所有可用初始化器 ， 設(shè)置到initializers屬性中
3. 找出所有的應(yīng)用程序監(jiān)聽(tīng)器，設(shè)置到listeners屬性中
4. 推斷并設(shè)置main方法的定義類(lèi)，找到運(yùn)行的主類(lèi)

以上就是關(guān)于SpringBoot自動(dòng)裝配原理的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot框架的資料請(qǐng)關(guān)注W3Cschool其它相關(guān)文章！