springboot自動裝載

代碼分析版本為2.1.4.RELEASE

springboot是spring的拓展框架,不需要再寫xml文件,來配置bean的加載丰歌,使開發(fā)更加便捷和高效姨蟋。

1. 從哪里加載bean?

從注解開始分析

image.png

SpringBootApplication.java:

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

分別查看SpringBootApplication上的注解立帖,發(fā)現(xiàn)EnableAutoConfiguration.java有比較重要的信息:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
//重點看這里
@AutoConfigurationPackage
//重點看這里
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    /**
     * Exclude specific auto-configuration classes such that they will never be applied.
     * @return the classes to exclude
     */
    Class<?>[] exclude() default {};

    /**
     * Exclude specific auto-configuration class names such that they will never be
     * applied.
     * @return the class names to exclude
     * @since 1.3.0
     */
    String[] excludeName() default {};

}

@AutoConfigurationPackage:表示將該類所對應(yīng)的包加入到自動配置眼溶。即將MainApplication.java對應(yīng)的包名加入到自動裝配。@Import(AutoConfigurationImportSelector.class) :這里在程序初始化的時候晓勇,會執(zhí)行AutoConfigurationImportSelector.AutoConfigurationGroup.process堂飞,自動裝載bean,詳情邏輯請繼續(xù)看下面绑咱。

AutoConfigurationImportSelector.java:

public class AutoConfigurationImportSelector
        implements DeferredImportSelector, BeanClassLoaderAware, ResourceLoaderAware,
        BeanFactoryAware, EnvironmentAware, Ordered {

}

AutoConfigurationImportSelector的類圖:


image.png

可見其實現(xiàn)了DeferredImportSelector類绰筛,而DeferredImportSelector又繼承ImportSelector類。該實現(xiàn)關(guān)系請記住描融,將有利于下面的代碼分析铝噩。

在這里,先跟大家說一下稼稿,程序初始化的時候會執(zhí)行AutoConfigurationImportSelector.AutoConfigurationGroup.process(為什么會執(zhí)行該方法薄榛?詳情查看2)
那么該方法實現(xiàn)了什么邏輯呢讳窟?

@Override
        public void process(AnnotationMetadata annotationMetadata,
                DeferredImportSelector deferredImportSelector) {
            Assert.state(
                    deferredImportSelector instanceof AutoConfigurationImportSelector,
                    () -> String.format("Only %s implementations are supported, got %s",
                            AutoConfigurationImportSelector.class.getSimpleName(),
                            deferredImportSelector.getClass().getName()));
            //重點看這里:獲取自動裝配實體
            AutoConfigurationEntry autoConfigurationEntry = ((AutoConfigurationImportSelector) deferredImportSelector)
                    .getAutoConfigurationEntry(getAutoConfigurationMetadata(),
                            annotationMetadata);
            this.autoConfigurationEntries.add(autoConfigurationEntry);
            for (String importClassName : autoConfigurationEntry.getConfigurations()) {
                this.entries.putIfAbsent(importClassName, annotationMetadata);
            }
        }

其中再看一下getAutoConfigurationEntry方法:

/**
     * Return the {@link AutoConfigurationEntry} based on the {@link AnnotationMetadata}
     * of the importing {@link Configuration @Configuration} class.
     * @param autoConfigurationMetadata the auto-configuration metadata
     * @param annotationMetadata the annotation metadata of the configuration class
     * @return the auto-configurations that should be imported
     */
    protected AutoConfigurationEntry getAutoConfigurationEntry(
            AutoConfigurationMetadata autoConfigurationMetadata,
            AnnotationMetadata annotationMetadata) {
        if (!isEnabled(annotationMetadata)) {
            return EMPTY_ENTRY;
        }
        AnnotationAttributes attributes = getAttributes(annotationMetadata);
       //猜測:獲取配置類让歼,從哪里獲取丽啡?再細(xì)看這里的代碼
        List<String> configurations = getCandidateConfigurations(annotationMetadata,
                attributes);
      //刪除重復(fù)名稱的bean
        configurations = removeDuplicates(configurations);
      //獲取元數(shù)據(jù)的不應(yīng)包括的類名(excludeName谋右、exclude)
        Set<String> exclusions = getExclusions(annotationMetadata, attributes);
        checkExcludedClasses(configurations, exclusions);
      //刪除不應(yīng)包括的類名
        configurations.removeAll(exclusions);
      //過濾需要過濾的配置類
        configurations = filter(configurations, autoConfigurationMetadata);
        fireAutoConfigurationImportEvents(configurations, exclusions);
        return new AutoConfigurationEntry(configurations, exclusions);
    }

