最全面的SpringBoot教程——SpringBoot运行原理分析

Posted 2023-03-05 小新要变强

前言

本文为 最全面的SpringBoot教程（六）——SpringBoot运行原理分析 相关知识，下边将对SpringBoot运行原理以及自动配置原理进行详尽的分析介绍~

📌博主主页：小新要变强 的主页
👉Java全栈学习路线可参考：【Java全栈学习路线】最全的Java学习路线及知识清单，Java自学方向指引，内含最全Java全栈学习技术清单~
👉算法刷题路线可参考：算法刷题路线总结与相关资料分享，内含最详尽的算法刷题路线指南及相关资料分享~
👉Java微服务开源项目可参考：企业级Java微服务开源项目（开源框架，用于学习、毕设、公司项目、私活等，减少开发工作，让您只关注业务！）

---

目录

SpringBoot运行原理分析

• 前言
• 目录
• 一、SpringBoot运行原理
• • 1️⃣父依赖
  • 2️⃣starter场景启动器
  • 3️⃣主启动类
  • 4️⃣spring.factories
  • 5️⃣SpringApplication.run分析
• 二、自动配置原理
• • 1️⃣自动配置原理分析
  • 2️⃣@Conditional
• 后记

一、SpringBoot运行原理

1️⃣父依赖

我们查看SpringBoot项目的pom.xml文件可以看到，它主要是依赖一个父项目，主要是管理项目的资源过滤及插件！

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

进入到spring-boot-starter-parent，发现还有一个父依赖：

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

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

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

2️⃣starter场景启动器

🍀（1）见到很多 spring-boot-starter-* ： *就某种场景

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

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

🍀（2）只要引入starter，这个场景的所有常规需要的依赖我们都自动引入

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

🍀（3）SpringBoot所有支持的场景：
https://docs.spring.io/spring-boot/docs/current/reference/html/using-spring-boot.html#using-boot-starter

🍀（4）见到的 *-spring-boot-starter： 第三方为我们提供的简化开发的场景启动器

🍀（5）所有场景启动器最底层的依赖为spring-boot-starter：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</artifactId>
  <version>2.3.4.RELEASE</version>
  <scope>compile</scope>
</dependency>

🍀（6）可以修改依赖的默认版本号

1. 查看spring-boot-dependencies里面规定当前依赖的版本用的 key。
2. 在当前项目里面重写配置，如：

 <properties>
        <mysql.version>5.1.43</mysql.version>
    </properties>

3️⃣主启动类

SpringBoot项目默认的主启动类：

package com.wang;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
//@SpringBootApplication 来标注一个主程序类
//说明这是一个Spring Boot应用
@SpringBootApplication
public class MySpringbootApplication 
    public static void main(String[] args) 
        //以为是启动了一个方法，没想到启动了一个服务
        SpringApplication.run(MySpringbootApplication.class, args);
    

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

• @SpringBootConfiguration : Spring配置类，标注在某个类上，表示这是一个SpringBoot的配置类；
  • @Configuration : 说明这是一个配置类 ，配置类就是对应Spring的xml 配置文件；
  • @Component : 说明启动类本身也是Spring中的一个组件而已，负责启动应；
• @ComponentScan : 这个注解在Spring中很重要 ,它对应XML配置中的元素，扫码当前主启动类同级的包。作用：自动扫描并加载符合条件的组件或者bean ， 将这个bean定义加载到IOC容器中
• @EnableAutoConfiguration : 开启自动配置功能；
  • @AutoConfigurationPackage : 自动配置包；
    • @Import(AutoConfigurationPackages.Registrar.class) : 自动配置 ‘包组件’，Spring底层注解@import ，给容器中导入一个组件，Registrar.class 作用：将主启动类的所在包及包下面所有子包里面的所有组件扫描到Spring容器 ；
  • @Import(AutoConfigurationImportSelector.class) :
    给容器导入组件，AutoConfigurationImportSelector ：自动配置导入选择器

4️⃣spring.factories

根据源头找到org.springframework.boot.autoconfigure包，打开META-INF文件夹下的spring.factories文件：

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

总结：

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

SpringBoot所有自动配置都是在启动的时候扫描并加载: spring.factories所有的自动配置类都在这里面，但是不一定生效。要判断条件是否成立，只要导入了对应的start，就有对应的启动器了，有了启动器，我们自动装配就会生效，然后就配置成功!

