Spring Boot 自動(dòng)配置之條件注解

Spring Boot 神奇的自動(dòng)配置茸炒,主要依靠大量的條件注解來使用配置自動(dòng)化愕乎。

根據(jù)滿足某一個(gè)特定條件創(chuàng)建一個(gè)特定的Bean。比如說壁公,在某些系統(tǒng)變量下創(chuàng)建Bean感论,或者只有在某個(gè)Bean創(chuàng)建后才去創(chuàng)建另外一個(gè)Bean. 就是根據(jù)條件來控制Bean的創(chuàng)建行為,可以利用該特性來進(jìn)行一些自動(dòng)配置紊册。

一比肄、常用的條件注解

  • @Conditional 依賴的條件
  • @ConditionalOnBean 在某個(gè)Bean存在的條件下
  • @ConditionalOnMissingBean 在某個(gè)Bean不存在的條件下
  • @ConditionalOnClass 在某個(gè)Class存在的條件下
  • @ConditionalOnMissingClass 在某個(gè)Class不存在的條件下

比較常見的是這些注解,還有其它的比如
@ConditionalOnWebApplication,
@ConditionalOnProperty 等囊陡,可舉一反三

二芳绩、特別說明 @Conditional 注解

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {

    /**
     * All {@link Condition Conditions} that must {@linkplain Condition#matches match}
     * in order for the component to be registered.
     */
    Class<? extends Condition>[] value();

}

使用@Conditional注解,對象需要實(shí)現(xiàn)Condition接口撞反,Condition 接口是一個(gè)函數(shù)式接口

@FunctionalInterface
public interface Condition {

    boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
}

三妥色、條件注解示例

示例場景:項(xiàng)目中動(dòng)態(tài)的配置Mysql或者Oracle數(shù)據(jù)源

1. 定義配置文件

db-type=oracle

2. 定義Condition類

MySqlCondition.java

public class MySqlCondition implements Condition {

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return "mysql".equals(context.getEnvironment().getProperty("db-type"));
    }
}

OracleCondition.java

public class OracleCondition implements Condition {

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return "oracle".equals(context.getEnvironment().getProperty("db-type"));
    }
}

獲取配置文件db-type的值

3. JdbcFactory接口

public interface JdbcFactory {

    void create();
}

4. 默認(rèn)的Mysql和Oracle實(shí)現(xiàn)

Mysql

@ConditionalOnMissingBean(value = JdbcFactory.class, ignored = MySqlDefaultFactory.class)
@Conditional(MySqlCondition.class)
@Component
public class MySqlDefaultFactory implements JdbcFactory {

    @Override
    public void create() {
        System.out.println("Default MySql create ..");
    }

}

Oracle

@ConditionalOnMissingBean(value = JdbcFactory.class, ignored = OracleDefaultFactory.class)
@Conditional(OracleCondition.class)
@Component
public class OracleDefaultFactory implements JdbcFactory {

    @Override
    public void create() {
        System.out.println("Default oracle create..");
    }
}

5. 測試默認(rèn)實(shí)現(xiàn)方式

@Resource
private JdbcFactory jdbcFactory;

@Test
public void conditionOnMissBean() {
    jdbcFactory.create();
}

結(jié)果:

Default MySql create ..

6. 自定義實(shí)現(xiàn)方式

@Component
public class MysqlFactory implements JdbcFactory {

    @Override
    public void create() {
        System.out.println("mysql 。遏片。 create");
    }
}

7. 測試

@Resource
private JdbcFactory jdbcFactory;

@Test
public void conditionOnMissBean() {
    jdbcFactory.create();
}

結(jié)果:

mysql 垛膝。。 create

8.解析

當(dāng)環(huán)境中不存在 JdbcFactory 的Bean時(shí)則使用默認(rèn)的實(shí)現(xiàn)的方式丁稀,如例:沒有自定義實(shí)現(xiàn)時(shí)吼拥,則默認(rèn)使用MySqlDefaultFactory。這在自動(dòng)化配置中會經(jīng)常用到线衫。比如redisTemplate 的默認(rèn)實(shí)現(xiàn)

四凿可、GitHub源碼

源碼地址

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子枯跑,更是在濱河造成了極大的恐慌惨驶,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,718評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件敛助,死亡現(xiàn)場離奇詭異粗卜,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)纳击,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,683評論 3 385
  • 文/潘曉璐 我一進(jìn)店門续扔,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人焕数,你說我怎么就攤上這事纱昧。” “怎么了堡赔?”我有些...
    開封第一講書人閱讀 158,207評論 0 348
  • 文/不壞的土叔 我叫張陵识脆,是天一觀的道長。 經(jīng)常有香客問我善已,道長灼捂,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,755評論 1 284
  • 正文 為了忘掉前任换团,我火速辦了婚禮纵东,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘啥寇。我一直安慰自己偎球,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,862評論 6 386
  • 文/花漫 我一把揭開白布辑甜。 她就那樣靜靜地躺著衰絮,像睡著了一般。 火紅的嫁衣襯著肌膚如雪磷醋。 梳的紋絲不亂的頭發(fā)上猫牡,一...
    開封第一講書人閱讀 50,050評論 1 291
  • 那天,我揣著相機(jī)與錄音邓线,去河邊找鬼淌友。 笑死,一個(gè)胖子當(dāng)著我的面吹牛骇陈,可吹牛的內(nèi)容都是我干的震庭。 我是一名探鬼主播,決...
    沈念sama閱讀 39,136評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼你雌,長吁一口氣:“原來是場噩夢啊……” “哼器联!你這毒婦竟也來了二汛?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,882評論 0 268
  • 序言:老撾萬榮一對情侶失蹤拨拓,失蹤者是張志新(化名)和其女友劉穎肴颊,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體渣磷,經(jīng)...
    沈念sama閱讀 44,330評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡婿着,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,651評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了醋界。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片竟宋。...
    茶點(diǎn)故事閱讀 38,789評論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖物独,靈堂內(nèi)的尸體忽然破棺而出袜硫,到底是詐尸還是另有隱情氯葬,我是刑警寧澤挡篓,帶...
    沈念sama閱讀 34,477評論 4 333
  • 正文 年R本政府宣布,位于F島的核電站帚称,受9級特大地震影響官研,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜闯睹,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,135評論 3 317
  • 文/蒙蒙 一戏羽、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧楼吃,春花似錦始花、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,864評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至躬窜,卻和暖如春浇垦,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背荣挨。 一陣腳步聲響...
    開封第一講書人閱讀 32,099評論 1 267
  • 我被黑心中介騙來泰國打工男韧, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人默垄。 一個(gè)月前我還...
    沈念sama閱讀 46,598評論 2 362
  • 正文 我出身青樓此虑,卻偏偏與公主長得像,于是被迫代替她去往敵國和親口锭。 傳聞我的和親對象是個(gè)殘疾皇子寡壮,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,697評論 2 351

推薦閱讀更多精彩內(nèi)容