下面來重點看看該方法的實現(xiàn):

       //猜測:獲取配置類,從哪里獲炔构俊改执?再細(xì)看這里的代碼
        List<String> configurations = getCandidateConfigurations(annotationMetadata,
                attributes);

org.springframework.boot.autoconfigure.AutoConfigurationImportSelector#getCandidateConfigurations:

/**
     * Return the auto-configuration class names that should be considered. By default
     * this method will load candidates using {@link SpringFactoriesLoader} with
     * {@link #getSpringFactoriesLoaderFactoryClass()}.
     * @param metadata the source metadata
     * @param attributes the {@link #getAttributes(AnnotationMetadata) annotation
     * attributes}
     * @return a list of candidate configurations
     */
    protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
            AnnotationAttributes attributes) {
       //實質(zhì)調(diào)用了SpringFactoriesLoader.loadFactoryNames(EnableAutoConfiguration.class, this.beanClassLoader);
        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;
    }

  /**
     * Return the class used by {@link SpringFactoriesLoader} to load configuration
     * candidates.
     * @return the factory class
     */
    protected Class<?> getSpringFactoriesLoaderFactoryClass() {
        return EnableAutoConfiguration.class;
    }

從上面的代碼注解中,繼續(xù)深入loadFactoryNames方法,即獲取EnableAutoConfiguration為key的所有類名
org.springframework.core.io.support.SpringFactoriesLoader#loadFactoryNames:

public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {
        String factoryClassName = factoryClass.getName();
        return loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
    }

    private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
        MultiValueMap<String, String> result = cache.get(classLoader);
        if (result != null) {
            return result;
        }

        try {
            Enumeration<URL> urls = (classLoader != null ?
        //注解1:FACTORIES_RESOURCE_LOCATION=META-INF/spring.factories,即從該路徑下獲取類   
                classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
                    ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
            result = new LinkedMultiValueMap<>();
            while (urls.hasMoreElements()) {
                URL url = urls.nextElement();
                UrlResource resource = new UrlResource(url);
                Properties properties = PropertiesLoaderUtils.loadProperties(resource);
                for (Map.Entry<?, ?> entry : properties.entrySet()) {
                    String factoryClassName = ((String) entry.getKey()).trim();
                    for (String factoryName : StringUtils.commaDelimitedListToStringArray((String) entry.getValue())) {
                        result.add(factoryClassName, factoryName.trim());
                    }
                }
            }
            cache.put(classLoader, result);
            return result;
        }
        catch (IOException ex) {
            throw new IllegalArgumentException("Unable to load factories from location [" +
                    FACTORIES_RESOURCE_LOCATION + "]", ex);
        }
    }

注解1:就是加載所有包的spring.factories文件坑雅,然后逐個解釋
其中:
Properties properties = PropertiesLoaderUtils.loadProperties(resource);
解釋spring.factories文件
如下圖所示辈挂,某個包下的spring.factories文件:

image.png

轉(zhuǎn)化為
org.springframework.boot.autoconfigure.EnableAutoConfiguration->
org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration

相關(guān)流程圖如下:


image.png

