SpringBoot02：启动底层原理的学习全部的自动装配也就需要的配置 spring-boot-autoconfigure-2.3.2.RELEASE.jar 方法

最新推荐文章于 2024-01-25 00:02:27 发布

原创最新推荐文章于 2024-01-25 00:02:27 发布 · 3.6k 阅读

0 ·

CC 4.0 BY-SA版权

本文深入探究SpringBoot项目运行原理，解析pom.xml依赖管理、自动配置机制、主启动类注解功能，以及SpringApplication如何启动服务。

运行原理探究

我们之前写的HelloSpringBoot，到底是怎么运行的呢，Maven项目，我们一般从pom.xml文件探究起；

pom.xml

父依赖

其中它主要是依赖一个父项目，主要是管理项目的资源过滤及插件！

<pre><span style="color: #0000ff;">&lt;</span><span style="color: #800000;">parent</span><span style="color: #0000ff;">&gt;</span>
    <span style="color: #0000ff;">&lt;</span><span style="color: #800000;">groupId</span><span style="color: #0000ff;">&gt;</span>org.springframework.boot<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">groupId</span><span style="color: #0000ff;">&gt;</span>
    <span style="color: #0000ff;">&lt;</span><span style="color: #800000;">artifactId</span><span style="color: #0000ff;">&gt;</span>spring-boot-starter-parent<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">artifactId</span><span style="color: #0000ff;">&gt;</span>
    <span style="color: #0000ff;">&lt;</span><span style="color: #800000;">version</span><span style="color: #0000ff;">&gt;</span>2.2.5.RELEASE<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">version</span><span style="color: #0000ff;">&gt;</span>
    <span style="color: #0000ff;">&lt;</span><span style="color: #800000;">relativePath</span><span style="color: #0000ff;">/&gt;</span> <span style="color: #008000;">&lt;!--</span><span style="color: #008000;"> lookup parent from repository </span><span style="color: #008000;">--&gt;</span>
<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">parent</span><span style="color: #0000ff;">&gt;</span></pre>

点进去，发现还有一个父依赖

<pre><span style="color: #0000ff;">&lt;</span><span style="color: #800000;">parent</span><span style="color: #0000ff;">&gt;</span>
    <span style="color: #0000ff;">&lt;</span><span style="color: #800000;">groupId</span><span style="color: #0000ff;">&gt;</span>org.springframework.boot<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">groupId</span><span style="color: #0000ff;">&gt;</span>
    <span style="color: #0000ff;">&lt;</span><span style="color: #800000;">artifactId</span><span style="color: #0000ff;">&gt;</span>spring-boot-dependencies<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">artifactId</span><span style="color: #0000ff;">&gt;</span>
    <span style="color: #0000ff;">&lt;</span><span style="color: #800000;">version</span><span style="color: #0000ff;">&gt;</span>2.2.5.RELEASE<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">version</span><span style="color: #0000ff;">&gt;</span>
    <span style="color: #0000ff;">&lt;</span><span style="color: #800000;">relativePath</span><span style="color: #0000ff;">&gt;</span>../../spring-boot-dependencies<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">relativePath</span><span style="color: #0000ff;">&gt;</span>
<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">parent</span><span style="color: #0000ff;">&gt;</span></pre>

这里才是真正管理SpringBoot应用里面所有依赖版本的地方，SpringBoot的版本控制中心；

以后我们导入依赖默认是不需要写版本；但是如果导入的包没有在依赖中管理着就需要手动配置版本了；

启动器 spring-boot-starter

<pre><span style="color: #0000ff;">&lt;</span><span style="color: #800000;">dependency</span><span style="color: #0000ff;">&gt;</span>
    <span style="color: #0000ff;">&lt;</span><span style="color: #800000;">groupId</span><span style="color: #0000ff;">&gt;</span>org.springframework.boot<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">groupId</span><span style="color: #0000ff;">&gt;</span>
    <span style="color: #0000ff;">&lt;</span><span style="color: #800000;">artifactId</span><span style="color: #0000ff;">&gt;</span>spring-boot-starter-web<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">artifactId</span><span style="color: #0000ff;">&gt;</span>
<span style="color: #0000ff;">&lt;/</span><span style="color: #800000;">dependency</span><span style="color: #0000ff;">&gt;</span></pre>

springboot-boot-starter-xxx：就是spring-boot的场景启动器

spring-boot-starter-web：帮我们导入了web模块正常运行所依赖的组件；

SpringBoot将所有的功能场景都抽取出来，做成一个个的starter （启动器），只需要在项目中引入这些starter即可，所有相关的依赖都会导入进来，我们要用什么功能就导入什么样的场景启动器即可；我们未来也可以自己自定义 starter；

主启动类

分析完了 pom.xml 来看看这个启动类

默认的主启动类

