如何在springboot中自定義Starter

本篇文章為大家展示了如何在springboot中自定義Starter，內容簡明扼要并且容易理解，絕對能使你眼前一亮，通過這篇文章的詳細介紹希望你能有所收獲。

自定義Starter命名規則

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

開發Starter步驟

• 創建Starter項目

• 定義Starter需要的配置（Properties）類

• 編寫自動配置類

• 編寫spring.factories文件加載自動配置類

• 編寫配置提示文件spring-configuration-metadata.json（不是必須的）

具體流程

創建配置類

@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;
 }
}

編寫自動配置類

• @EnableConfigurationProperties配置依賴的屬性類

• @ConditionalOnProperty 配置Configuration的加載規則

• value 指的是Properties的哪個字段

• havingValue指的是配置value是什么值的時候加載Configuration

• matchIfMissing 指的是當value配置的字段沒有配置時的默認值

• @Bean 配置自動注入的bean

• springboot特有的常見的條件依賴注解有：

• @ConditionalOnBean，僅在當前上下文中存在某個bean時，才會實例化這個Bean。

• @ConditionalOnClass，某個class位于類路徑上，才會實例化這個Bean。

• @ConditionalOnExpression，當表達式為true的時候，才會實例化這個Bean。

• @ConditionalOnMissingBean，僅在當前上下文中不存在某個bean時，才會實例化這個Bean。

• @ConditionalOnMissingClass，某個class在類路徑上不存在的時候，才會實例化這個Bean。

• @ConditionalOnNotWebApplication，不是web應用時才會實例化這個Bean。

• @AutoConfigureAfter，在某個bean完成自動配置后實例化這個bean。

• @AutoConfigureBefore，在某個bean完成自動配置前實例化這個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會默認掃描跟啟動類平級的包，如果我們的Starter跟啟動類不在同一個主包下，需要通過配置spring.factories文件來生效

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

上述內容就是如何在springboot中自定義Starter，你們學到知識或技能了嗎？如果還想學到更多技能或者豐富自己的知識儲備，歡迎關注億速云行業資訊頻道。