Springboot項目中 如何獲取@Configuration注解標(biāo)注的配置類

  • 整個springboot并沒有在spring的基礎(chǔ)上提供什么額外的功能琐鲁。

    從開發(fā)人員的角度來看,springBoot的最大作用就是引入某些jar包后人灼,自動為spring上下文環(huán)境生成某些特定功能的Bean围段,這樣就可以自動提供某些相關(guān)功能。

  • 從實現(xiàn)的角度來看投放,spring通過被標(biāo)記了@Configuration的類提供一些提前生成好的Bean提供特別的功能奈泪,而用@Contional系列的注解限制生成的條件,通常就是@ConditionalOnClass和@ConditionalOnMissingBean注解的配合使用。前者確定某些功能需要的class已經(jīng)有了涝桅,后者確定你沒有自己生成相關(guān)的bean拜姿,才提供默認(rèn)的。

  • 可以使用@AutoConfigureBefore冯遂,@AutoConfigureAfter,@AutoconfigureOrder 來確定某個自動注冊類的生效順序。作用類比@Order容为。

  • 自動注冊一般提供2個module:一個是autoconfigure jar包瘤礁,一個是starter jar包。其中starter這種jar里面并沒有代碼裸准,是空的儒洛。唯一的作用是將需要的各種jar寫入構(gòu)建文件,這樣引入此starter狼速,就不要再去關(guān)心相應(yīng)的其他jar了琅锻。

    springboot自己的starter實現(xiàn)是這么干的。

    SpringCloudNetflixZuul是將這兩者統(tǒng)一于一個module中來實現(xiàn)的

?

主要分成以下三個場景:

  1. @Configuration配置類在程序可以掃描到的package里向胡,也就是@ComponentScan注解所指定的package里恼蓬。SpringBoot工程天然支持該類配置類注入方式。

    最佳實踐:

    最佳實踐
    //@SpringBootApplication注解中含有@ComponentScan
    1 @SpringBootApplication
    2 public class Application {
    3     public static void main(String[] args) {
    4         SpringApplication.run(Application.class, args);
    5     }
    6 }
    
  2. @Configuration配置類沒有在package掃描路徑下僵芹,即不是項目開發(fā)人員自己編寫的代碼处硬。

    比如制作第三方包供他人在springboot項目中使用,如RPC框架拇派、starter工程荷辕、spring-cloud-netflix-zuul等。

    最佳實踐:

    1件豌、編寫AutoConfiguration配置類

    2疮方、在META-INF/spring.factories里用org.springframework.boot.autoconfigure.EnableAutoConfiguration來指定。

    ?

    spring-boot-autoconfigure包里的配置類都是通過這種方式引入的茧彤。

    示例:

    用于在項目中導(dǎo)入的第三方包spring-cloud-netflix-zuul

    image
    image

    引入spring-cloud-netflix-zuul的demo項目(實際是通過spring-cloud-starter-zuul引入的)

    當(dāng)然骡显,這個方式需要程序使用@EnableAutoConfiguration注解,這個注解是通過AutoConfigurationImportSelector來掃描spring.factories文件曾掂,把定義的配置類引入的惫谤。

讀取spring.factories文件的實現(xiàn)
是通過org.springframework.core.io.support.SpringFactoriesLoader實現(xiàn)的。
SpringFactoriesLoader的實現(xiàn)類似于SPI(Service Provider Interface)

java SPI提供一種服務(wù)發(fā)現(xiàn)機(jī)制珠洗,為某個接口尋找服務(wù)實現(xiàn)的機(jī)制溜歪。

有點類似IOC的思想,就是將裝配的控制權(quán)移到程序之外许蓖,在模塊化設(shè)計中這個機(jī)制尤其重要蝴猪。
?

實現(xiàn)說明:

1 @SpringBootApplication
2 public class Application {
3     public static void main(String[] args) {
4         SpringApplication.run(Application.class, args);
5     }
6 }

這是springboot項目中應(yīng)用最常見的啟動方式富岳,核心有兩個:

  • @SpringBootApplication注解
  • SpringApplication.run()靜態(tài)方法

和我們此處討論有關(guān)系的是注解@SpringBootApplication

@SpringBootApplication源碼如下:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
     @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
     @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {....}

@ComponentScan,spring的自動掃描注解拯腮,對應(yīng)方法一窖式。

@EnableAutoConfiguration:借助@Import的幫助,將所有符合自動配置條件的bean定義加載到IoC容器(建議放在根包路徑下动壤,這樣可以掃描子包和類)

@EnableAutoConfiguration源碼如下:

@SuppressWarnings("deprecation")
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {....}

其核心是一個EnableAutoConfigurationImportSelector類

public class EnableAutoConfigurationImportSelector
     extends AutoConfigurationImportSelector {...}

