springboot写一个自己的starter

最新推荐文章于 2024-07-11 18:41:25 发布

walkmiss

最新推荐文章于 2024-07-11 18:41:25 发布

阅读量570

点赞数

分类专栏： 2019年java面试文章标签： springboot源码 starter机制

本文链接：https://blog.csdn.net/huermiss/article/details/103567573

版权

2019年java面试专栏收录该内容

23 篇文章 1 订阅

订阅专栏

@SpringBootApplication注解中主要包含@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan三个注解。其中最重要的是@EnableAutoConfiguration注解，借助AutoConfigurationImportSelector，@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器。

借助于Spring框架原有的一个工具类：SpringFactoriesLoader的支持，@EnableAutoConfiguration可以智能的自动配置功效才得以大功告成！

在AutoConfigurationImportSelector类中可以看到通过 SpringFactoriesLoader.loadFactoryNames()
把 spring-boot-autoconfigure.jar/META-INF/spring.factories中每一个xxxAutoConfiguration文件都加载到容器中，spring.factories文件里每一个xxxAutoConfiguration文件一般都会有下面的条件注解:

@ConditionalOnClass ： classpath中存在该类时起效
@ConditionalOnMissingClass ： classpath中不存在该类时起效
@ConditionalOnBean ： DI容器中存在该类型Bean时起效
@ConditionalOnMissingBean ： DI容器中不存在该类型Bean时起效
@ConditionalOnSingleCandidate ： DI容器中该类型Bean只有一个或@Primary的只有一个时起效
@ConditionalOnExpression ： SpEL表达式结果为true时
@ConditionalOnProperty ：参数设置或者值一致时起效
@ConditionalOnResource ：指定的文件存在时起效
@ConditionalOnJndi ：指定的JNDI存在时起效
@ConditionalOnJava ：指定的Java版本存在时起效
@ConditionalOnWebApplication ： Web应用环境下起效
@ConditionalOnNotWebApplication ：非Web应用环境下起效

对于@EnableAutoConfiguration来说，SpringFactoriesLoader的用途稍微不同一些，其本意是为了提供SPI扩展的场景，而在@EnableAutoConfiguration场景中，它更多提供了一种配置查找的功能支持，即根据@EnableAutoConfiguration的完整类名org.springframework.boot.autoconfig.EnableAutoConfiguration作为查找的Key，获得对应的一组@Configuration类。

SpringFactoriesLoader是一个抽象类，类中定义的静态属性定义了其加载资源的路径public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories"，此外还有三个静态方法：

loadFactories：加载指定的factoryClass并进行实例化。
loadFactoryNames：加载指定的factoryClass的名称集合。
instantiateFactory：对指定的factoryClass进行实例化。

在loadFactories方法中调用了loadFactoryNames以及instantiateFactory方法。

loadFactories方法首先获取类加载器，然后调用loadFactoryNames方法获取所有的指定资源的名称集合、接着调用instantiateFactory方法实例化这些资源类并将其添加到result集合中。最后调用AnnotationAwareOrderComparator.sort方法进行集合的排序。

创建一个自己的starter，大致要分为以下几步。
1.新建一个XX-spring-boot-starter工程
2.引入maven依赖 spring-boot-autoconfigure spring-boot-configuration-processor
3.创建Properties类，该类就是一个接受配置的pojo，使用@ConfigurationProperties(prefix = "car")指定了接受配置文件参数的前缀
4.创建XXService类，该类是这个starter对外所提供的服务
5.创建XXAutoConfiguration自动配置类，@EnableConfigurationProperties(XXXProperties.class)，接收配置文件参数，
@configuration+@Bean+@ConditionalOnMissingBean(XXXService.class)结合初始化bean。
6.在resources\META-INF\文件夹下新建一个spring.factories文件，在文件中以key-value形式配置上面的自动配置类，key为@EnableAutoConfiguration的全路径限定名
7.打包