关于SpringBoot的spring.factories文件详细说明
前言
经常看到 spring.factories 文件，却没有对它进行深入的了解和分析，今天我们就一起揭开面纱看看它的内在。
spring.factories 文件是 Spring Boot 自动配置机制的核心部分之一。它位于每个 Spring Boot 自动配置模块的 META-INF 目录下，用于声明该模块提供的自动配置类、条件性配置类、环境后处理器等。以下是对 spring.factories 文件的详细说明：
相信大家的项目中都会写starter，我们团队写的国际化通用和通用聚合服务等即插即用的功能包，就是用的starter。那么就会自己声明spring.factories文件。
这是一种工厂加载机制（factory loading mechanism），也可说成是SPI机制。原理分析在Spring SPI与Java SPI、Dubbo SPI
Spring Boot jar包下的spring.factories文件也声明了一些组件，为方便我的阐述，我把它列在了附录中。我会按照 介绍作用、初始化时机 去做分析。
一、基本结构
spring.factories 文件是一个键值对的属性文件，键和值之间用等号（=）分隔，多个值之间用逗号（,）分隔。文件内容通常如下所示：
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.example.MyAutoConfiguration,\ com.example.AnotherAutoConfiguration org.springframework.boot.autoconfigure.condition.ConditionalOnClass=\ com.example.SomeClass org.springframework.context.ApplicationListener=\ com.example.MyApplicationListener
二、常见的键
EnableAutoConfiguration
EnableAutoConfiguration 是最常见的键，用于声明自动配置类。Spring Boot 会在启动时扫描这些类，并根据条件加载相应的配置。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.example.MyAutoConfiguration,\ com.example.AnotherAutoConfiguration
AutoConfigurationImportListener
AutoConfigurationImportListener 用于声明 AutoConfigurationImportListener 接口的实现类，这些类可以在自动配置类导入之前或之后执行一些逻辑。
org.springframework.boot.autoconfigure.AutoConfigurationImportListener=\ com.example.MyAutoConfigurationImportListener
AutoConfigurationImportFilter
AutoConfigurationImportFilter 用于声明 AutoConfigurationImportFilter 接口的实现类，这些类可以在自动配置类导入之前过滤掉一些不需要的配置类。
org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=\ com.example.MyAutoConfigurationImportFilter
org.springframework.boot.env.PropertySourceLoader
策略接口，用于加载PropertySource（配置）。实现有PropertiesPropertySourceLoader、YamlPropertySourceLoader。
初始化时机： 当ConfigFileApplicationListener收到ApplicationEnvironmentPreparedEvent事件时， 创建SourceLoader并执行load，加载配置。
org.springframework.boot.SpringApplicationRunListener
用于监听spring boot启动并作出相应处理。
Listener for the SpringApplication run method。
初始化时机： 在SpringApplication启动时进行初始化。
org.springframework.boot.SpringBootExceptionReporter
回调接口，用于对Spring Boot应用启动失败（发生异常）后，进行异常播报的组件。
初始化时机： 在SpringApplication启动时（创建完Application context后）进行初始化。
org.springframework.context.ApplicationContextInitializer
用于在刷新之前初始化Spring ConfigurableApplicationContext的回调接口。比如，servlet web容器会用该组件设置一些额外的属性。
初始化时机： Spring Application构造时创建。
org.springframework.context.ApplicationListener
用于监听事件并作处理。
初始化时机： Spring Application构造时创建。
org.springframework.boot.env.EnvironmentPostProcessor
在context刷新前可对environment进行修改的组件。
初始化时机： 在run listener发出ApplicationEnvironmentPreparedEvent事件后触发。
org.springframework.boot.diagnostics.FailureAnalyzer
分析错误，展示给用户诊断结果。
初始化时机： 在SpringApplication启动时（创建完Application context后）进行初始化。 伴随一个SpringBootExceptionReporter(即org.springframework.boot.diagnostics.FailureAnalyzers) 的实例化而实例化。
org.springframework.boot.diagnostics.FailureAnalysisReporter
在错误分析完成后，向用户展示结果。（Spring Boot默认实现是通过日志展示出来）
初始化时机： 在SpringApplication启动时（创建完Application context后）发生错误的情况下进行初始化。
spring boot包的spring.factories文件
# PropertySource Loaders org.springframework.boot.env.PropertySourceLoader=\ org.springframework.boot.env.PropertiesPropertySourceLoader,\ org.springframework.boot.env.YamlPropertySourceLoader # Run Listeners org.springframework.boot.SpringApplicationRunListener=\ org.springframework.boot.context.event.EventPublishingRunListener # Error Reporters org.springframework.boot.SpringBootExceptionReporter=\ org.springframework.boot.diagnostics.FailureAnalyzers # Application Context Initializers org.springframework.context.ApplicationContextInitializer=\ org.springframework.boot.context.ConfigurationWarningsApplicationContextInitializer,\ org.springframework.boot.context.ContextIdApplicationContextInitializer,\ org.springframework.boot.context.config.DelegatingApplicationContextInitializer,\ org.springframework.boot.web.context.ServerPortInfoApplicationContextInitializer # Application Listeners org.springframework.context.ApplicationListener=\ org.springframework.boot.ClearCachesApplicationListener,\ org.springframework.boot.builder.ParentContextCloserApplicationListener,\ org.springframework.boot.context.FileEncodingApplicationListener,\ org.springframework.boot.context.config.AnsiOutputApplicationListener,\ org.springframework.boot.context.config.ConfigFileApplicationListener,\ org.springframework.boot.context.config.DelegatingApplicationListener,\ org.springframework.boot.context.logging.ClasspathLoggingApplicationListener,\ org.springframework.boot.context.logging.LoggingApplicationListener,\ org.springframework.boot.liquibase.LiquibaseServiceLocatorApplicationListener # Environment Post Processors org.springframework.boot.env.EnvironmentPostProcessor=\ org.springframework.boot.cloud.CloudFoundryVcapEnvironmentPostProcessor,\ org.springframework.boot.env.SpringApplicationJsonEnvironmentPostProcessor,\ org.springframework.boot.env.SystemEnvironmentPropertySourceEnvironmentPostProcessor # Failure Analyzers org.springframework.boot.diagnostics.FailureAnalyzer=\ org.springframework.boot.diagnostics.analyzer.BeanCurrentlyInCreationFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.BeanDefinitionOverrideFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.BeanNotOfRequiredTypeFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.BindFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.BindValidationFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.UnboundConfigurationPropertyFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.ConnectorStartFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.NoSuchMethodFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.NoUniqueBeanDefinitionFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.PortInUseFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.ValidationExceptionFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.InvalidConfigurationPropertyNameFailureAnalyzer,\ org.springframework.boot.diagnostics.analyzer.InvalidConfigurationPropertyValueFailureAnalyzer # FailureAnalysisReporters org.springframework.boot.diagnostics.FailureAnalysisReporter=\ org.springframework.boot.diagnostics.LoggingFailureAnalysisReporter
三、自动配置类
以下是一个简单的自动配置类示例：
package com.example.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MyAutoConfiguration {
@Bean
public MyService myService() {
return new MyService();
}
}
条件性自动配置
package com.example.config;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@ConditionalOnClass(name = "com.example.SomeClass")
public class MyAutoConfiguration {
@Bean
public MyService myService() {
return new MyService();
}
}
以上就是关于SpringBoot的spring.factories文件详细说明的详细内容，更多关于SpringBoot spring.factories文件的资料请关注脚本之家其它相关文章！
相关文章
在Java中，工具类定义了一组公共方法，这篇文章将介绍Java中使用工具类来获取一个MP3音频文件的时间长度，感兴趣的同学继续往下阅读吧2021-10-10
MyBatis-Plus QueryWrapper及LambdaQueryWrapper的使用详解
这篇文章主要介绍了MyBatis-Plus QueryWrapper及LambdaQueryWrapper的使用详解，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-03-03
很多同学会重载和重写分不清楚，这篇文章主要介绍了详解java重载与覆写的区别，有需要的朋友可以了解一下。2016-11-11
SpringBoot2.x版本中,使用SpringSession踩的坑及解决
这篇文章主要介绍了SpringBoot2.x版本中,使用SpringSession踩的坑及解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-07-07
今天给大家带来的知识是关于Java的,文章围绕着Java中Collection的一些常用方法展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下2021-06-06
SpringBoot整合Mybatis-Plus实现微信注册登录的示例代码
微信是不可或缺的通讯工具,本文主要介绍了SpringBoot整合Mybatis-Plus实现微信注册登录的示例代码,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的可以了解一下2024-02-02
这篇文章主要介绍了Java线程池中的Future实现详解, FutureTask是一个任务,FutureTask继承了Runnable、Callable, 通过FutureTask可以获取到任务执行的状态,任务执行完成完成后,将结构通过Future接口返回,调用者可以调用Future#get()方法获取到数据,需要的朋友可以参考下2023-10-10
这篇文章主要介绍了Android 应用按返回键退向后台运行实例代码的相关资料,需要的朋友可以参考下2017-04-04
这篇文章主要介绍了Java中的WeakHashMap浅析,weakhashmap关键是：当一个对象被GC回收时,响应的值对象的引用从map中删除,weakhashmap能节约存储空间,来实现缓存那些非必要的数据,需要的朋友可以参考下2023-09-09
在JavaWeb项目中,有时候我们需要在运行时动态加载DLL文件（在Windows中是DLL,在Linux中是SO文件）,这通常用于实现一些特定的功能,比如调用本机代码或者使用某些特定于操作系统的API,本文将介绍如何在JavaWeb项目中动态加载DLL文件,需要的朋友可以参考下2024-12-12
最新评论