一.Spring Boot Starter简介
Starter是Spring Boot中的一个非常重要的概念,Starter相当于模块,它能将模块所需的依赖整合起来并对模块内的Bean根据环境( 条件)进行自动配置。使用者只需要依赖相应功能的Starter,无需做过多的配置和依赖,Spring Boot就能自动扫描并加载相应的模块。
例如在Maven的依赖中加入spring-boot-starter-web就能使项目支持Spring MVC,并且Spring Boot还为我们做了很多默认配置,无需再依赖spring-web、spring-webmvc等相关包及做相关配置就能够立即使用起来。
二.Starter的开发步骤
编写Starter非常简单,与编写一个普通的Spring Boot应用没有太大区别,总结如下:
11.新建Maven项目,在项目的POM文件中定义使用的依赖; 22.新建配置类,写好配置项和默认的配置值,指明配置项前缀; 33.新建自动装配类,使用@Configuration和@Bean来进行自动装配; 44.新建spring.factories文件,指定Starter的自动装配类;
三.Starter的开发示例
下面,我就以创建一个自动配置来讲一下各个步骤及细节。
1.新建Maven项目,在项目的POM文件中定义使用的依赖。
1<dependencies> 2 <dependency> 3 <groupId>org.springframework.boot</groupId> 4 <artifactId>spring-boot-configuration-processor</artifactId> 5 <optional>true</optional> 6 </dependency> 7 8 <dependency> 9 <groupId>org.springframework.boot</groupId> 10 <artifactId>spring-boot-autoconfigure</artifactId> 11 </dependency> 12 </dependencies>
2.新建配置类,写好配置项和默认的配置值,指明配置项前缀。
1@ConfigurationProperties("example.service") 2public class StarterServiceProperties { 3 4 private String config; 5 6 private boolean enabled; 7 8 public void setConfig(String config) { 9 this.config = config; 10 } 11 12 public String getConfig() { 13 return config; 14 } 15 16 public boolean isEnabled() { 17 return enabled; 18 } 19 20 public void setEnabled(boolean enabled) { 21 this.enabled = enabled; 22 } 23}
指定配置项前缀为
example.service,各配置项均有默认值,默认值可以通过模块使用者的配置文件进行覆盖。
3.新建自动装配类,使用[@Configuration](https://my.oschina.net/pointdance) 和[@Bean](https://my.oschina.net/bean) 来进行自动装配。
1@Configuration 2@EnableConfigurationProperties(StarterServiceProperties.class) 3public class StarterAutoConfigure { 4 5 /*** * 注意:构建SpringBoot项目时候会自动增加plugin 工具,starter 不需要boot启动类 * 如果install 时报错和工具相关,需要删除plugin相关配置 */ 6 7 @Autowired 8 private StarterServiceProperties properties; 9 10 @Bean 11 @ConditionalOnMissingBean(StarterService.class) 12 @ConditionalOnProperty(prefix = "example.service", value = "enabled", havingValue = "true") 13 StarterService starterService (){ 14 StarterService starterService = new StarterService(); 15 starterService.setConfig(properties.getConfig()); 16 return starterService; 17 } 18}
4.新建spring.factories文件,指定Starter的自动装配类。
1# 配置自动注入的类 2org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.bootstarter.StarterAutoConfigure
spring.factories文件位于resources/META-INF目录下,需要手动创建;
org.springframework.boot.autoconfigure.EnableAutoConfiguration后面的类名说明了自动装配类,如果有多个 ,则用逗号分开;
使用者应用(SpringBoot)在启动的时候,会通过org.springframework.core.io.support.SpringFactoriesLoader读取classpath下每个Starter的spring.factories文件,加载自动装配类进行Bean的自动装配;
至此,整个Starter开发完毕,Deploy到中央仓库或Install到本地仓库后即可使用
四.Starter的使用
1.创建Maven项目,依赖刚才发布的es-starter包。
1<dependencies> 2 <dependency> 3 <groupId>org.springframework.boot</groupId> 4 <artifactId>spring-boot-starter</artifactId> 5 </dependency> 6 7 <!-- 依赖自定义starter --> 8 <dependency> 9 <groupId>com</groupId> 10 <artifactId>boot-starter</artifactId> 11 <version>0.0.1-SNAPSHOT</version> 12 </dependency> 13</dependencies>
只需依赖刚才开发的es-starter即可
2.根据要求进行配置
1# starter 配置文件 2example.service.config = abc-des-dde,SSS-DRS-RE,SDR-SDFR-XXX 3example.service.enabled = false
3.编写应用程序启动类。
1// 根据example.service.enabled 参数配置是否进行自动装配 2@Component 3@ConditionalOnExpression("${example.service.enabled:true}") 4public class ServiceTest implements ApplicationRunner { 5 6 @Autowired 7 private StarterService starterService; 8 9 @Override 10 public void run(ApplicationArguments args) throws Exception { 11 System.out.println(Arrays.toString(starterService.split(","))); 12 } 13}
5.运行程序测试
1 . ____ _ __ _ _ 2 /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ 3( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ 4 \\/ ___)| |_)| | | | | || (_| | ) ) ) ) 5 ' |____| .__|_| |_|_| |_\__, | / / / / 6 =========|_|==============|___/=/_/_/_/ 7 :: Spring Boot :: (v2.1.7.RELEASE) 8 92019-08-29 14:28:27.061 INFO 9844 --- [ main] com.demo.BootDemoApplication : Starting BootDemoApplication on Kerwin with PID 9844 (C:\Users\Administrator\Desktop\Codes\KerwinBoots\boot-demo\target\classes started by Administrator in C:\Users\Administrator\Desktop\Codes\KerwinBoots) 102019-08-29 14:28:27.064 INFO 9844 --- [ main] com.demo.BootDemoApplication : No active profile set, falling back to default profiles: default 112019-08-29 14:28:28.317 INFO 9844 --- [ main] com.demo.BootDemoApplication : Started BootDemoApplication in 1.733 seconds (JVM running for 2.975) 12[abc-des-dde, SSS-DRS-RE,SDR-SDFR-XXX]
运行程序,观察控制台输出: 源码可见: https://github.com/kkzhilu/KerwinBoots | boot_starter 分支