2. 為什么會執(zhí)行AutoConfigurationImportSelector.AutoConfigurationGroup.process?

從springApplication.run開始:


image.png

代碼太多裹粤,挑重點的說:
org.springframework.context.annotation.ConfigurationClassParser#doProcessConfigurationClass
會處理如下圖所示的注解终蒂,在分析@Import注解時,會查看該類是不是實現(xiàn)DeferredImportSelector類遥诉,如果是拇泣,則會調(diào)用this.deferredImportSelectorHandler.process()。很明顯矮锈,在前面提到霉翔,AutoConfigurationImportSelector實現(xiàn)了DeferredImportSelector,所以在后面的邏輯中苞笨,會調(diào)用AutoConfigurationImportSelector.AutoConfigurationGroup.process方法

image.png

總結(jié):

  1. springboot會自動掃描mainApplication類所在包的所有bean
  2. springboot會自動掃描jar包下面的/META-INF/spring.factories文件债朵,將EnableAutoConfiguration為key的所有類名加載出來子眶,并進(jìn)行去重、過濾
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末序芦,一起剝皮案震驚了整個濱河市壹店,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌芝加,老刑警劉巖硅卢,帶你破解...
    沈念sama閱讀 206,602評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異藏杖,居然都是意外死亡将塑,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,442評論 2 382
  • 文/潘曉璐 我一進(jìn)店門蝌麸,熙熙樓的掌柜王于貴愁眉苦臉地迎上來点寥,“玉大人,你說我怎么就攤上這事来吩「冶纾” “怎么了?”我有些...
    開封第一講書人閱讀 152,878評論 0 344
  • 文/不壞的土叔 我叫張陵弟疆,是天一觀的道長戚长。 經(jīng)常有香客問我,道長怠苔,這世上最難降的妖魔是什么同廉? 我笑而不...
    開封第一講書人閱讀 55,306評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮柑司,結(jié)果婚禮上迫肖,老公的妹妹穿的比我還像新娘。我一直安慰自己攒驰,他們只是感情好蟆湖,可當(dāng)我...
    茶點故事閱讀 64,330評論 5 373
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著玻粪,像睡著了一般隅津。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上奶段,一...
    開封第一講書人閱讀 49,071評論 1 285
  • 那天饥瓷,我揣著相機(jī)與錄音,去河邊找鬼痹籍。 笑死呢铆,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的蹲缠。 我是一名探鬼主播棺克,決...
    沈念sama閱讀 38,382評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼悠垛,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了娜谊?” 一聲冷哼從身側(cè)響起确买,我...
    開封第一講書人閱讀 37,006評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎纱皆,沒想到半個月后湾趾,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,512評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡派草,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,965評論 2 325
  • 正文 我和宋清朗相戀三年搀缠,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片近迁。...
    茶點故事閱讀 38,094評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡艺普,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出鉴竭,到底是詐尸還是另有隱情歧譬,我是刑警寧澤,帶...
    沈念sama閱讀 33,732評論 4 323
  • 正文 年R本政府宣布搏存,位于F島的核電站瑰步,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏祭埂。R本人自食惡果不足惜面氓,卻給世界環(huán)境...
    茶點故事閱讀 39,283評論 3 307
  • 文/蒙蒙 一兵钮、第九天 我趴在偏房一處隱蔽的房頂上張望蛆橡。 院中可真熱鬧,春花似錦掘譬、人聲如沸泰演。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,286評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽睦焕。三九已至,卻和暖如春靴拱,著一層夾襖步出監(jiān)牢的瞬間垃喊,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,512評論 1 262
  • 我被黑心中介騙來泰國打工袜炕, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留本谜,地道東北人。 一個月前我還...
    沈念sama閱讀 45,536評論 2 354
  • 正文 我出身青樓偎窘,卻偏偏與公主長得像乌助,于是被迫代替她去往敵國和親溜在。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,828評論 2 345

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