spring boot源碼分析(一:@SpringBootApplication注解做了哪些事)

分析@SpringBootApplication注解做了哪些事锨亏。

總結(jié):@SpringBootApplication注解內(nèi)部有三個(gè)注解:
1、SpringBootConfiguration:springBootConfiguration注解上有configuration注解棵癣,所以作用和configuration注解類(lèi)似。
2夺衍、EnableAutoConfiguration:這個(gè)注解上有AutoConfigurationPackage注解和@Import(AutoConfigurationImportSelector.class)注解狈谊。
AutoConfigurationPackage注解:會(huì)將啟動(dòng)類(lèi)的包名下、以及子包下刷后,所有的類(lèi)的畴,注入到ioc容器。
@Import(AutoConfigurationImportSelector.class):會(huì)通過(guò)SpringFactoriesLoader.loadFactories方法獲取META-INF/spirng.factories下的EnableAutoConfiguration接口的所有組件實(shí)現(xiàn)類(lèi)尝胆,比如AopAutoConfiguration丧裁、RabbitAutoConfiguration,進(jìn)行各個(gè)組件的自動(dòng)化配置含衔。
3煎娇、ComponentScan:這個(gè)注解用于自定義spring boot掃描指定的包下的類(lèi)加入ioc容器,以及可以配置過(guò)濾規(guī)則贪染,過(guò)濾哪些不需要加入ioc容器缓呛。SpringBootApplication注解配置了一些自定義的過(guò)濾規(guī)則。

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}
@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 

springBootConfiguration注解上有configuration注解杭隙,所以作用類(lèi)似

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration

看這個(gè)類(lèi)前哟绊,先說(shuō)@import注解。
import注解有三種使用方式:
1痰憎、直接普通的類(lèi)的全類(lèi)名寫(xiě)上去票髓,會(huì)注入ioc容器。

@Import({com.test.A, com.test.B } )
public class C{
}

2铣耘、注入的類(lèi)洽沟,實(shí)現(xiàn)了ImportSelector接口,ImportSelector接口的抽象方法會(huì)返回需要注入的類(lèi)的名稱(chēng)數(shù)組蜗细。
3裆操、注入的類(lèi),實(shí)現(xiàn)了ImportBeanDefinitionRegistrar,ImportBeanDefinitionRegistrar接口的抽象方法踪区,會(huì)傳入?yún)?shù)BeanDefinitionRegistry 昆烁,用于手動(dòng)注入到ioc容器。

可以看到這個(gè)注解上有兩部分朽缴,AutoConfigurationPackage注解和import注解善玫。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration 

AutoConfigurationPackages.Registrar實(shí)現(xiàn)了ImportBeanDefinitionRegistrar接口,用于手動(dòng)注入類(lèi)到ioc中密强,可以看到方法內(nèi)部傳參是啟動(dòng)類(lèi)的包名茅郎。把啟動(dòng)類(lèi)的包名下的所有類(lèi)都注入ioc。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {

        @Override
        public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
            register(registry, new PackageImports(metadata).getPackageNames().toArray(new String[0]));
        }

        @Override
        public Set<Object> determineImports(AnnotationMetadata metadata) {
            return Collections.singleton(new PackageImports(metadata));
        }

    }

public static void register(BeanDefinitionRegistry registry, String... packageNames) {
        if (registry.containsBeanDefinition(BEAN)) {
            BasePackagesBeanDefinition beanDefinition = (BasePackagesBeanDefinition) registry.getBeanDefinition(BEAN);
            beanDefinition.addBasePackages(packageNames);
        }
        else {
// 手動(dòng)注入到ioc或渤,傳參:?jiǎn)?dòng)類(lèi)的包名系冗。把啟動(dòng)類(lèi)的包名下的所有類(lèi)都注入ioc。
            registry.registerBeanDefinition(BEAN, new BasePackagesBeanDefinition(packageNames));
        }
    }

回過(guò)頭來(lái)再看這個(gè)注解薪鹦,接著看@Import(AutoConfigurationImportSelector.class)

@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

實(shí)現(xiàn)了ImportSelector接口掌敬,說(shuō)明selectImports方法返回的類(lèi)名數(shù)組會(huì)注入到ioc容器。

public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware,
        ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered {
@Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        if (!isEnabled(annotationMetadata)) {
            return NO_IMPORTS;
        }
        AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
        return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
    }

protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
        if (!isEnabled(annotationMetadata)) {
            return EMPTY_ENTRY;
        }
// 獲取注解屬性
        AnnotationAttributes attributes = getAttributes(annotationMetadata);
// 核心池磁。獲取候選的configuration的全類(lèi)名數(shù)組奔害。
        List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
