springboot自定義Starter過程的示例分析

小編給大家分享一下springboot自定義Starter過程的示例分析，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

自定義Starter命名規(guī)則

注意artifactId的命名規(guī)則，Spring官方Starter通常命名為spring-boot-starter-{name}如 spring-boot-starter-web， Spring官方建議非官方Starter命名應(yīng)遵循{name}-spring-boot-starter的格式, 如mybatis-spring-boot-starter。這里創(chuàng)建的項(xiàng)目的artifactId為helloworld-spring-boot-starter

開發(fā)Starter步驟

創(chuàng)建Starter項(xiàng)目  定義Starter需要的配置（Properties）類  編寫自動(dòng)配置類  編寫spring.factories文件加載自動(dòng)配置類  編寫配置提示文件spring-configuration-metadata.json（不是必須的）

具體流程

創(chuàng)建配置類

@ConfigurationProperties 來定義配置的前綴

@EnableConfigurationProperties(InfluxdbProperties.class)@ConfigurationProperties(prefix = "spring.influxdb")public class InfluxdbProperties { private String username; public String getDatabase() {   return database; } public void setDatabase(String database) {   this.database = database; }}

編寫自動(dòng)配置類

@EnableConfigurationProperties配置依賴的屬性類  @ConditionalOnProperty 配置Configuration的加載規(guī)則      value 指的是Properties的哪個(gè)字段    havingValue指的是配置value是什么值的時(shí)候加載Configuration    matchIfMissing 指的是當(dāng)value配置的字段沒有配置時(shí)的默認(rèn)值      @Bean 配置自動(dòng)注入的bean  springboot特有的常見的條件依賴注解有：      @ConditionalOnBean，僅在當(dāng)前上下文中存在某個(gè)bean時(shí)，才會(huì)實(shí)例化這個(gè)Bean。    @ConditionalOnClass，某個(gè)class位于類路徑上，才會(huì)實(shí)例化這個(gè)Bean。    @ConditionalOnExpression，當(dāng)表達(dá)式為true的時(shí)候，才會(huì)實(shí)例化這個(gè)Bean。    @ConditionalOnMissingBean，僅在當(dāng)前上下文中不存在某個(gè)bean時(shí)，才會(huì)實(shí)例化這個(gè)Bean。    @ConditionalOnMissingClass，某個(gè)class在類路徑上不存在的時(shí)候，才會(huì)實(shí)例化這個(gè)Bean。    @ConditionalOnNotWebApplication，不是web應(yīng)用時(shí)才會(huì)實(shí)例化這個(gè)Bean。    @AutoConfigureAfter，在某個(gè)bean完成自動(dòng)配置后實(shí)例化這個(gè)bean。    @AutoConfigureBefore，在某個(gè)bean完成自動(dòng)配置前實(shí)例化這個(gè)bean。

@Configuration@Order(1)@EnableConfigurationProperties(InfluxdbProperties.class)@ConditionalOnClass(InfluxdbProperties.class)@ConditionalOnProperty(prefix = "spring.influxdb", value = "use-influxdb", havingValue="true" ,matchIfMissing = false)public class InfluxdbAutoConfiguration {private String scanEntitySuffix = "Entity.class";@Bean@ConditionalOnMissingBean(AiInfluxdbTemplate.class)@Order(Ordered.HIGHEST_PRECEDENCE)public AiInfluxdbTemplate AiInfluxdbTemplate(InfluxdbProperties influxdbProperties){  return new AiInfluxdbTemplate(influxdbProperties);}}

編寫spring.factories文件

Spring Boot會(huì)默認(rèn)掃描跟啟動(dòng)類平級(jí)的包，如果我們的Starter跟啟動(dòng)類不在同一個(gè)主包下，需要通過配置spring.factories文件來生效

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\com.ai.base.boot.influxdb.InfluxdbAutoConfiguration

以上是“springboot自定義Starter過程的示例分析”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對(duì)大家有所幫助，如果還想學(xué)習(xí)更多知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！