springboot相較于spring的一大優(yōu)點就是提供給我們開箱即用的一些組件，例如spring-starter依賴溶锭。它內(nèi)部引入相關(guān)組件的jar包，并且封裝了一些默認(rèn)配置趴捅。讓我們在開發(fā)業(yè)務(wù)時能夠?qū)Ｗ⒂跇I(yè)務(wù)的編寫而不必過多的關(guān)注框架的配置垫毙。
springboot-starter的原理
我們使用spring組件的時候拱绑，例如redis综芥，只需將對應(yīng)的spring-boot-starter-redis通過pom引入即可猎拨，不用自己去查找、引入一系列所需的依賴類迟几。同時消请，SpringBoot會自動進(jìn)行類的自動配置类腮，并將相關(guān)的Bean注入Spring Conxtex中。
首先蚜枢，SpringBoot 在啟動時會去依賴的starter包中尋找 resources/META-INF/spring.factories文件缸逃，然后根據(jù)文件中配置去掃描項目所依賴的Jar包厂抽，這類似于 Java 的 SPI 機(jī)制。
第二步筷凤，根據(jù) spring.factories配置加載AutoConfigure類昭殉。
最后藐守，根據(jù)@Conditional注解的條件挪丢，進(jìn)行自動配置并將Bean注入Spring Context 上下文當(dāng)中卢厂。
我們也可以使用@ImportAutoConfiguration({MyServiceAutoConfiguration.class})指定自動配置哪些類。
實現(xiàn)
第一步創(chuàng)建一個SpringBoot項目慎恒，添加兩個依賴項目中
<dependencies>
<!--負(fù)責(zé)從properties文件中讀取配置信息-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<version>2.1.5.RELEASE</version>
</dependency>
<!--實現(xiàn)自動化配置-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>2.1.3.RELEASE</version>
</dependency>
</dependencies>
其中spring-boot-configuration-processor 的作用是編譯時生成spring-configuration-metadata.json ，此文件主要給IDE使用融柬。如當(dāng)配置此jar相關(guān)配置屬性在 application.yml死嗦，你可以用ctlr+鼠標(biāo)左鍵點擊屬性名粒氧，IDE會跳轉(zhuǎn)到你配置此屬性的類中越走。
我們?nèi)粘Ｊ褂玫腟pring官方的Starter一般采取spring-boot-starter-{name}的命名方式，如 spring-boot-starter-web 。
而非官方的Starter门怪，官方建議 artifactId 命名應(yīng)遵循{name}-spring-boot-starter的格式骡澈。 例如：ysc-spring-boot-starter 掷空。
<groupId>com.dy</groupId>
<artifactId>zcl-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>
編寫三個重要的類
- Service類
該類實現(xiàn)具體的功能，包含一個能夠?qū)⑴渲梦募信渲玫淖址鶕?jù)傳入的字符進(jìn)行分割的方法String[] split(String separatorChar)坦弟。
public class StarterService {
private String config;
public StarterService(String config) {
this.config = config;
}
public String[] split(String splitChar) {
return config.split(splitChar);
}
}
- 配置文件讀取類
@ConfigurationProperties("example.service")
public class StarterServiceProperties {
private String config;
public void setConfig(String config) {
this.config = config;
}
public String getConfig() {
return config;
}
}
- AutoConfigure類
@Configuration
@ConditionalOnClass(StarterService.class)
@EnableConfigurationProperties(StarterServiceProperties.class)
public class StarterAutoConfigure {
@Autowired
private StarterServiceProperties properties;
@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(prefix = "example.service", value = "enabled", havingValue = "true")
StarterService starterService (){
return new StarterService(properties.getConfig());
}
}
@ConditionalOnClass护锤，當(dāng)classpath下發(fā)現(xiàn)該類的情況下進(jìn)行自動配置StarterService酿傍。
@ConditionalOnMissingBean，當(dāng)Spring Context中不存在該Bean時赤炒。
@ConditionalOnProperty(prefix = "example.service",value = "enabled",havingValue = "true")氯析，當(dāng)配置文件中example.service.enabled=true時莺褒，執(zhí)行該方法。
在resources/META-INF/下創(chuàng)建spring.factories文件
這里注意改為你自己的包名
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zcl.StarterAutoConfigure
發(fā)布
使用mvn install打包安裝
測試
引入starter
<dependency>
<groupId>com.dy</groupId>
<artifactId>zcl-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
在application.yml中編寫配置文件
example:
service:
enabled: true
config: gsdf, fd, fasd
配置junit4進(jìn)行測試
@RunWith(value = SpringJUnit4ClassRunner.class)
//這里App類為springboot的啟動類
@SpringBootTest(classes = {App.class})
public class MyTest {
@Autowired
private StarterService starterService;
@Test
public void starterTest() {
String[] splitArray = starterService.split(",");
System.out.println(Arrays.toString(splitArray));
}
}
結(jié)果
[gsdf, fd, fasd]