// 下面都是對(duì)候選的configuration進(jìn)行一些去重處理
        configurations = removeDuplicates(configurations);
        Set<String> exclusions = getExclusions(annotationMetadata, attributes);
        checkExcludedClasses(configurations, exclusions);
        configurations.removeAll(exclusions);
        configurations = getConfigurationClassFilter().filter(configurations);
// 發(fā)布自動(dòng)配置導(dǎo)入事件
        fireAutoConfigurationImportEvents(configurations, exclusions);
        return new AutoConfigurationEntry(configurations, exclusions);
    }

SpringFactoriesLoader.loadFactories方法會(huì)獲取META-INF/spirng.factories下的指定類(lèi)的所有實(shí)現(xiàn)類(lèi)。
這里獲取配置的EnableAutoConfiguration的所有實(shí)現(xiàn)類(lèi)地熄。
spring boot自動(dòng)化配置各種組件的方式就是如此华临,spring-boot-autoconfiguration.jar包的spring.factories文件里定義好了各種組件的AutoConfiguration,包里也有各個(gè)AutoConfiguration類(lèi),比如AopAutoConfiguration端考、RabbitAutoConfiguration雅潭。組件又通過(guò)ConditionalOnClass達(dá)到自適應(yīng)加載。

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
@EnableConfigurationProperties(RabbitProperties.class)
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {

    protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
        List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
                getBeanClassLoader());
        Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you "
                + "are using a custom packaging, make sure that file is correct.");
        return configurations;
    }

protected Class<?> getSpringFactoriesLoaderFactoryClass() {
        return EnableAutoConfiguration.class;
    }
image.png

發(fā)布自動(dòng)配置導(dǎo)入事件:獲取META-INF/spirng.factories下配置的AutoConfigurationImportListener的所有實(shí)現(xiàn)類(lèi)却特,循環(huán)調(diào)用各個(gè)類(lèi)的監(jiān)聽(tīng)事件方法扶供。

private void fireAutoConfigurationImportEvents(List<String> configurations, Set<String> exclusions) {
//  獲取META-INF/spirng.factories下配置的AutoConfigurationImportListener的所有實(shí)現(xiàn)類(lèi)
        List<AutoConfigurationImportListener> listeners = getAutoConfigurationImportListeners();
        if (!listeners.isEmpty()) {
            AutoConfigurationImportEvent event = new AutoConfigurationImportEvent(this, configurations, exclusions);
            for (AutoConfigurationImportListener listener : listeners) {
// 如果監(jiān)聽(tīng)器實(shí)現(xiàn)了Aware接口,就填充Aware的所需的參數(shù)裂明。
                invokeAwareMethods(listener);
// 調(diào)用事件監(jiān)聽(tīng)器的監(jiān)聽(tīng)事件
                listener.onAutoConfigurationImportEvent(event);
            }
        }
    }

protected List<AutoConfigurationImportListener> getAutoConfigurationImportListeners() {
// SpringFactoriesLoader.loadFactories方法會(huì)獲取META-INF/spirng.factories下的指定類(lèi)的所有實(shí)現(xiàn)類(lèi)椿浓。
// 這了獲取配置的AutoConfigurationImportListener的所有實(shí)現(xiàn)類(lèi)
        return SpringFactoriesLoader.loadFactories(AutoConfigurationImportListener.class, this.beanClassLoader);
    }

看一下SpringFactoriesLoader.loadFactoryNames方法。
1闽晦、存在一個(gè)緩存轰绵,也就是說(shuō)多次調(diào)用,不會(huì)重復(fù)解析加載
2尼荆、 獲取所有的META-INF/spring.factories路徑,包括各個(gè)jar包的唧垦。
3捅儒、循環(huán)解析,存到result這個(gè)map中,并返回這個(gè)map巧还。

public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
        ClassLoader classLoaderToUse = classLoader;
        if (classLoaderToUse == null) {
            classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();
        }
        String factoryTypeName = factoryType.getName();
        return loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());
    }

    public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";