//</span><span style="color: #008000;">@SpringBootApplication 来标注一个主程序类
</span><span style="color: #008000;">//</span><span style="color: #008000;">说明这是一个Spring Boot应用</span>
<span style="color: #000000;">@SpringBootApplication
</span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">class</span><span style="color: #000000;"> SpringbootApplication {

   </span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">static</span> <span style="color: #0000ff;">void</span><span style="color: #000000;"> main(String[] args) {
     </span><span style="color: #008000;">//</span><span style="color: #008000;">以为是启动了一个方法，没想到启动了一个服务</span>
      SpringApplication.run(SpringbootApplication.<span style="color: #0000ff;">class</span><span style="color: #000000;">, args);
   }

}</span></pre>

但是一个简单的启动类并不简单！我们来分析一下这些注解都干了什么

@SpringBootApplication

作用：标注在某个类上说明这个类是SpringBoot的主配置类， SpringBoot就应该运行这个类的main方法来启动SpringBoot应用；

进入这个注解：可以看到上面还有很多其他注解！

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters </span>=<span style="color: #000000;"> {@Filter(
    type </span>=<span style="color: #000000;"> FilterType.CUSTOM,
    classes </span>= {TypeExcludeFilter.<span style="color: #0000ff;">class</span><span style="color: #000000;">}
), @Filter(
    type </span>=<span style="color: #000000;"> FilterType.CUSTOM,
    classes </span>= {AutoConfigurationExcludeFilter.<span style="color: #0000ff;">class</span><span style="color: #000000;">}
)}
)
</span><span style="color: #0000ff;">public</span> @<span style="color: #0000ff;">interface</span><span style="color: #000000;"> SpringBootApplication {
    </span><span style="color: #008000;">//</span><span style="color: #008000;"> ......</span>
}</pre>

@ComponentScan

这个注解在Spring中很重要 ,它对应XML配置中的元素。

作用：自动扫描并加载符合条件的组件或者bean ，将这个bean定义加载到IOC容器中

@SpringBootConfiguration

作用：SpringBoot的配置类，标注在某个类上，表示这是一个SpringBoot的配置类；

我们继续进去这个注解查看

// 点进去得到下面的 @Component

@Configuration
</span><span style="color: #0000ff;">public</span> @<span style="color: #0000ff;">interface</span><span style="color: #000000;"> SpringBootConfiguration {}

@Component
</span><span style="color: #0000ff;">public</span> @<span style="color: #0000ff;">interface</span> Configuration {}</pre>

这里的 @Configuration，说明这是一个配置类，配置类就是对应Spring的xml 配置文件；

里面的 @Component 这就说明，启动类本身也是Spring中的一个组件而已，负责启动应用！

我们回到 SpringBootApplication 注解中继续看。

@EnableAutoConfiguration

@EnableAutoConfiguration ：开启自动配置功能

以前我们需要自己配置的东西，而现在SpringBoot可以自动帮我们配置；@EnableAutoConfiguration告诉SpringBoot开启自动配置功能，这样自动配置才能生效；

点进注解接续查看：

@AutoConfigurationPackage ：自动配置包

@Import({Registrar.<span style="color: #0000ff;">class</span><span style="color: #000000;">})
</span><span style="color: #0000ff;">public</span> @<span style="color: #0000ff;">interface</span><span style="color: #000000;"> AutoConfigurationPackage {
}</span></pre>

@import ：Spring底层注解@import ，给容器中导入一个组件

Registrar.class 作用：将主启动类的所在包及包下面所有子包里面的所有组件扫描到Spring容器；

这个分析完了，退到上一步，继续看

@Import({AutoConfigurationImportSelector.class}) ：给容器导入组件；

AutoConfigurationImportSelector ：自动配置导入选择器，那么它会导入哪些组件的选择器呢？我们点击去这个类看源码：

1、这个类中有一个这样的方法

//</span><span style="color: #008000;"> 获得候选的配置</span>
<span style="color: #0000ff;">protected</span> List&lt;String&gt;<span style="color: #000000;"> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    </span><span style="color: #008000;">//</span><span style="color: #008000;">这里的getSpringFactoriesLoaderFactoryClass（）方法
    </span><span style="color: #008000;">//</span><span style="color: #008000;">返回的就是我们最开始看的启动自动导入配置文件的注解类；EnableAutoConfiguration</span>
    List&lt;String&gt; configurations = SpringFactoriesLoader.loadFactoryNames(<span style="color: #0000ff;">this</span>.getSpringFactoriesLoaderFactoryClass(), <span style="color: #0000ff;">this</span><span style="color: #000000;">.getBeanClassLoader());
    Assert.notEmpty(configurations, </span>"No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct."<span style="color: #000000;">);
    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> configurations;
}</span></pre>
<div class="cnblogs_code_toolbar"><span class="cnblogs_code_copy"><a href="javascript:void(0);" onclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></span></div></div>

2、这个方法又调用了 SpringFactoriesLoader 类的静态方法！我们进入SpringFactoriesLoader类loadFactoryNames() 方法

