3.自动配置原理初探
3.1pom.xml
-
Spring-boot-dependencies:核心依赖在父工程中
-
我们在写或者引入springboot依赖的时候，不需要指定版本，因为有这些版本仓库
启动器
<!--启动器-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>-
启动器：说白了就是Springboot的启动场景
-
比如：spring-boot-starter-web，它会帮助我们自动导入web环境所有的依赖
-
springboot会将所有的功能场景，都变成一个个启动器
-
我们要使用什么功能，就需要找到对应的启动器starter
3.2主程序
//标注这个类是一个springboot的应用
@SpringBootApplication
public class SpringbootStudyApplication {
public static void main(String[] args) {
//将springboot应用启动
SpringApplication.run(SpringbootStudyApplication.class, args);
}
}在这个里面最重要的就是@SpringBootApplication这个注解了让我们点进去看看，发现他是一个派生注解
而这个注解也是一个派生注解，其中关键的功能由@Import提供，其导入的AutoConfigurationImportSelector的方法 selectImports---->getAutoConfigurationEntry---->getCandidateConfigurations---->loadFactoryNames---->loadSpringFactories（Enumeration urls = classLoader.getResources("META-INF/spring.factories")）扫描所有具有META-INF/spring.factories的jar包。spring-boot-autoconfigure-x.x.x.x.jar里就有一个这样的spring.factories文件。
注解
//springboot的配置
@SpringBootConfiguration
//spring配置类
@Configuration
//说明这也是一个spring的组件
@Component
//自动配置
@EnableAutoConfiguration
//自动配置包(扫描包中类的注释 @Service,@Controller...)
@AutoConfigurationPackage
//引入配置类，把注释注册在Registrar
@Import(AutoConfigurationPackages.Registrar.class)
//自动配置导入选择
@Import(AutoConfigurationImportSelector.class)
//获得所有配置
List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置：
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
List<String> configurations = new ArrayList<>(
SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader()));
ImportCandidates.load(AutoConfiguration.class, getBeanClassLoader()).forEach(configurations::add);
Assert.notEmpty(configurations,
"No auto configuration classes found in META-INF/spring.factories nor in META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports. If you "
+ "are using a custom packaging, make sure that file is correct.");
return configurations;
}但是**一个简单的启动类并不简单！**我们来分析一下这些注解都干了什么
3.3@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 {
// ......
}3.3.1@ComponentScan
这个注解在spring中很重要，它对应XML配置中的元素。（）
作用：自动扫描并加载符合条件的组件或者bean，将这个bean定义加载到IOC容器
相当于
<!--扫描@Service注释-->
<context:component-scan base-package="com.kuang.controller"/>3.3.2@SpringBootConfiguration
作用：SpringBoot的配置类 ，标注在某个类上 ， 表示这是一个SpringBoot的配置类；
我们继续进去这个注解查看
//点进去得到下面的 @Component
@Configuration
public @interface SpringBootConfiguration {}
@Component
public @interface Configuration {}这里的@Configuration，说明这是一个配置类，配置类就是对应Spring的XML配置文件
里面的@Component说明：启动类本身也是Spring中的一个组价，负责启动应用！！
我们回到 SpringBootApplication 注解中继续看，而在这些个注解中最重要的就是
@EnableAutoConfiguration，我们继续点进去看，在这些个注解中最重要的就是@EnableAutoConfiguration，我们继续点进去看
3.4@EnableAutoConfiguration
@EnableAutoConfiguration：开启自动配置功能
以前我们需要自己配置的东西，SpringBoot可以自动帮我们配置；@EnableAutoConfiguration告诉SpringBoot开启自动配置功能，这样自动配置才能 生效
点进注释继续查看
3.4.1@AutoConfigurationPackage
翻译：自动配置包
@Import(AutoConfigurationPackages.Registrar.class)
//利用Registrar导入一系列组价
//将指定的一个包下的所有组件导入进来？是主程序所在的包下
public @interface AutoConfigurationPackage {}@Import：Spring底层注解@Import，给容器中导入一个组件
Registrar.class 作用：将主启动类所在包及下面所有子包（或主启动类同级目录）里面所有组件扫描到Spring容器；
这个分析完了，退到上一步，继续看
3.4.2@Import({AutoConfigurationImportSelector.class})
给容器导入组件：
这个注释也是一个派生注解，其中的关键功能由@Import提供，其导入的AutoConfigurationImportSelector的selectImports()方法通过loadSpringFactories方法中的classLoader.getResources("META-INF/spring.factories");扫描所有具有META-INF/spring.factories的jar包。spring-boot-autoconfigure-x.x.x.x.jar里就有一个这样的spring.factories文件。
AutoConfigurationImportSelector：自动配置导入选择器，那么它会导入那些组件的 选择器呢，我们去点击这个类看源码
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;
}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-boot一启动就要给容器中加载的所有配置类
我们根据源头打开spring.factories ， 看到了很多自动配置的文件；这就是自动配置根源所在！ 这个spring.factories文件也是一组一组的key=value的形式，其中一个key是EnableAutoConfiguration类的全类名，而它的value是一个xxxxAutoConfiguration的类名的列表，这些类名以逗号分隔，如下图所示：
# Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,\
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener
# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.autoconfigure.BackgroundPreinitializer
# Environment Post Processors
org.springframework.boot.env.EnvironmentPostProcessor=\
org.springframework.boot.autoconfigure.integration.IntegrationPropertiesEnvironmentPostProcessor
# Auto Configuration Import Listeners
org.springframework.boot.autoconfigure.AutoConfigurationImportListener=\
org.springframework.boot.autoconfigure.condition.ConditionEvaluationReportAutoConfigurationImportListener
# Auto Configuration Import Filters
org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=\
org.springframework.boot.autoconfigure.condition.OnBeanCondition,\
org.springframework.boot.autoconfigure.condition.OnClassCondition,\
org.springframework.boot.autoconfigure.condition.OnWebApplicationCondition
# Failure analyzers
org.springframework.boot.diagnostics.FailureAnalyzer=\
org.springframework.boot.autoconfigure.data.redis.RedisUrlSyntaxFailureAnalyzer,\
org.springframework.boot.autoconfigure.diagnostics.analyzer.NoSuchBeanDefinitionFailureAnalyzer,\
org.springframework.boot.autoconfigure.flyway.FlywayMigrationScriptMissingFailureAnalyzer,\
org.springframework.boot.autoconfigure.jdbc.DataSourceBeanCreationFailureAnalyzer,\
org.springframework.boot.autoconfigure.jdbc.HikariDriverConfigurationFailureAnalyzer,\
org.springframework.boot.autoconfigure.jooq.NoDslContextBeanFailureAnalyzer,\
org.springframework.boot.autoconfigure.r2dbc.ConnectionFactoryBeanCreationFailureAnalyzer,\
org.springframework.boot.autoconfigure.r2dbc.MissingR2dbcPoolDependencyFailureAnalyzer,\
org.springframework.boot.autoconfigure.r2dbc.MultipleConnectionPoolConfigurationsFailureAnalzyer,\
org.springframework.boot.autoconfigure.r2dbc.NoConnectionFactoryBeanFailureAnalyzer,\
org.springframework.boot.autoconfigure.session.NonUniqueSessionRepositoryFailureAnalyzer
# Template availability providers
org.springframework.boot.autoconfigure.template.TemplateAvailabilityProvider=\
org.springframework.boot.autoconfigure.freemarker.FreeMarkerTemplateAvailabilityProvider,\
org.springframework.boot.autoconfigure.mustache.MustacheTemplateAvailabilityProvider,\
org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAvailabilityProvider,\
org.springframework.boot.autoconfigure.thymeleaf.ThymeleafTemplateAvailabilityProvider,\
org.springframework.boot.autoconfigure.web.servlet.JspTemplateAvailabilityProvider
# DataSource initializer detectors
org.springframework.boot.sql.init.dependency.DatabaseInitializerDetector=\
org.springframework.boot.autoconfigure.flyway.FlywayMigrationInitializerDatabaseInitializerDetector
# Depends on database initialization detectors
org.springframework.boot.sql.init.dependency.DependsOnDatabaseInitializationDetector=\
org.springframework.boot.autoconfigure.batch.JobRepositoryDependsOnDatabaseInitializationDetector,\
org.springframework.boot.autoconfigure.quartz.SchedulerDependsOnDatabaseInitializationDetector,\
org.springframework.boot.autoconfigure.session.JdbcIndexedSessionRepositoryDependsOnDatabaseInitializationDetector这个@EnableAutoConfiguration注解通过@SpringBootApplication被间接的标记在了Spring Boot的启动类上。在SpringApplication.run(…)的内部就会执行selectImports()方法，找到所有JavaConfig自动配置类的全限定名对应的class，然后将所有自动配置类加载到Spring容器中。
WebMvcAutoConfiguration
可以看到这些一个个都是JavaConfig配置类，而且都注入了一些Bean，可以找一些自己认识的类，熟悉一下
所以，自动配置真正实现是从classpath中搜寻所有的META-INF/spring.factories配置文件，并将其中对应的org.springframework.boot.autoconfigure.下的配置项，通过反射实例化为对应标注了@ConfigurationJavaConfig形式的IOC容器配置类，然后将这些都汇总称为一个实例并加载到IOC容器中。
3.5自动配置生效
每一个XxxxAutoConfiguration自动配置类都是在某些条件下才会生效的，这些条件限制在SpringBoot以注释的形式体现，常见的条件注释有如下几项：
@ConditionalOnBean：当容器里有指定的bean的条件下。
@ConditionalOnMissingBean：当容器里不存在指定bean的条件下。
@ConditionalOnClass：当类路径下有指定类的条件下。
@ConditionalOnMissingClass：当类路径下不存在指定类的条件下。
@ConditionalOnProperty：指定的属性是否有指定的值，比如@ConditionalOnProperties(prefix=”xxx.xxx”, value=”enable”, matchIfMissing=true)，代表当xxx.xxx为enable时条件的布尔值为true，如果没有设置的情况下也为true。
3.6例子
以ServletWebServerFactoryAutoConfiguration配置类为例，解释一下 全局配置文件中的属性如何生效，比如：server.port=8081，是如何生效的（当然不配置也会有默认值，这个默认值来自于org.apache.catalina.startup.Tomcat）。
@AutoConfiguration
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
@ConditionalOnClass(ServletRequest.class)
@ConditionalOnWebApplication(type = Type.SERVLET)
@EnableConfigurationProperties(ServerProperties.class)
@Import({ ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class,
ServletWebServerFactoryConfiguration.EmbeddedTomcat.class,
ServletWebServerFactoryConfiguration.EmbeddedJetty.class,
ServletWebServerFactoryConfiguration.EmbeddedUndertow.class })
public class ServletWebServerFactoryAutoConfiguration {
在ServletWebServerFactoryAutoConfiguration类上，有一个@EnableConfigurationProper注释：开启配置属性，而它后面的参数是一个ServerProperties类，这就是约定大于配置的最终落点。
@ConfigurationProperties(pref}ix = "server", ignoreUnknownFields = true)
public class ServerProperties {
/**
* Server HTTP port.
*/
private Integer port;
}3.7结论
springboot所有的自动配置都是在启动的时候扫描并加载，扫描了spring.factories配置文件，所有的自动配置类都在这里，但是不一定生效，因为要判断条件是否成立，只要导入了对应的starter，有对应的启动器我们自动装配就会生效，然后就配置成功
步骤：
1.SpringBoot在启动的时候从类路径下的META-INF/spring.factories中获取EnableAutoConfiguration指定的值；
2.将这些值作为自动配置类导入容器，自动配置类生效，帮我们进行自动配置工作；
3.以前需要我们配置 的文件，springboot帮我们配置了！
4.J2EE的整体解决方案和自动配置都在springboot-autoconfigure的jar包中；
5.它会给容器导入非常多的自动配置类（xxxAutoConfiguration）@Bean，就是给容器中导入这个场景需要 的所有组件，并配置好这些组件 @Configuration；
6.有了知道配置类 ， 免去了我们手动编写配置注入功能组件等的工作；
SpringApplication
我们最初以为就是运行了一个main方法，没想到却开启了一个服务；
//@SpringBootApplication 来标注一个主程序类
// 说明这是一个Spring Boot应用
@SpringBootApplication
public class Springboot01HelloworldApplication {
//以为是启动了一个方法，没想到启动了一个服务
public static void main(String[] args) {
SpringApplication.run(Springboot01HelloworldApplication.class, args);
}
}
SpringApplication.run分析
分析该方法主要分两部分，一部分是SpringApplication的实例化，二是run方法的执行；
SpringApplication
这个类主要做了以下四件事情：
1、推断应用的类型是普通的项目还是Web项目
2、查找并加载所有可用初始化器 ， 设置到initializers属性中
3、找出所有的应用程序监听器，设置到listeners属性中
4、推断并设置main方法的定义类，找到运行的主类
查看构造器：
public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) {
// ......
this.webApplicationType = WebApplicationType.deduceFromClasspath();
this.setInitializers(this.getSpringFactoriesInstances();
this.setListeners(this.getSpringFactoriesInstances(ApplicationListener.class));
this.mainApplicationClass = this.deduceMainApplicationClass();
}
关于springboot，谈谈你的理解：
springboot的自动装配
run()：
①判断当前项目是普通项目还是web项目
②推断并设置main方法的定义类，找到运行的主类
③run方法里面有一些监听器，这些监听器是全局存在的，它的作用是获取上下文处理一些bean，所有的bean无论是加载还是生产初始化多存在。
————————————————
版权声明：本文为CSDN博主「郭圣_Guo」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/qq_41978509/article/details/116104434
1188
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
