springBoot 之spring.factories扩展机制示例解析
作者:算子
引言
这个月准备写完Spring源码解析系列文章。我相信大多点进来看的同学们都应该或多或少对springBoot的扩展机制有一些了解,我们这次通过八股文归纳法和源码浅层解析,达到大家对SpringBoot扩展的机制的理解。全文看完大概三分钟,希望大家都有收获,毕竟艺多不压身,知其然知其所以然。
在Spring Boot中,我们通常会看到一些源码包的META-INF下又一个文件spring.factories
。大家都知道它是一种扩展机制,有的同学可能在其他博客中看到把它称之为Spring Boot SPI
。为什么这么称谓呢,后续我专门分享一篇Java SPI。那么到底它是如何实现spring Boot的扩展的呢。在本文中,我们将深入探讨这种扩展机制的底层源代码实现,以及我们在源码上标注注释的形式,共同揭开Spring.factories 的神秘面纱。
1. spring.factories八股总结
如果只是需要应付面试或者只是想大概了解,看完此章节就可以了
1.1 spring.factories文件格式
在分析spring.factories的底层实现之前,我们需要了解spring.factories文件的格式。spring.factories文件是一个标准的Properties文件,其中键是要扩展的类型的全限定名,值是要注册的bean的全限定名。
例如
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.example.MyAutoConfiguration。
1.2 SpringFactoriesLoader类
SpringFactoriesLoader是一个实用类,它用于加载spring.factories文件并注册bean定义。以下是SpringFactoriesLoader类的源代码: loadFactory方法首先使用传递的Class对象的名称作为键调用loadFactories方法来获取已注册bean的全限定名列表。然后,它使用Java 8的Stream API将全限定名列表映射到相应的Class对象,并使用反射通过无参数构造函数实例化每个Class对象。最后,它将实例化的对象收集到一个List对象中并返回。
1.3 loadFactories方法
loadFactories方法是SpringFactoriesLoader类的私有方法,它接收一个要扩展的类型的Class对象和一个ClassLoader对象,并返回一个包含所有已注册bean的List对象loadFactories方法首先使用传递的Class对象的名称作为键从缓存Map中获取已注册bean的全限定名列表。
如果缓存中没有,则使用传递的ClassLoader对象从classpath中获取所有spring.factories文件的URL,并使用PropertiesLoaderUtils类加载每个文件中的Properties对象。
对于每个Properties对象,它获取与传递的Class对象的名称相对应的属性值, 在Spring Boot中,spring.factories
是一个非常重要的配置文件,它用于实现Spring Boot的自动化配置。这个文件位于META-INF/spring.factories
路径下,通常可以在项目的classpath下找到。
spring.factories
文件的格式如下所示:
# Auto Configuration org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.example.MyAutoConfiguration
这个文件中定义了一个名为org.springframework.boot.autoconfigure.EnableAutoConfiguration
的属性,它的值是一个类的完全限定名,即com.example.MyAutoConfiguration
。这个类通常是一个Spring配置类,用于定义一些自动化配置。
Spring Boot在启动时会扫描classpath中的所有spring.factories
文件,并读取其中定义的属性。然后,它会根据这些属性值加载对应的类,并将它们注册到Spring的ApplicationContext中。
好吧,如上所示是Spring Boot中spring.factories
的底层源码解析: 整个加载过程我们可以大致分为5步
.
你也可以理解为咱们整理的为了方便记忆八股文吧
- Spring Boot通过
SpringFactoriesLoader
类来加载spring.factories
文件。这个类是Spring框架中的一个工具类,用于加载classpath下的所有spring.factories
文件,并将它们的内容存储在一个Map<String, List<String>>
对象中。 - Spring Boot使用
SpringFactoriesLoader.loadFactoryNames
方法来加载指定属性名的所有实现类。这个方法会从步骤1中加载的Map<String, List<String>>
对象中获取对应属性名的实现类列表。 - Spring Boot使用
SpringFactoriesLoader.loadFactories
方法来加载指定属性名的所有实现类的实例。这个方法会遍历步骤2中获取的实现类列表,并使用反射机制实例化每一个类。 - Spring Boot会将步骤3中实例化的类注册为Spring的Bean。它会调用
AnnotationConfigUtils.registerAnnotationConfigProcessors
方法来注册自动配置类。这个方法会调用BeanDefinitionRegistryPostProcessor
接口的实现类的postProcessBeanDefinitionRegistry
方法,来注册自动配置类的BeanDefinition。 - Spring Boot会启动Spring的ApplicationContext,并让它自动扫描所有的Bean。它会调用
AnnotationConfigApplicationContext.refresh
方法来启动ApplicationContext,并让它自动扫描所有的Bean。在扫描过程中,Spring会发现步骤4中注册的自动配置类,并尝试自动配置应用程序。
/** * SpringFactoriesLoader类是Spring框架中的一个工具类,用于加载classpath下的所有spring.factories文件, * 并将它们的内容存储在一个Map<String, List<String>>对象中。 */ public final class SpringFactoriesLoader { /** * 私有构造函数,不允许实例化。 */ private SpringFactoriesLoader() { } /** * 加载指定属性名的所有实现类的类名列表。 * @param factoryType 属性名 * @param classLoader 类加载器 * @return 类名列表 */ public static List<String> loadFactoryNames(Class<?> factoryType, ClassLoader classLoader) { // ... } /** * 加载指定属性名的所有实现类的实例。 * @param factoryType 属性名 * @param classLoader 类加载器 * @param <T> 实现类的类型 * @return 实现类的实例列表 */ public static <T> List<T> loadFactories(Class<T> factoryType, ClassLoader classLoader) { // 省略 ... } }
/** * AnnotationConfigUtils类提供了一些用于处理注解配置的工具方法。 */ class AnnotationConfigUtils { /** * 注册自动配置类。 * @param registry Bean定义注册器 */ public static void registerAnnotationConfigProcessors(BeanDefinitionRegistry registry) { // ... } }
/** * AnnotationConfigApplicationContext类是Spring的ApplicationContext接口的一个实现类, * 用于支持基于Java配置的应用程序上下文。 */ public class AnnotationConfigApplicationContext extends GenericApplicationContext implements AnnotationConfigRegistry { /** * 启动ApplicationContext,并让它自动扫描所有的Bean。 */ @Override public void refresh() throws BeansException, IllegalStateException { // ... } }
好了,今天的内容就到这儿了,每天写点东西整理和总结。谢谢大家的阅读。放弃很容易但坚持一定很酷。一起加油
更多关于springBoot spring.factories扩展的资料请关注脚本之家其它相关文章!
您可能感兴趣的文章:
- Spring中的spring.factories文件用法(Spring如何加载第三方Bean)
- springboot自动配置原理以及spring.factories文件的作用详解
- springboot 加载 META-INF/spring.factories方式
- SpringBoot借助spring.factories文件跨模块实例化Bean
- 关于SpringBoot3.x中spring.factories功能被移除的解决方案
- SpringBoot spring.factories加载时机分析
- SpringBoot 自动扫描第三方包及spring.factories失效的问题解决
- SpringBoot3.x中spring.factories SPI 服务发现机制的改变问题小结
- SpringBoot之spring.factories的使用方式
- 在SpringBoot3中spring.factories配置不起作用的原因和解决方法
- 浅谈spring.factories文件的作用