您好,登錄后才能下訂單哦!
本篇文章給大家分享的是有關(guān)springboot中要如何自定義Starter,小編覺(jué)得挺實(shí)用的,因此分享給大家學(xué)習(xí),希望大家閱讀完這篇文章后可以有所收獲,話不多說(shuō),跟著小編一起來(lái)看看吧。
自定義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
開(kāi)發(fā)Starter步驟
創(chuàng)建Starter項(xiàng)目
定義Starter需要的配置(Properties)類
編寫自動(dòng)配置類
編寫spring.factories文件加載自動(dòng)配置類
編寫配置提示文件spring-configuration-metadata.json(不是必須的)
具體流程
創(chuàng)建配置類
@ConfigurationProperties 來(lái)定義配置的前綴
@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配置的字段沒(méi)有配置時(shí)的默認(rèn)值
@Bean 配置自動(dòng)注入的bean
springboot特有的常見(jiàn)的條件依賴注解有:
@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è)主包下,需要通過(guò)配置spring.factories文件來(lái)生效
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.ai.base.boot.influxdb.InfluxdbAutoConfiguration
以上就是springboot中要如何自定義Starter,小編相信有部分知識(shí)點(diǎn)可能是我們?nèi)粘9ぷ鲿?huì)見(jiàn)到或用到的。希望你能通過(guò)這篇文章學(xué)到更多知識(shí)。更多詳情敬請(qǐng)關(guān)注億速云行業(yè)資訊頻道。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。