腳本之家服務器常用軟件

快捷導航

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

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

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

一、從示例開始

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

來看下面示例。

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");
    }
}

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

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

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

二、創(chuàng)建AnnotationConfigApplicationContext

構造方法的入參是componentClasses，即可以傳入多個配置類。

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

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

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

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

總結：this()僅僅實例化了容器對象，創(chuàng)建了Reader、Scanner，用于解析類信息。

三、注冊Configuration類

3.1 創(chuàng)建BeanDefinition

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

來看AnnotatedBeanDefinitionReader#doRegisterBean的核心邏輯：

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

3.2 注冊BeanDefinition

BeanDefinitionHolder類只是對BeanDefinition的包裝，僅有三個屬性：beanDefinition、beanName和aliases。

在BeanDefinitionReaderUtils#registerBeanDefinition中

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

看到了BeanFactory的兩個核心數(shù)據結構：

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

果然與我們當初的猜想一致。

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

四、掃描包路徑

先說結論：@ComponentScan包路徑下的類，是在ClassPathBeanDefinitionScanner#scan中被處理的。

先來看AnnotationConfigApplicationContext的另一個構造方法：入參就是指定包路徑。

轉調到ClassPathBeanDefinitionScanner#scan。

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

4.1 BeanFactoryPostProcessor接口

先看類注釋：

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.

工廠鉤子，允許自定義修改應用程序上下文的bean定義，調整上下文的底層bean工廠的bean屬性值。

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

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

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

僅有一個方法：

void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException;

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

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

對標準BeanFactoryPostProcessor SPI的擴展，允許在常規(guī)BeanFactoryPostProcessor檢測開始之前注冊進一步的bean定義。