核心方法在頂級接口ImportSelector的selectImports()的實現(xiàn)上萝喘,源碼如下:

 @Override
 public String[] selectImports(AnnotationMetadata annotationMetadata) {
     if (!isEnabled(annotationMetadata)) {
         return NO_IMPORTS;
     }
     try {
          //1.從META-INF/spring-autoconfigure-metadata.properties文件中載入配置屬性(有一些有默認(rèn)值)
         AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
                 .loadMetadata(this.beanClassLoader);
          //2.獲取注解屬性
         AnnotationAttributes attributes = getAttributes(annotationMetadata);
      //3.獲取自動配置類    
          List<String> configurations = getCandidateConfigurations(annotationMetadata,
                 attributes);
          //4.移除重復(fù)的
         configurations = removeDuplicates(configurations);
          //5.排序
         configurations = sort(configurations, autoConfigurationMetadata);
          //6.排出需要排出的
         Set<String> exclusions = getExclusions(annotationMetadata, attributes);
         checkExcludedClasses(configurations, exclusions);
         configurations.removeAll(exclusions);
          //6.過濾器OnClassCondition(注解中配置存在某類才生效)
         configurations = filter(configurations, autoConfigurationMetadata);
          //7.觸發(fā)自動配置導(dǎo)入監(jiān)聽事件
         fireAutoConfigurationImportEvents(configurations, exclusions);
         return configurations.toArray(new String[configurations.size()]);
     }
     catch (IOException ex) {
         throw new IllegalStateException(ex);
     }
 }
  1. 使用@Import注解

    這個注解可以引入三種類

    • 使用了@Configuration注解的類

      如spring-cloud-netflix中ZuulProxyAutoConfiguration通過@import導(dǎo)入了若干個被@Configuration注解的類

      image
    • ImportSelector的子類(嚴(yán)格說來這不屬于被@Configuration標(biāo)注的配置類這一前提,但也屬于springboot自動配置能力的一種琼懊,故羅列在此)

      如@EnableAutoConfiguration中所引入的EnableAutoConfigurationImportSelector

      image
    • ImportBeanDefinitionRegistrar的子類

      {todo}

初始spring boot

spring boot容器啟動詳解

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末阁簸,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子哼丈,更是在濱河造成了極大的恐慌启妹,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,123評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件醉旦,死亡現(xiàn)場離奇詭異饶米,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)车胡,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,031評論 2 384
  • 文/潘曉璐 我一進(jìn)店門檬输,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人匈棘,你說我怎么就攤上這事丧慈。” “怎么了主卫?”我有些...
    開封第一講書人閱讀 156,723評論 0 345
  • 文/不壞的土叔 我叫張陵逃默,是天一觀的道長。 經(jīng)常有香客問我簇搅,道長完域,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,357評論 1 283
  • 正文 為了忘掉前任馍资,我火速辦了婚禮筒主,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘鸟蟹。我一直安慰自己,他們只是感情好使兔,可當(dāng)我...
    茶點故事閱讀 65,412評論 5 384
  • 文/花漫 我一把揭開白布建钥。 她就那樣靜靜地躺著,像睡著了一般虐沥。 火紅的嫁衣襯著肌膚如雪熊经。 梳的紋絲不亂的頭發(fā)上泽艘,一...
    開封第一講書人閱讀 49,760評論 1 289
  • 那天,我揣著相機(jī)與錄音镐依,去河邊找鬼匹涮。 笑死,一個胖子當(dāng)著我的面吹牛槐壳,可吹牛的內(nèi)容都是我干的然低。 我是一名探鬼主播,決...
    沈念sama閱讀 38,904評論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼务唐,長吁一口氣:“原來是場噩夢啊……” “哼雳攘!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起枫笛,我...
    開封第一講書人閱讀 37,672評論 0 266
  • 序言:老撾萬榮一對情侶失蹤吨灭,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后刑巧,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體喧兄,經(jīng)...
    沈念sama閱讀 44,118評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,456評論 2 325
  • 正文 我和宋清朗相戀三年啊楚,在試婚紗的時候發(fā)現(xiàn)自己被綠了繁莹。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,599評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡特幔,死狀恐怖咨演,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情蚯斯,我是刑警寧澤薄风,帶...
    沈念sama閱讀 34,264評論 4 328
  • 正文 年R本政府宣布,位于F島的核電站拍嵌,受9級特大地震影響遭赂,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜横辆,卻給世界環(huán)境...
    茶點故事閱讀 39,857評論 3 312
  • 文/蒙蒙 一撇他、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧狈蚤,春花似錦困肩、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,731評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至靖避,卻和暖如春潭枣,著一層夾襖步出監(jiān)牢的瞬間比默,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,956評論 1 264
  • 我被黑心中介騙來泰國打工盆犁, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留命咐,地道東北人。 一個月前我還...
    沈念sama閱讀 46,286評論 2 360
  • 正文 我出身青樓谐岁,卻偏偏與公主長得像醋奠,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子翰铡,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,465評論 2 348

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