SpringBoot:如何書寫一個自定義的Enable*注解

Spring提供了一系列Enable*的自定義注解扼劈,這些注解本質上只是用于啟用spring boot管理的一些功能特性往枷,比如 [EnableWebMvc] 注解會激活提供基于springmvc的web功能支持登舞, [EnableAsync]注解會激活異步的功能支持贰逾。
我比較好奇這些自定義注解是如何工作的,進而促使我寫出這篇文章記錄我的理解逊躁,這些自定義注解的支持似踱,可以理解為SPI的一部分,如果后續(xù)的內部實現(xiàn)有變化稽煤,對應的支持可能會中斷核芽。

1.新建自定義的注解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface EnableCustomFeature {}

2.應用此注解到配置類

@Configuration
@EnableCustomFeature 
public class CustomFeatureConfig {}

3.這時候需要在EnableCustomFeature 類中通過@Import的方式引入一系列需要前置處理的Bean類

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(SomeBeanConfiguration.class)
@interface EnableCustomFeature {}

上述通過@Import方式做的原因,主要是將@Import標記的配置類中的bean作為ApplicationContext處理

@Configuration
class SomeBeanConfiguration {
 
    @Bean
    public String aBean1() {
        return "aBean1";
    }
 
    @Bean
    public String aBean2() {
        return "aBean2";
    }
}

使用Selector選擇器啟用Enable自定義注解

自定義Enable*注解也可以實現(xiàn)復雜的功能酵熙,可以通過的上下文啟用不同的bean實現(xiàn)功能轧简。在Springboot中@EnableCaching就是這樣的例子,可以通過不同的緩存實現(xiàn)來激活對應的bean配置匾二。

示例如下:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(SomeBeanConfigurationSelector.class)
public @interface EnableCustomFeatureSelector {
    String criteria() default "default";
}

上述示例中哮独,自定義的注解中有一個criteria自定義注解屬性字段,默認值為default察藐,后面我們需要做的就是根據(jù)criteria的值激活兩種不同的bean功能集合:

import org.springframework.context.annotation.ImportSelector;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.type.AnnotationMetadata;
 
public class SomeBeanConfigurationSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        AnnotationAttributes attributes =
                AnnotationAttributes.fromMap(
                        importingClassMetadata.getAnnotationAttributes(EnableSomeBeansSelector.class.getName(), false));
        String criteria = attributes.getString("criteria");
        if (criteria.equals("default")) {
            return new String[]{"enableannot.selector.SomeBeanConfigurationDefault"};
        }else {
            return new String[]{"enableannot.selector.SomeBeanConfigurationType1"};
        }
    }
}
 
@Configuration
class SomeBeanConfigurationType1 {
 
    @Bean
    public String aBean() {
        return "Type1";
    }
 
}
 
@Configuration
class SomeBeanConfigurationDefault {
 
    @Bean
    public String aBean() {
        return "Default";
    }
 

所以如果criteria字段值為 "default"皮璧,就會加載SomeBeanConfigurationDefault, 否則就是加載SomeBeanConfigurationType1分飞。

參考鏈接:http://www.java-allandsundry.com/2015/04/spring-enable-annotation-writing-custom.html

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末悴务,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子譬猫,更是在濱河造成了極大的恐慌讯檐,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,406評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件染服,死亡現(xiàn)場離奇詭異别洪,居然都是意外死亡,警方通過查閱死者的電腦和手機柳刮,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,732評論 3 393
  • 文/潘曉璐 我一進店門挖垛,熙熙樓的掌柜王于貴愁眉苦臉地迎上來痒钝,“玉大人,你說我怎么就攤上這事晕换∥缗遥” “怎么了?”我有些...
    開封第一講書人閱讀 163,711評論 0 353
  • 文/不壞的土叔 我叫張陵闸准,是天一觀的道長益愈。 經常有香客問我,道長夷家,這世上最難降的妖魔是什么蒸其? 我笑而不...
    開封第一講書人閱讀 58,380評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮库快,結果婚禮上摸袁,老公的妹妹穿的比我還像新娘。我一直安慰自己义屏,他們只是感情好靠汁,可當我...
    茶點故事閱讀 67,432評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著闽铐,像睡著了一般蝶怔。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上兄墅,一...
    開封第一講書人閱讀 51,301評論 1 301
  • 那天踢星,我揣著相機與錄音,去河邊找鬼隙咸。 笑死沐悦,一個胖子當著我的面吹牛,可吹牛的內容都是我干的五督。 我是一名探鬼主播藏否,決...
    沈念sama閱讀 40,145評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼充包!你這毒婦竟也來了秕岛?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,008評論 0 276
  • 序言:老撾萬榮一對情侶失蹤误证,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后修壕,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體愈捅,經...
    沈念sama閱讀 45,443評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,649評論 3 334
  • 正文 我和宋清朗相戀三年慈鸠,在試婚紗的時候發(fā)現(xiàn)自己被綠了蓝谨。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,795評論 1 347
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖譬巫,靈堂內的尸體忽然破棺而出咖楣,到底是詐尸還是另有隱情,我是刑警寧澤芦昔,帶...
    沈念sama閱讀 35,501評論 5 345
  • 正文 年R本政府宣布诱贿,位于F島的核電站,受9級特大地震影響咕缎,放射性物質發(fā)生泄漏珠十。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,119評論 3 328
  • 文/蒙蒙 一凭豪、第九天 我趴在偏房一處隱蔽的房頂上張望焙蹭。 院中可真熱鬧,春花似錦嫂伞、人聲如沸孔厉。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,731評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽撰豺。三九已至,卻和暖如春然磷,著一層夾襖步出監(jiān)牢的瞬間郑趁,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,865評論 1 269
  • 我被黑心中介騙來泰國打工姿搜, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留寡润,地道東北人。 一個月前我還...
    沈念sama閱讀 47,899評論 2 370
  • 正文 我出身青樓舅柜,卻偏偏與公主長得像梭纹,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子致份,可洞房花燭夜當晚...
    茶點故事閱讀 44,724評論 2 354

推薦閱讀更多精彩內容