public</span> <span style="color: #0000ff;">static</span> List&lt;String&gt; loadFactoryNames(Class&lt;?&gt;<span style="color: #000000;"> factoryClass, @Nullable ClassLoader classLoader) {
    String factoryClassName </span>=<span style="color: #000000;"> factoryClass.getName();
    </span><span style="color: #008000;">//</span><span style="color: #008000;">这里它又调用了 loadSpringFactories 方法</span>
    <span style="color: #0000ff;">return</span><span style="color: #000000;"> (List)loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
}</span></pre>

3、我们继续点击查看 loadSpringFactories 方法

private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
    //获得classLoader ， 我们返回可以看到这里得到的就是EnableAutoConfiguration标注的类本身
    MultiValueMap<String, String> result = (MultiValueMap)cache.get(classLoader);
    if (result != null) {
        return result;
    } else {
        try {
            //去获取一个资源 "META-INF/spring.factories"
            Enumeration<URL> urls = classLoader != null ? classLoader.getResources("META-INF/spring.factories") : ClassLoader.getSystemResources("META-INF/spring.factories");
            LinkedMultiValueMap result = new LinkedMultiValueMap();
 
 
            //将读取到的资源遍历，封装成为一个Properties
            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 factoryClassName = ((String)entry.getKey()).trim();
                    String[] var9 = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());
                    int var10 = var9.length;
 
 
                    for(int var11 = 0; var11 < var10; ++var11) {
                        String factoryName = var9[var11];
                        result.add(factoryClassName, factoryName.trim());
                    }
                }
            }
 
 
            cache.put(classLoader, result);
            return result;
        } catch (IOException var13) {
            throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var13);
        }
    }
}

4、发现一个多次出现的文件：spring.factories，全局搜索它

spring.factories

我们根据源头打开spring.factories ，看到了很多自动配置的文件；这就是自动配置根源所在！

WebMvcAutoConfiguration

我们在上面的自动配置类随便找一个打开看看，比如：WebMvcAutoConfiguration

可以看到这些一个个的都是JavaConfig配置类，而且都注入了一些Bean，可以找一些自己认识的类，看着熟悉一下！

所以，自动配置真正实现是从classpath中搜寻所有的META-INF/spring.factories配置文件，并将其中对应的 org.springframework.boot.autoconfigure. 包下的配置项，通过反射实例化为对应标注了 @Configuration的JavaConfig形式的IOC容器配置类，然后将这些都汇总成为一个实例并加载到IOC容器中。

结论：

SpringBoot在启动的时候从类路径下的META-INF/spring.factories中获取EnableAutoConfiguration指定的值
将这些值作为自动配置类导入容器，自动配置类就生效，帮我们进行自动配置工作；
整个J2EE的整体解决方案和自动配置都在springboot-autoconfigure的jar包中；
它会给容器中导入非常多的自动配置类（xxxAutoConfiguration）, 就是给容器中导入这个场景需要的所有组件，并配置好这些组件；
有了自动配置类，免去了我们手动编写配置注入功能组件等的工作；

现在大家应该大概的了解了下，SpringBoot的运行原理，后面我们还会深化一次！

SpringApplication

不简单的方法

我最初以为就是运行了一个main方法，没想到却开启了一个服务；

@SpringBootApplication
</span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">class</span><span style="color: #000000;"> SpringbootApplication {
    </span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">static</span> <span style="color: #0000ff;">void</span><span style="color: #000000;"> main(String[] args) {
        SpringApplication.run(SpringbootApplication.</span><span style="color: #0000ff;">class</span><span style="color: #000000;">, args);
    }
}</span></pre>

SpringApplication.run分析

分析该方法主要分两部分，一部分是SpringApplication的实例化，二是run方法的执行；

![在这里插入图片描述](https://img-blog.csdnimg.cn/20200808014414727.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Fuc3dlcm8=,size_16,color_FFFFFF,t_70)

SpringApplication

这个类主要做了以下四件事情：

1、推断应用的类型是普通的项目还是Web项目

2、查找并加载所有可用初始化器，设置到initializers属性中

3、找出所有的应用程序监听器，设置到listeners属性中

4、推断并设置main方法的定义类，找到运行的主类

查看构造器：

public</span><span style="color: #000000;"> SpringApplication(ResourceLoader resourceLoader, Class... primarySources) {
    </span><span style="color: #008000;">//</span><span style="color: #008000;"> ......</span>
    <span style="color: #0000ff;">this</span>.webApplicationType =<span style="color: #000000;"> WebApplicationType.deduceFromClasspath();
    </span><span style="color: #0000ff;">this</span>.setInitializers(<span style="color: #0000ff;">this</span><span style="color: #000000;">.getSpringFactoriesInstances();
    </span><span style="color: #0000ff;">this</span>.setListeners(<span style="color: #0000ff;">this</span>.getSpringFactoriesInstances(ApplicationListener.<span style="color: #0000ff;">class</span><span style="color: #000000;">));
    </span><span style="color: #0000ff;">this</span>.mainApplicationClass = <span style="color: #0000ff;">this</span><span style="color: #000000;">.deduceMainApplicationClass();
}</span></pre>