Spring Boot零配置启动原理

简介: Spring Boot零配置启动原理

在创建传统SpringMVC项目时,需要复杂的配置文件,例如:

1、web.xml,加载配置spring容器,配置拦截器

2、application.xml,配置扫描包,扫描业务类

3、springmvc.xml,扫描controller,视图解析器等

……

而Spring Boot为我们提供了一种极简的项目搭建方式,看一下Spring Boot项目的启动类:

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

简单的一行代码,即可启动一个Spring Boot程序,那么在实际运行中是如何做到零配置启动的呢?下面从源码角度进行分析

一、@SpringBootApplication

首先看一下@SpringBootApplication这个组合注解,除去元注解外,它还引入了其他三个重要的注解:

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan

1、@SpringBootConfiguration

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}

从源码可以看到,其实@SpringBootConfiguration并没有额外功能,它只是Spring中@Configuration的派生注解,用于标注配置类,完成Bean的配置与管理。

2、@ComponentScan

Spring中的注解,用于包的扫描,并把声明了特定注解的类交给spring的ioc容器。

3、@EnableAutoConfiguration

Spring Boot有中一个非常重要的理念就是约定大于配置。而自动配置这一机制的核心实现就是靠@EnableAutoConfiguration注解完成的。

image.png

可以看出,在@EnableAutoConfiguration注解中,使用@Import导入了AutoConfigurationImportSelector这个类,实现了ImportSelector接口的selectImports()方法。spring中会把selectImports()方法返回的String数组中的类的全限定名实例化为bean,并交给spring容器管理。

image.png

查看其中的getAutoConfigurationEntry方法:

image.png

在执行完getCandidateConfigurations后,把众多类的全限定名存储到了一个List中。

image.png

SpringFactoriesLoader这个类非常重要,属于Spring框架的一种扩展方案,提供一种了配置查找的功能支持。其主要功能就是读取配置文件META-INF/spring.factories,决定要加载哪些类。

image.png

当然,并不是所有spring.factories中的类都会被加载到spring容器中,很多情况下需要按照需求所需的情况引入,依赖条件注解@Conditional进行判断。例如ServletWebServerFactoryAutoConfiguration类:

image.png

只有在classpath下存在ServletRequest这一类时,才将ServletWebServerFactoryAutoConfiguration作为配置类导入spring容器中。

二、SpringApplication

SpringApplication提供了一个简单的方式以启动Spring boot程序,查看SpringApplication.run方法调用:

image.png

在此创建了一个SpringApplication的实例,并调用了它的run方法

image.png

在创建实例的过程中,完成了这几件事情:

设置资源加载器,用于将资源加载到加载器中

判断当前项目类型是什么?  提供了NONE,SERVLET,REACTIVE 三种类型备选

使用SpringFactoriesLoader查找并加载所有可用的ApplicationContextInitializer

使用SpringFactoriesLoader查找并加载所有可用的监听器ApplicationListener

推断并设置main方法的定义类

SpringApplication完成初始化后,调用run方法,下面对run方法中核心代码进行分析:

image.png

按照图中标注序号进行分析:

1、spring监听器的使用,要获取这些监听器的对象,就要知道其全路径。通过SpringFactoriesLoader查找spring.factories获得,之后再调用它们的started()方法。

2、 创建并配置当前Spring Boot应用将要使用的Environment,根据监听器和默认应用参数来准备所需要的环境。

3、打印Banner。

4、创建spring应用上下文。根据之前推断的项目类型,决定该为当前SpringBoot应用创建什么类型的ApplicationContext并创建完成。

5、准备应用上下文,首先将之前准备好的Environment设置给创建好的ApplicationContext使用。

然后遍历调用所有ApplicationContextInitializer的initialize方法来对已经创建好的ApplicationContext进行进一步的处理。

最后,遍历调用所有SpringApplicationRunListener的contextPrepared()方法。

6、这里最终调用了Spring中AbstractApplicationContext的refresh方法,可以说这个refresh方法是Spring中最重要的方法之一,完成了Bean工厂创建,后置管理器注册,Bean实例化等最重要的工作。这一步工作完成后,spring的ioc容器就完成了。

7、如果有Bean实现了CommandLineRunner接口并重写了run方法,则遍历执行CommandLineRunner中的方法。

三、Starter

Starter是Spring boot的核心思想之一,在使用spring boot来搭建项目时,往往只需要引入官方提供的starter,就可以直接使用,而不用再进行复杂的配置工作。

一方面,是前面说过的通过动态spi扩展可以直接从starter的META-INF/spring.factories中决定什么类将被实例化为bean交给spring容器管理。另一方面,starter的父pom中往往已经包含了需要导入的依赖,以mybatis-spring-boot-starter这一starter为例,点开后可以看见它已经将依赖的坐标全部为我们导入了。

image.png

总的来说,使用starter可以完成以下功能:

1、启用功能,注意不是实现功能

2、依赖管理,starter帮我们引入需要的所有依赖

