快捷導(dǎo)航

Spring創(chuàng)建BeanDefinition之路徑掃描詳解

更新時(shí)間：2025年04月07日 09:50:26 作者：程序員俠客行

這篇文章主要介紹了Spring創(chuàng)建BeanDefinition之路徑掃描方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

一、從示例開(kāi)始

當(dāng)我們創(chuàng)建AnnotationConfigApplicationContext對(duì)象時(shí)，Spring底層到底做了些什么？

來(lái)看下面示例。

package com.xiakexing;

import com.xiakexing.service.UserService;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Test {

	public static void main(String[] args) {
		AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
		UserService userService = context.getBean("userService", UserService.class);
		userService.test();
    }
}

package com.xiakexing;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan(value = "com.xiakexing")
public class AppConfig {

}

package com.xiakexing.service;

import org.springframework.stereotype.Component;

@Component
public class UserService {

    public void test() {
        System.out.println("hello spring");
    }
}

我們猜測(cè)這幾行代碼執(zhí)行邏輯：

new AnnotationConfigApplicationContext(AppConfig.class)時(shí)，從AppConfig類(lèi)解析掃描路徑即@ComponentScan；
遍歷掃描路徑下的所有Java類(lèi)，如果某個(gè)類(lèi)上有@Component、@Service等注解，Spring就為這個(gè)類(lèi)創(chuàng)建BeanDefinition，保存到Map中，比如Map<String, Class>，key是根據(jù)規(guī)則生成的beanName，value就是當(dāng)前類(lèi)的class對(duì)象。
context.getBean("userService")時(shí)，Spring根據(jù)beanName找到類(lèi)的class對(duì)象，反射調(diào)用構(gòu)造器創(chuàng)建對(duì)象。

帶著上面的猜想，我們來(lái)看看源碼。本文暫且關(guān)注路徑掃描的實(shí)現(xiàn)，隨后的文章將講解BeanDefinition的創(chuàng)建過(guò)程。

二、創(chuàng)建AnnotationConfigApplicationContext

構(gòu)造方法的入?yún)⑹莄omponentClasses，即可以傳入多個(gè)配置類(lèi)。

this()中創(chuàng)建了AnnotatedBeanDefinitionReader、ClassPathBeanDefinitionScanner，將用于掃描指定路徑下的類(lèi)，創(chuàng)建BeanDefinition。

JFR 是 Java Flight Record （Java飛行記錄），是JVM 內(nèi)置的基于事件的JDK監(jiān)控記錄框架。StartupStep是Spring基于JFR對(duì)運(yùn)行過(guò)程的監(jiān)控，閱讀源碼時(shí)可忽略它。

注意，AnnotationConfigApplicationContext間接實(shí)現(xiàn)了BeanDefinitionRegistry接口，具備向容器中注冊(cè)BeanDefinition的能力。

在創(chuàng)建ClassPathBeanDefinitionScanner對(duì)象時(shí)，指定了使用DefaultFilters：將掃描所有帶有@Component注解的類(lèi)。

總結(jié)：this()僅僅實(shí)例化了容器對(duì)象，創(chuàng)建了Reader、Scanner，用于解析類(lèi)信息。

三、注冊(cè)Configuration類(lèi)

3.1 創(chuàng)建BeanDefinition

register(componentClasses)，顯然是將配置類(lèi)注冊(cè)到容器中。

來(lái)看AnnotatedBeanDefinitionReader#doRegisterBean的核心邏輯：

為配置類(lèi)創(chuàng)建AnnotatedGenericBeanDefinition對(duì)象；
處理@Conditional，如果條件不滿(mǎn)足，將舍棄這個(gè)類(lèi)；
給BeanDefinition對(duì)象屬性賦值；
生成beanName，解析@Lazy、@Primary、@DependsOn等注解；
創(chuàng)建BeanDefinitionHolder對(duì)象，發(fā)起注冊(cè)。

3.2 注冊(cè)BeanDefinition

BeanDefinitionHolder類(lèi)只是對(duì)BeanDefinition的包裝，僅有三個(gè)屬性：beanDefinition、beanName和aliases。

在BeanDefinitionReaderUtils#registerBeanDefinition中

最終會(huì)調(diào)用DefaultListableBeanFactory#registerBeanDefinition方法，執(zhí)行這幾行代碼：

看到了BeanFactory的兩個(gè)核心數(shù)據(jù)結(jié)構(gòu)：

beanDefinitionMap保存了beanName與beanDefinition的映射；
beanDefinitionNames保存了所有的beanName

果然與我們當(dāng)初的猜想一致。

至此，配置類(lèi)已被添加到beanDefinitionMap中，可是@ComponentScan指定的包路徑，在哪兒被處理了呢？

四、掃描包路徑

先說(shuō)結(jié)論：@ComponentScan包路徑下的類(lèi)，是在ClassPathBeanDefinitionScanner#scan中被處理的。

先來(lái)看AnnotationConfigApplicationContext的另一個(gè)構(gòu)造方法：入?yún)⒕褪侵付ò窂健?/p>

轉(zhuǎn)調(diào)到ClassPathBeanDefinitionScanner#scan。

基于配置類(lèi)創(chuàng)建AnnotationConfigApplicationContext時(shí)，是在哪兒調(diào)了scan()或doScan()呢？答案就在refresh()中。

4.1 BeanFactoryPostProcessor接口

先看類(lèi)注釋?zhuān)?/p>

Factory hook that allows for custom modification of an application context's bean definitions, adapting the bean property values of the context's underlying bean factory.

工廠鉤子，允許自定義修改應(yīng)用程序上下文的bean定義，調(diào)整上下文的底層bean工廠的bean屬性值。

A BeanFactoryPostProcessor may interact with and modify bean definitions, but never bean instances.

BeanFactoryPostProcessor可以與bean定義交互和修改，但不能與bean實(shí)例交互。

可見(jiàn)，該接口是BeanFactory的后置處理器，在創(chuàng)建Bean實(shí)例前，干涉BeanDefinition創(chuàng)建和更新。

僅有一個(gè)方法：

void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException;

該接口有個(gè)重要的子接口BeanDefinitionRegistryPostProcessor，能夠向容器注冊(cè)更多的BeanDefinition。

Extension to the standard BeanFactoryPostProcessor SPI, allowing for the registration of further bean definitions before regular BeanFactoryPostProcessor detection kicks in.

對(duì)標(biāo)準(zhǔn)BeanFactoryPostProcessor SPI的擴(kuò)展，允許在常規(guī)BeanFactoryPostProcessor檢測(cè)開(kāi)始之前注冊(cè)進(jìn)一步的bean定義。