簡(jiǎn)單自定義spring boot啟動(dòng)器starter

1.引入依賴

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
    </parent>

    <modelVersion>4.0.0</modelVersion>
    <groupId>com.d4c.study</groupId>
    <artifactId>starter-demo-spring-boot-starter</artifactId>
    <version>1.0.0.RELEASE</version>


    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
    </dependencies>

</project>

因?yàn)槭莝pring Boot啟動(dòng)器,所以要指定parent為:

  <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
    </parent>

spring-boot-configuration-processor

spring-boot-configuration-processor的作用是編譯時(shí)生成 spring-configuration-metadata.json 伪阶,此文件主要給IDE使用。如當(dāng)配置此jar相關(guān)配置屬性在 application.yml ,你可以用ctlr+鼠標(biāo)左鍵點(diǎn)擊屬性名境析,IDE會(huì)跳轉(zhuǎn)到你配置此屬性的類中义矛。
我們?nèi)粘J褂玫腟pring官方的Starter一般采取spring-boot-starter-{name} 的命名方式,如 spring-boot-starter-web 。
而非官方的Starter吝羞,官方建議 artifactId 命名應(yīng)遵循{name}-spring-boot-starter 的格式兰伤。 例如:mybatis-spring-boot-starter 。

spring-boot-autoconfigure
spring-boot-autoconfigure主要是要用到其中的一些注解

2.定義屬性類钧排,用于讀取敦腔,接受配置文件中的值

package com.d4c.starter.autoconfigure;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("simple.string")
public class SimpleProperties {
    private String value;

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }
}

@ConfigurationProperties與@EnableConfigurationProperties配合使用,實(shí)現(xiàn)了配置文件的讀取恨溜,與引入符衔。

3.定義功能實(shí)現(xiàn)類

package com.d4c.starter.autoconfigure;


public class StringResolvedBean {
    private String config;

    public StringResolvedBean(String config) {
        this.config = config;
    }

    public String[] split(String separatorChar) {
        return config.split(separatorChar);
    }
}


4.自動(dòng)配置類

package com.d4c.starter.autoconfigure;

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnClass(StringResolvedBean.class)
@EnableConfigurationProperties(SimpleProperties.class)
public class SimpleStringAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean
    @ConditionalOnProperty(prefix = "simple.string", value = "enabled", havingValue = "true")
    StringResolvedBean starterInit(SimpleProperties simpleProperties) {
        return new StringResolvedBean(simpleProperties.getValue());
    }
}

4.1 有關(guān)條件的注解

@ConditionalOnBean:當(dāng)容器中有指定的Bean的條件下
@ConditionalOnClass:當(dāng)類路徑下有指定的類的條件下
@ConditionalOnExpression:基于SpEL表達(dá)式作為判斷條件
@ConditionalOnJava:基于JVM版本作為判斷條件
@ConditionalOnJndi:在JNDI存在的條件下查找指定的位置
@ConditionalOnMissingBean:當(dāng)容器中沒有指定Bean的情況下
@ConditionalOnMissingClass:當(dāng)類路徑下沒有指定的類的條件下
@ConditionalOnNotWebApplication:當(dāng)前項(xiàng)目不是Web項(xiàng)目的條件下
@ConditionalOnProperty:指定的屬性是否有指定的值
@ConditionalOnResource:類路徑下是否有指定的資源
@ConditionalOnSingleCandidate:當(dāng)指定的Bean在容器中只有一個(gè),或者在有多個(gè)Bean的情況下糟袁,用來(lái)指定首選的Bean @ConditionalOnWebApplication:當(dāng)前項(xiàng)目是Web項(xiàng)目的條件下

5.創(chuàng)建spring.factories

在resources/META-INF/下創(chuàng)建spring.factories文件判族,并添加如下內(nèi)容:
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.d4c.starter.autoconfigure.SimpleStringAutoConfiguration

6.項(xiàng)目路徑參考

image.png

7.打包到本地倉(cāng)庫(kù)

#切到項(xiàng)目根目錄,執(zhí)行mvn命令
mvn install

8.其他本地項(xiàng)目就可以maven dependency引入了

<dependency>
        <groupId>com.d4c.study</groupId>
        <artifactId>starter-demo-spring-boot-starter</artifactId>
        <version>1.0.0.RELEASE</version>
</dependency>

application.yml

server:
  port: 6011
simple:
  string:
    enabled: true
    value: 12,aa,bb,cc

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末系吭,一起剝皮案震驚了整個(gè)濱河市五嫂,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌肯尺,老刑警劉巖沃缘,帶你破解...
    沈念sama閱讀 211,948評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異则吟,居然都是意外死亡槐臀,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,371評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門氓仲,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)水慨,“玉大人,你說(shuō)我怎么就攤上這事敬扛∥鳎” “怎么了?”我有些...
    開封第一講書人閱讀 157,490評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵啥箭,是天一觀的道長(zhǎng)谍珊。 經(jīng)常有香客問我,道長(zhǎng)急侥,這世上最難降的妖魔是什么砌滞? 我笑而不...
    開封第一講書人閱讀 56,521評(píng)論 1 284
  • 正文 為了忘掉前任,我火速辦了婚禮坏怪,結(jié)果婚禮上贝润,老公的妹妹穿的比我還像新娘。我一直安慰自己铝宵,他們只是感情好打掘,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,627評(píng)論 6 386
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般胧卤。 火紅的嫁衣襯著肌膚如雪唯绍。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,842評(píng)論 1 290
  • 那天枝誊,我揣著相機(jī)與錄音,去河邊找鬼惜纸。 笑死叶撒,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的耐版。 我是一名探鬼主播祠够,決...
    沈念sama閱讀 38,997評(píng)論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼粪牲!你這毒婦竟也來(lái)了古瓤?” 一聲冷哼從身側(cè)響起热康,我...
    開封第一講書人閱讀 37,741評(píng)論 0 268
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤睦焕,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后茧吊,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體亭引,經(jīng)...
    沈念sama閱讀 44,203評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡绎速,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,534評(píng)論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了焙蚓。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片纹冤。...
    茶點(diǎn)故事閱讀 38,673評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖购公,靈堂內(nèi)的尸體忽然破棺而出萌京,到底是詐尸還是另有隱情,我是刑警寧澤宏浩,帶...
    沈念sama閱讀 34,339評(píng)論 4 330
  • 正文 年R本政府宣布知残,位于F島的核電站,受9級(jí)特大地震影響绘闷,放射性物質(zhì)發(fā)生泄漏橡庞。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,955評(píng)論 3 313
  • 文/蒙蒙 一印蔗、第九天 我趴在偏房一處隱蔽的房頂上張望扒最。 院中可真熱鬧,春花似錦华嘹、人聲如沸吧趣。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,770評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)强挫。三九已至岔霸,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間俯渤,已是汗流浹背呆细。 一陣腳步聲響...
    開封第一講書人閱讀 32,000評(píng)論 1 266
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留八匠,地道東北人絮爷。 一個(gè)月前我還...
    沈念sama閱讀 46,394評(píng)論 2 360
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像梨树,于是被迫代替她去往敵國(guó)和親坑夯。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,562評(píng)論 2 349