我们之前写的HelloSpringBoot,到底是怎么运行的呢,Maven项目,我们一般从 pom.xml文件探究起。
SpringBoot2.3.3版本的官网文档说明:https://docs.spring.io/spring-boot/docs/current/reference/html/
1、pom.xml
父依赖
其中它主要是依赖一个父项目,主要是管理项目的资源过滤及插件。
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
点进去,发现还有一个父依赖【核心依赖】
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>2.3.3.RELEASE</version>
</parent>
这里才是真正管理 SpringBoot 应用里面所有依赖版本的地方,SpringBoot 的版本控制中心。
以后我们导入依赖默认是不需要写版本;但是如果导入的包没有在依赖中管理着就需要手动配置版本了。
启动器 spring-boot-starter
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
springboot-boot-starter-xxx:就是 spring-boot 的场景启动器
spring-boot-starter-web:帮我们导入了web模块正常运行所依赖的组件。
SpringBoot 将所有的功能场景都抽取出来,做成一个个的starter(启动器),只需要在项目中引入这些 starter 即可,所有相关的依赖都会导入进来 , 我们要用什么功能就导入什么样的场景启动器即可。我们也可以自己自定义 starter。
2、主启动类
默认的主启动类
// @SpringBootApplication 来标注一个主程序类,
// 说明这是一个Spring Boot应用
@SpringBootApplication
public class SpringbootApplication {
public static void main(String[] args) {
// 以为是启动了一个方法,没想到启动了一个服务
SpringApplication.run(SpringbootApplication.class, args);
}
}
但是一个简单的启动类并不简单,我们来分析一下这些注解都干了什么。
注解结构分析
这里我们展示比较重要的注解。
后面有更详细的流程图!
@SpringBootApplication
作用:标注在某个类上说明这个类是SpringBoot的主配置类,SpringBoot 就应该运行这个类的 main 方法来启动 SpringBoot 应用。
进入这个注解:可以看到上面还有很多其他注解!
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
excludeFilters = {@Filter(
type = FilterType.CUSTOM,
classes = {TypeExcludeFilter.class}
), @Filter(
type = FilterType.CUSTOM,
classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
// ......
}
@ComponentScan
这个注解在 Spring 中很重要,它对应XML配置中的元素。
作用:自动扫描并加载符合条件的组件或者 bean,将这个 bean 定义加载到 IOC 容器中。
@SpringBootConfiguration
作用:SpringBoot 的配置类,标注在某个类上 , 表示这是一个SpringBoot的配置类;
我们继续点进去这个注解查看:
// 点进去得到下面的 @Component
@Configuration
public @interface SpringBootConfiguration {}
@Component
public @interface Configuration {}
这里的 @Configuration,说明这是一个配置类,配置类就是对应Spring的 xml 配置文件。
里面的 @Component 这就说明,启动类本身也是 Spring 中的一个组件而已,负责启动应用。
我们回到 SpringBootApplication 注解中继续看。
@EnableAutoConfiguration
@EnableAutoConfiguration :开启自动配置功能
以前我们需要自己配置的东西,而现在 SpringBoot 可以自动帮我们配置 。@EnableAutoConfiguration告诉 SpringBoot 开启自动配置功能,这样自动配置才能生效。
点进这个注解继续查看:
@AutoConfigurationPackage :自动配置包
@Import({Registrar.class})
public @interface AutoConfigurationPackage {
}
@Import :Spring 底层注解 @Import , 给容器中导入一个组件。
Registrar.class 作用:将主启动类的所在包及包下面所有子包里面的所有组件扫描到Spring容器。
这个分析完了,退到上一步,继续看。
@Import({AutoConfigurationImportSelector.class}) :给容器导入组件
AutoConfigurationImportSelector :自动配置导入选择器,那么它会导入哪些组件的选择器呢?我们点击去这个类看源码:
List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
1、这个类中有一个这样的方法
// 获得候选的配置
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
//这里的getSpringFactoriesLoaderFactoryClass()方法
//返回的就是我们最开始看的启动自动导入配置文件的注解类;EnableAutoConfiguration
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;
}
protected Class<?> getSpringFactoriesLoaderFactoryClass() {
return EnableAutoConfiguration.class;
}
2、这个方法又调用了 SpringFactoriesLoader 类的静态方法!我们进入SpringFactoriesLoader类loadFactoryNames() 方法
public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {
String factoryClassName = factoryClass.getName();
//这里它又调用了 loadSpringFactories 方法
return (List)loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
}
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 所有自动配置都是在启动的时候扫描并加载:spring.factories
所有的自动配置类都在这里面,但是不一定生效,要判断条件是否成立,只要导入了对应的 start,就有对应的启动器了,有了启动器,我们自动装配就会生效,然后就配置成功。
- SpringBoot 在启动的时候,从类路径下的 META-INF/spring.factories 中获取EnableAutoConfiguration 指定的值;
- 将这些值作为自动配置类导入容器 , 自动配置类就生效 , 帮我们进行自动配置工作;
- 以前我们需要自动配置的东西,现在springboot 帮我们做了;
- 整合 JavaEE,解决方案和自动配置的东西都在
spring-boot-autoconfigure-2.3.3.RELEASE.jar
这个包下; - 它会把所有需要导入的组件,以类名的方式返回,这些组件就会被添加到容器;
- 容器中也会存在非常多的
xxxAutoConfiguration
的文件(@Bean),就是这些类给容器中导入了这个场景需要的所有组件,并自动配置;@Configuration ,JavaConfig。 - 有了自动配置类,免去了我们手动编写配置文件的工作。
现在大家应该大概的了解了下,SpringBoot的运行原理,后面我们还会深化一次!
run方法流程分析
最初以为就是运行了一个main方法,没有想到却启动一个服务;
@SpringBootApplication
public class SpringbootHelloworldApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootHelloworldApplication.class, args);
}
}
SpringApplication.run分析
分析该方法主要分为两部分,一部分是 SpringApplication 的实例化,二是 run方法的执行;
SpringApplication
这个类主要做了以下四件事:
- 推断应用的类型是普通的项目还是Web项目
- 查代并加载所有可用初始化器,设 置到initialzers属性中
- 找出所有的应用程序监听器,设置到llsteners属性中
- 推断并设置main方法的定义类,找到运行的主类
查看构造器
public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) {
this.sources = new LinkedHashSet();
this.bannerMode = Mode.CONSOLE;
this.logStartupInfo = true;
this.addCommandLineProperties = true;
this.addConversionService = true;
this.headless = true;
this.registerShutdownHook = true;
this.additionalProfiles = new HashSet();
this.isCustomEnvironment = false;
this.lazyInitialization = false;
this.resourceLoader = resourceLoader;
Assert.notNull(primarySources, "PrimarySources must not be null");
this.primarySources = new LinkedHashSet(Arrays.asList(primarySources));
this.webApplicationType = WebApplicationType.deduceFromClasspath();
this.setInitializers(this.getSpringFactoriesInstances(ApplicationContextInitializer.class));
this.setListeners(this.getSpringFactoriesInstances(ApplicationListener.class));
this.mainApplicationClass = this.deduceMainApplicationClass();
}
run
如果有收获!!! 希望老铁们来个三连,点赞、收藏、转发。
创作不易,别忘点个赞,可以让更多的人看到这篇文章,顺便鼓励我写出更好的博客