本文是接上文IDEA环境下springboot快速入门项目的分析
1.pom文件
1.1父项目
查看pom文件有如下代码:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.1.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.1.1.RELEASE</version>
<relativePath>../../spring-boot-dependencies</relativePath>
</parent>
点击查看其父项目,摘录部分代码如下:
<properties>
<activemq.version>5.15.8</activemq.version>
<antlr2.version>2.7.7</antlr2.version>
<appengine-sdk.version>1.9.68</appengine-sdk.version>
<artemis.version>2.6.3</artemis.version>
<aspectj.version>1.9.2</aspectj.version>
<assertj.version>3.11.1</assertj.version>
<!-- ...-->
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot</artifactId>
<version>2.1.1.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-test</artifactId>
<version>2.1.1.RELEASE</version>
</dependency>
</dependencies>
<!-- ...-->
</dependencyManagement>
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.johnzon</groupId>
<artifactId>johnzon-maven-plugin</artifactId>
<version>${johnzon.version}</version>
</plugin>
<plugin>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-maven-plugin</artifactId>
<version>${kotlin.version}</version>
</plugin>
<!-- ...-->
</plugins>
</pluginManagement>
</build>
1.2 pom文件导入的依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
- spring-boot-starter-web
- spring-boot-starter:spring-boot场景启动器,帮我们导入了web模块正常运行所依赖的组件
- web:代表web模块,如果需要其他模块,也就导入相应的spring-boot-starter-xxx模块即可
- spring-boot-starter-test:同上,test代表test模块
SpringBoot将所有的功能场景都抽取出来,做成一个个的starter(启动器),只需要在项目里面引入这些,starter相关场景的所有依赖都会导入进来。要用什么功能就导入什么场景的启动器。
2.项目源码分析
2.1主程序类
package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @SpringBootApplication用来标注一个主程序类,说明这是一个SpringBoot应用
*/
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
@SpringBootApplication:标注在某个类上,说明该应用是一个SpringBoot应用,这个类是SpringBoot的主配置类,SpringBoot就应该运行这个类main方法来启动SpringBoot应用。
点击查看@SpringBootApplication,以下是其部分源码:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
}
可见@SpringBootApplication是一个组合注解,其中:
- @SpringBootConfiguration:SpringBoot的配置类
- @EnableAutoConfiguration:开启自动配置功能,以前我们需要配置的东西,SpringBoot帮我们自动配置。
点击查看@SpringBootConfiguration源码,部分如下:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}
- @Configuration:配置类注解
回到@SpringBootApplication源码
点击查看@EnableAutoConfiguration源码,部分如下:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
- @AutoConfigurationPackage:自动配置包
- @Import(AutoConfigurationImportSelector.class):AutoConfigurationImportSelector为导入哪些组件的选择器
点击查看@AutoConfigurationPackage源码,部分如下:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
}
- @Import(AutoConfigurationPackages.Registrar.class):Spring底层注解,给容器中导入一个组件,导入的组件由AutoConfigurationPackages.Registrar指定。
点击查看AutoConfigurationPackages.Registrar源码,如下:
static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
@Override
public void registerBeanDefinitions(AnnotationMetadata metadata,
BeanDefinitionRegistry registry) {
register(registry, new PackageImport(metadata).getPackageName());
}
@Override
public Set<Object> determineImports(AnnotationMetadata metadata) {
return Collections.singleton(new PackageImport(metadata));
}
}
断点调试查看可知,参数metadata为注解元信息,计算new PackageImport(metadata).getPackageName()表达式的结果为:com.example.demo
可见:这里将主配置类(@SpringBootApplication标注的类)所在包及其子包下的所有组件扫描到Spring容器中。
回到@EnableAutoConfiguration源码
点击查看AutoConfigurationImportSelector类的源码,有如下方法:
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
.loadMetadata(this.beanClassLoader);
AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(
autoConfigurationMetadata, annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
这里将需要导入的组件的全类名以String数组的方式返回,这些组件就会被添加到容器中,最终会给容器中导入非常多的AutoConfigurationMetadata(自动配置元数据):就是给容器中导入这个场景需要的所有组件,并配置好这些组件。有了自动配置类,就免去了我们手动编写配置注入功能组件等的工作。
可以看到AutoConfigurationMetadata导入的自动配置类
可知,SpringBoot在启动的时候从类路径下的META-INF/spring.factories中获取AutoConfigurationMetadata指定的值,将这些值作为自动配置类导入到容器中。
关于SpringBootApplication总结:
- @SpringBootApplication:说明该应用是一个SpringBoot应用
- @SpringBootConfiguration:SpringBoot应用基本配置
- @Configuration:配置类注解
- @EnableAutoConfiguration:
- @AutoConfigurationPackage:
- @Import(AutoConfigurationPackages.Registrar.class):将主配置类(@SpringBootApplication标注的类)所在包及其子包下的所有组件扫描到Spring容器中。
- @Import(AutoConfigurationImportSelector.class):自动给容器中导入场景所需要的所有组件,并配置好这些组件。
- @AutoConfigurationPackage:
- @SpringBootConfiguration:SpringBoot应用基本配置