5️⃣SpringApplication.run分析

SpringApplication.java:

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

SpringApplication.run方法主要分两部分：

一部分是SpringApplication的实例化，二是run方法的执行。

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

• （1）推断应用的类型是普通的项目还是Web项目
• （2）查找并加载所有可用初始化器 ， 设置到initializers属性中
• （3）找出所有的应用程序监听器，设置到listeners属性中
• （4）推断并设置main方法的定义类，找到运行的主类

SpringApplication的构造器：

public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) 
    // ......
    this.webApplicationType = WebApplicationType.deduceFromClasspath();
    this.setInitializers(this.getSpringFactoriesInstances();
    this.setListeners(this.getSpringFactoriesInstances(ApplicationListener.class));
    this.mainApplicationClass = this.deduceMainApplicationClass();

run方法流程分析：

二、自动配置原理

1️⃣自动配置原理分析

以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理：

//表示这是一个配置类，和以前编写的配置文件一样，也可以给容器中添加组件；
@Configuration 
//启动指定类的ConfigurationProperties功能；
  //进入这个HttpProperties查看，将配置文件中对应的值和HttpProperties绑定起来；
  //并把HttpProperties加入到ioc容器中
@EnableConfigurationProperties(HttpProperties.class) 
//Spring底层@Conditional注解
  //根据不同的条件判断，如果满足指定的条件，整个配置类里面的配置就会生效；
  //这里的意思就是判断当前应用是否是web应用，如果是，当前配置类生效
@ConditionalOnWebApplication(
    type = Type.SERVLET
)
//判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；
@ConditionalOnClass(CharacterEncodingFilter.class)
//判断配置文件中是否存在某个配置：spring.http.encoding.enabled；
  //如果不存在，判断也是成立的
  //即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = "enabled",
    matchIfMissing = true
)
public class HttpEncodingAutoConfiguration 
    //他已经和SpringBoot的配置文件映射了
    private final Encoding properties;
    //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(HttpProperties properties) 
        this.properties = properties.getEncoding();
    
    //给容器中添加一个组件，这个组件的某些值需要从properties中获取
    @Bean
    @ConditionalOnMissingBean //判断容器没有这个组件？
    public CharacterEncodingFilter characterEncodingFilter() 
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.RESPONSE));
        return filter;
    
    //......

一句话总结 ： 根据当前不同的条件判断，决定这个配置类是否生效！

• 一但这个配置类生效；这个配置类就会给容器中添加各种组件；
• 这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；
• 所有在配置文件中能配置的属性都是在xxxxProperties类中封装着；
• 配置文件能配置什么就可以参照某个功能对应的这个属性类。

//从配置文件中获取指定的值和bean的属性进行绑定
@ConfigurationProperties(prefix = "spring.http") 
public class HttpProperties 
    // .....

在配置文件里面试试前缀，看提示！

这就是自动装配的原理！

精髓：

• 1、SpringBoot启动会加载大量的自动配置类；
• 2、我们看我们需要的功能有没有在SpringBoot默认写好的自动配置类当中；
• 3、我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件存在在其中，我们就不需要再手动配置了）；
• 4、给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们只需要在配置文件中指定这些属性的值即可。

xxxxAutoConfigurartion： 自动配置类；给容器中添加组件；
xxxxProperties: 封装配置文件中相关属性；

2️⃣@Conditional

条件装配作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效。

那么多的自动配置类，必须在一定的条件下才能生效；也就是说，我们加载了这么多的配置类，但不是所有的都生效了。

我们怎么知道哪些自动配置类生效？

我们可以通过启用 debug=true属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效；

application.yml:

#开启springboot的调试类,debug=true
debug: true

控制台打印出来的自动配置分为三类 ：

• Positive matches:（自动配置类启用的：正匹配）
• Negative matches:（没有启动，没有匹配成功的自动配置类：负匹配）
• Unconditional classes: （没有条件的类）

---

后记

👉Java全栈学习路线可参考：【Java全栈学习路线】最全的Java学习路线及知识清单，Java自学方向指引，内含最全Java全栈学习技术清单~
👉算法刷题路线可参考：算法刷题路线总结与相关资料分享，内含最详尽的算法刷题路线指南及相关资料分享~