private static Map<String, List<String>> loadSpringFactories(ClassLoader classLoader) {
// 存在一個(gè)緩存鞭莽,也就是說(shuō)多次調(diào)用,不會(huì)重復(fù)解析加載
        Map<String, List<String>> result = cache.get(classLoader);
        if (result != null) {
            return result;
        }

        result = new HashMap<>();
        try {
// 獲取所有的META-INF/spring.factories路徑麸祷,包括各個(gè)jar包的澎怒。
            Enumeration<URL> urls = classLoader.getResources(FACTORIES_RESOURCE_LOCATION);
// 循環(huán)解析,存到result這個(gè)map中阶牍。
            while (urls.hasMoreElements()) {
                URL url = urls.nextElement();
                UrlResource resource = new UrlResource(url);
                Properties properties = PropertiesLoaderUtils.loadProperties(resource);
                for (Map.Entry<?, ?> entry : properties.entrySet()) {
                    String factoryTypeName = ((String) entry.getKey()).trim();
                    String[] factoryImplementationNames =
                            StringUtils.commaDelimitedListToStringArray((String) entry.getValue());
                    for (String factoryImplementationName : factoryImplementationNames) {
                        result.computeIfAbsent(factoryTypeName, key -> new ArrayList<>())
                                .add(factoryImplementationName.trim());
                    }
                }
            }

            // Replace all lists with unmodifiable lists containing unique elements
            result.replaceAll((factoryType, implementations) -> implementations.stream().distinct()
                    .collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList)));
            cache.put(classLoader, result);
        }
        catch (IOException ex) {
            throw new IllegalArgumentException("Unable to load factories from location [" +
                    FACTORIES_RESOURCE_LOCATION + "]", ex);
        }
        return result;
    }

總結(jié):@SpringBootApplication注解內(nèi)部有三個(gè)注解:
1喷面、SpringBootConfiguration:springBootConfiguration注解上有configuration注解,所以作用和configuration注解類(lèi)似走孽。
2惧辈、EnableAutoConfiguration:這個(gè)注解上有AutoConfigurationPackage注解和@Import(AutoConfigurationImportSelector.class)注解。
AutoConfigurationPackage注解:會(huì)將啟動(dòng)類(lèi)的包名下磕瓷、以及子包下盒齿,所有的類(lèi),注入到ioc容器困食。
@Import(AutoConfigurationImportSelector.class):會(huì)通過(guò)SpringFactoriesLoader.loadFactories方法獲取META-INF/spirng.factories下的EnableAutoConfiguration接口的所有組件實(shí)現(xiàn)類(lèi)边翁,比如AopAutoConfiguration、RabbitAutoConfiguration硕盹,進(jìn)行各個(gè)組件的自動(dòng)化配置符匾。

3、ComponentScan:這個(gè)注解用于自定義spring boot掃描指定的包下的類(lèi)加入ioc容器莱睁,以及可以配置過(guò)濾規(guī)則待讳,過(guò)濾哪些不需要加入ioc容器。SpringBootApplication注解配置了一些自定義的過(guò)濾規(guī)則仰剿。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末创淡,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子南吮,更是在濱河造成了極大的恐慌琳彩,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,402評(píng)論 6 499
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件部凑,死亡現(xiàn)場(chǎng)離奇詭異露乏,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)涂邀,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,377評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門(mén)瘟仿,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人比勉,你說(shuō)我怎么就攤上這事劳较∫凰溃” “怎么了仅政?”我有些...
    開(kāi)封第一講書(shū)人閱讀 162,483評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵逆甜,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我墓捻,道長(zhǎng)抖仅,這世上最難降的妖魔是什么砖第? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,165評(píng)論 1 292
  • 正文 為了忘掉前任撤卢,我火速辦了婚禮,結(jié)果婚禮上厂画,老公的妹妹穿的比我還像新娘凸丸。我一直安慰自己,他們只是感情好袱院,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,176評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布屎慢。 她就那樣靜靜地躺著,像睡著了一般忽洛。 火紅的嫁衣襯著肌膚如雪腻惠。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,146評(píng)論 1 297
  • 那天欲虚,我揣著相機(jī)與錄音集灌,去河邊找鬼。 笑死复哆,一個(gè)胖子當(dāng)著我的面吹牛欣喧,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播梯找,決...
    沈念sama閱讀 40,032評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼唆阿,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了锈锤?” 一聲冷哼從身側(cè)響起驯鳖,我...
    開(kāi)封第一講書(shū)人閱讀 38,896評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎久免,沒(méi)想到半個(gè)月后浅辙,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,311評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡阎姥,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,536評(píng)論 2 332
  • 正文 我和宋清朗相戀三年记舆,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片呼巴。...
    茶點(diǎn)故事閱讀 39,696評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡泽腮,死狀恐怖泊愧,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情盛正,我是刑警寧澤,帶...
    沈念sama閱讀 35,413評(píng)論 5 343
  • 正文 年R本政府宣布屑埋,位于F島的核電站豪筝,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏摘能。R本人自食惡果不足惜续崖,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,008評(píng)論 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望团搞。 院中可真熱鬧严望,春花似錦、人聲如沸逻恐。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)复隆。三九已至拨匆,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間挽拂,已是汗流浹背惭每。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,815評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留亏栈,地道東北人台腥。 一個(gè)月前我還...
    沈念sama閱讀 47,698評(píng)論 2 368
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像绒北,于是被迫代替她去往敵國(guó)和親黎侈。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,592評(píng)論 2 353

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