SpringBoot詳細探究講解默認組件掃描

Posted on by

參考視頻：https://www.bilibili.com/video/BV1Bq4y1Q7GZ?p=6

通過視頻的學習和自身的理解整理出的筆記。

一、前期準備

1.1 創建工程

創建springboot項目，springboot版本為2.5.0，引入spring-boot-starter-web依賴，pom文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>springboot</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

1.2 創建Controller

創建一個簡單的Controller用於測試

@RestController
public class HelloController {
    public void helloController() {
        System.out.println("創建瞭");
    }
    @RequestMapping("hello")
    public String hello() {
        return "hello";
    }
}

二、探究過程

2.1 探究目標

在項目中我們創建瞭Controller，這個Controller是如何被spring自動加載的呢？為什麼Controller必須放在啟動類的同級目錄下呢？

如果我們想要加載不在啟動類同級目錄下的bean對象，需要在啟動類中使用@ComponentScan註解。

目標：SpringBoot項目中我們沒有設置組件掃描的包，為什麼它會默認掃描啟動類目錄下所有的包。

2.2 探究過程

2.2.1 回顧容器bean的創建與刷新

在SpringApplication的run()方法中，創建瞭spring容器context，並通過refreshContext(context)更新容器加載我們自定義的bean對象。

我們發現在執行完refreshContext(context)代碼後，自定義的bean對象（HelloController）就已經被創建瞭，說明refreshContext(context)過程中創建瞭自定義bean對象。

下面我們看看究竟是refreshContext(context)中哪些方法創建瞭自定義bean對象。

2.2.2 SpringApplication

我接著看refreshContext(context)方法

🔶 refreshContext()方法

🔶 refresh()方法

2.2.3 ServletWebServerApplicationContext

再調用父類的refresh()方法

2.2.4 AbstractApplicationContext

🔶 refresh()方法

在執行完這行代碼後創建瞭自定義bean的beanDefination對象。下面來看看這行代碼。

🔶 invokeBeanFactoryPostProcessors()方法

根據這個名字可以看出來是調用瞭bean工廠的後置處理器。

2.2.5 PostProcessorRegistrationDelegate

🔶 invokeBeanFactoryPostProcessors()方法

調用bean工廠的後置處理器，這個方法很長，最終找到瞭是這行代碼，調用BeanDefinition註冊的後置處理。

🔶 invokeBeanDefinitionRegistryPostProcessors()方法

拿到後置處理器，調用後置處理器的BeanDefinition註冊。

2.2.6 ConfigurationClassPostProcessor

🔶 postProcessBeanDefinitionRegistry()方法

🔶 processConfigBeanDefinitions()方法

把啟動類的beanDefinition對象添加到瞭configCandidates集合中，後面將要用到。

這行代碼執行結束後就有瞭helloController。

這個parser是配置類的處理器，通過傳入很多參數構造瞭這個parser處理器。

parser.parse(candidates)中，把啟動類對應的beanDefinitionHolder對象傳進去瞭。

下面看看這個parse方法。

🔶 parse()方法

2.2.7 ConfigurationClassParser

🔶 parse()方法

🔶 processConfigurationClass()方法

🔶 doProcessConfigurationClass()方法

if (configClass.getMetadata().isAnnotated(Component.class.getName())) { ... }

判斷啟動類上是否加上瞭@Component註解，這裡的if條件成立。

因為@SpringBootApplication包含@SpringBootConfiguration，@SpringBootConfiguration包含@Configuration，@Configuration包含@Component，所以加上瞭@SpringBootApplication註解就相當於加上瞭@Component註解。

🔶 processMemberClasses()方法

裡面有很多處理各類註解的方法

// Process any @PropertySource annotations
// Process any @ComponentScan annotations
// Process any @Import annotations
// Process any @ImportResource annotations
// Process individual @Bean methods

後續將要對這個集合進行掃描，那麼看看它是如何掃描的。

2.2.8 ComponentScanAnnotationParser

🔶 parse()方法

ClassUtils.getPackageName(declaringClass)：獲取啟動類所在的包，根據傳入類的全類名獲取包名。

scanner.doScan(StringUtils.toStringArray(basePackages))：掃描啟動類所在的包

2.3 結論

在容器刷新時會調用BeanFactoryPostProcessor（Bean工廠後置處理器）進行處理。其中就有一個ConfigurationClassPostProcessor（配置類處理器）。在這個處理器中使用ConfigurationClassParser（配置類解析器）的parse方法去解析處理我們的配置類，其中就有對ComponentScan註解的解析處理。會去使用ComponentScanAnnotationParser的parse方法去解析。解析時如果發現沒有配置basePackage，它會去獲取我們加載瞭註解的這個類所在的包，作為我們的basepackage進行組件掃描。

到此這篇關於SpringBoot詳細探究講解默認組件掃描的文章就介紹到這瞭,更多相關SpringBoot組件掃描內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：