讲完了关于starter的原理,下面讲讲如何构造一个自己的starter。官方为我们提供了一个命名规范,建议第三方starter命名应当遵循thirdpart-spring-boot-starter这一格式,那我们就来手写一个my-spring-boot-starter,通过这个过程来学习如何完成属性的配置。

1、创建一个maven的普通project,在pom中添加parent节点

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

2、引入自动装配的依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
    </dependency>
</dependencies>

3、实现自己的功能需求

public class SayhiImpl implements ISayhi {
    @Autowired
    MyProperties properties;
    @Override
    public void welcome() {
        String name=properties.getName();
        System.out.println(name+" hello spring boot");
    }
}

如果希望能够在其他项目中使用的时候,通过yml或property文件对这个属性进行赋值,就要写一个对属性进行赋值操作的类,并使用@ConfigurationProperties注解

@ConfigurationProperties("spring.sayhi")
public class MyProperties {
    private String name="";
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

4、如果希望上面开发的功能在springboot启动的时候就加入项目进行管理,就需要有一个代表当前starer自动装配的类

@Configuration
@ConditionalOnClass
//使配置文件生效
@EnableConfigurationProperties(MyProperties.class)
public class MyAutoConfiguration {
    @Bean
    //条件注解,仅当ioc容器中不存在指定类型的bean时,才会创建bean
    @ConditionalOnMissingBean
    public ISayhi sayhi(){
        return new SayhiImpl();
    }
}

5、在resources创建META-INF,创建spring.factories文件,在里面写入:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.test.MyAutoConfiguration

6、使用maven打包

mvn clean install

测试工程:

1、新建一个测试工程,在pom文件中引入上面打包的坐标

<dependency>
    <groupId>com.test</groupId>
    <artifactId>my-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

2、使用yml进行属性的配置

spring:
  sayhi:
    name: hydra

3、运行测试

@SpringBootApplication
public class TestApplication implements CommandLineRunner {
    @Autowired
    private ISayhi sayhi;
    public static void main(String[] args) {
        SpringApplication application=new SpringApplication(TestApplication.class);
        application.run(args);
    }
    @Override
    public void run(String... args) throws Exception {
        sayhi.welcome();
    }
}

结果:

image.png

如果在之前为name设置了默认值,那么在不在yml中对name进行配置的话就会打印默认值。这也就是为什么springboot在启动tomcat时会自动为我们设置为8080端口的原因,从这再一次体现了“约定大于配置”这一理念。

相关文章
|
10天前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
136 73
|
11天前
|
Java 数据库连接 Maven
最新版 | 深入剖析SpringBoot3源码——分析自动装配原理(面试常考)
自动装配是现在面试中常考的一道面试题。本文基于最新的 SpringBoot 3.3.3 版本的源码来分析自动装配的原理,并在文未说明了SpringBoot2和SpringBoot3的自动装配源码中区别,以及面试回答的拿分核心话术。
最新版 | 深入剖析SpringBoot3源码——分析自动装配原理(面试常考)
|
10天前
|
Java Spring
【Spring配置相关】启动类为Current File,如何更改
问题场景:当我们切换类的界面的时候,重新启动的按钮是灰色的,不能使用,并且只有一个Current File 项目,下面介绍两种方法来解决这个问题。
|
10天前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
10天前
|
Java Spring
【Spring配置】创建yml文件和properties或yml文件没有绿叶
本文主要针对,一个项目中怎么创建yml和properties两种不同文件,进行配置,和启动类没有绿叶标识进行解决。
|
18天前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
68 14
|
16天前
|
XML Java 数据格式
Spring容器Bean之XML配置方式
通过对以上内容的掌握,开发人员可以灵活地使用Spring的XML配置方式来管理应用程序的Bean,提高代码的模块化和可维护性。
53 6
|
18天前
|
XML Java 数据格式
🌱 深入Spring的心脏:Bean配置的艺术与实践 🌟
本文深入探讨了Spring框架中Bean配置的奥秘,从基本概念到XML配置文件的使用,再到静态工厂方式实例化Bean的详细步骤,通过实际代码示例帮助读者更好地理解和应用Spring的Bean配置。希望对你的Spring开发之旅有所助益。
80 3
|
2月前
|
Java 开发者 Spring
Spring AOP 底层原理技术分享
Spring AOP(面向切面编程)是Spring框架中一个强大的功能,它允许开发者在不修改业务逻辑代码的情况下,增加额外的功能,如日志记录、事务管理等。本文将深入探讨Spring AOP的底层原理,包括其核心概念、实现方式以及如何与Spring框架协同工作。
|
2月前
|
Java 容器
springboot自动配置原理
启动类@SpringbootApplication注解下,有三个关键注解 (1)@springbootConfiguration:表示启动类是一个自动配置类 (2)@CompontScan:扫描启动类所在包外的组件到容器中 (3)@EnableConfigutarion:最关键的一个注解,他拥有两个子注解,其中@AutoConfigurationpackageu会将启动类所在包下的所有组件到容器中,@Import会导入一个自动配置文件选择器,他会去加载META_INF目录下的spring.factories文件,这个文件中存放很大自动配置类的全类名,这些类会根据元注解的装配条件生效,生效