Spring啟動過程原始碼分析基本概念

薩科拉發表於2021-10-20
Spring原始碼

Spring啟動過程原始碼分析基本概念

本文是通過AnnotationConfigApplicationContext讀取配置類來一步一步去了解Spring的啟動過程。

在看原始碼之前，我們要知道某些類的作用，這樣更方便後續的瞭解。

1、BeanDefinition

BeanDefinition就是Bean的定義，它是用來描述Bean的，裡面存放著關於Bean的一系列資訊，比如Bean的作用域，Bean所對應的Class，是否懶載入等等，BeanDfinition與Bean的關係可以看作是類和class的關係，那麼有人說，有class物件就好啦，但是Class不能完完全全的抽象出Bean，比如說，Bean的注入模型，是否懶載入，是否是工廠bean等等，這些是class無法去抽象出來的，所以需要BeanDefinition來描述Bean，在Spring中，我們可以通過<Bean><Bean/>、@Component、BeanDefinition來定義Bean

//定義一個BeanDefinition
AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition().getBeanDefinition();
//設定當前bean的class 1、通過class獲取 2、通過類的全限定類名獲取
//beanDefinition.setBeanClass(Testt.class);
beanDefinition.setBeanClassName("com.beans.Testt");
//將beanDefinition註冊到BeanFactory中
DefaultListableBeanFactory factory = new DefaultListableBeanFactory();
factory.registerBeanDefinition("BEAN",beanDefinition);
//獲取Bean
factory.getBean("BEAN");

 

還可以直接使用RootBeanDefinition來獲取BeanDefinition

//生成BeanDefinition
RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Testt.class);
DefaultListableBeanFactory factory = new DefaultListableBeanFactory();
//將BeanDefinition註冊到工廠中
factory.registerBeanDefinition("tt",rootBeanDefinition);
Object tt = factory.getBean("tt");
System.out.println(tt);

 

通過上述三種方式我們就可以定義一個Bean。

假設我們有一個實體類Testt

public class Testt {
    public String name;
    public void sayHello(){
        System.out.println("Hello World!");
    }
    public void setName(String name){
        this.name = name;
    }
    public String getName(){
        return name;
    }
}

 

我們還可以通過beanDefinition來給name屬性賦值

//生成一個BeanDefinition
RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Testt.class);
//賦值屬性name為123
rootBeanDefinition.getPropertyValues().addPropertyValue("name","123");
//獲取name的值
Object name = rootBeanDefinition.getPropertyValues().getPropertyValue("name").getValue();
DefaultListableBeanFactory factory = new DefaultListableBeanFactory();
factory.registerBeanDefinition("tt",rootBeanDefinition);
Testt tt = (Testt) factory.getBean("tt");
System.out.println(tt);
//通過例項獲取name的值
String name1 = tt.getName();
System.out.println(name1); //123
System.out.println(name);//123

 

BeanDefinition還可以

beanDefinition.setScope("prototype"); // 設定作用域
beanDefinition.setInitMethodName("init"); // 設定初始化方法
beanDefinition.setAutowireMode(0); // 設定自動裝配模型 0預設裝配模式不自動注入，1 ByName 2 ByType 3 構造器注入 
......

 

BeanDefinition還有很多功能，在這裡就不一一去說明了，感興趣的讀者可以通過檢視beanDefinition的介面和實現類對其一一瞭解。

無論通過哪種方式來定義Bean，都會被解析為BeanDefinition物件，總之，Bean與BeanDefinition之間的關係你是可以看作是類和class的關係，這樣就很容易去理解它了。

 

這裡有一個mergedBeanDefinitions，我們來說一下它是做什麼的，mergedBeanDefinitions是儲存合併後的BeanDefinition的ConcurrentHashMap,Spring會對BeanDefinition進行合併，基於合併後的BeanDefinition去建立Bean

private final Map<String, RootBeanDefinition> mergedBeanDefinitions = new ConcurrentHashMap<>(256);

 

那麼，什麼時候beanDefinition會進行合併呢？我們舉出下列的一個例子，來帶大家一探究竟

首先寫一個Spring.xml，我們通過xml檔案去宣告bean

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans                          
                           http://www.springframework.org/schema/beans/spring-beans.xsd">
       <bean id="parent" scope="prototype"/>
       <bean id="children" parent="parent"/>
</beans>

 

這裡，我們指將parent的scope設定為prototype，而children並沒有去設定他的scope屬性，預設就是單例的，我們通過下面方式去除錯，看看mergedBeanDefinitions中到底存的是什麼

public class mainT {
    public static void main(String[] args) {
        ClassPathXmlApplicationContext classPathXmlApplicationContext =
                                                        new ClassPathXmlApplicationContext("Spring.xml");
        classPathXmlApplicationContext.getBean("children");
    }
}

 

我們通過在getBean上打上斷點，進行除錯後，我們可以看到FactoryBean中的mergedBeanDefinitions存的引數如下圖所示

 

children的scope屬性也成為了prototype，這就是合併後的BeanDefinition。其實就相當於子類繼承父類的時候包含父類的屬性

這裡還要記錄一下RootBeanDefinition和GenericBeanDefinition的顯在區別

可以發現GenericBeanDefinition的SetParentName是正常的，可以新增

public void setParentName(@Nullable String parentName) {
        this.parentName = parentName;
    }

 

而RootBeanDefinition是會報錯的，也會直接返回null

        @Override
    public String getParentName() {
        return null;
    }

    @Override
    public void setParentName(@Nullable String parentName) {
        if (parentName != null) {
            throw new IllegalArgumentException("Root bean cannot be changed into a child bean with parent reference");
        }
    }

 

2、beanFactory

從名字來看，這是一個工廠類，它負責生產和管理bean，在Spring中，BeanFactory是IOC容器的核心介面，他有很多職責和功能，它的核心實現類是DefaultListableBeanefauFactory類。下圖是DefaultListableBeanefauFactory類的UML圖。

 

DefaultListableBeanefauFactory實現了很多介面，也說明了DefaultListableBeanefauFactory類繼承了很多功能

我們可以通過beanfactory做很多事，例如：

AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition().getBeanDefinition();
beanDefinition.setBeanClass(Testt.class);
DefaultListableBeanFactory factory = new DefaultListableBeanFactory();
//註冊BeanDefinition
factory.registerBeanDefinition("Testt",beanDefinition);
//註冊別名
factory.registerAlias("Testt","T");
//獲取bean
Object alias = factory.getBean("T");
System.out.println(alias);//com.beans.Testt@6b1274d2
//通過型別獲取Bean
String[] beanNamesForType = factory.getBeanNamesForType(Testt.class);
System.out.println(beanNamesForType[0]);//Testt
//獲取BeanDefinition
BeanDefinition testt = factory.getBeanDefinition("Testt");
System.out.println(testt);
//Generic bean: class [com.beans.Testt]; scope=; abstract=false; lazyInit=null; autowireMode=0; //dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; //initMethodName=null; destroyMethodName=null
//獲取BeanDefinition個數
int beanDefinitionCount = factory.getBeanDefinitionCount();
System.out.println(beanDefinitionCount);
//獲取Bean的提供者
ObjectProvider<Testt> beanProvider = factory.getBeanProvider(Testt.class);    System.out.println(beanProvider);
//org.springframework.beans.factory.support.DefaultListableBeanFactory$1@6a472554

 

等等。

ApplicationContext繼承BeanFactory介面，它是Spring的一種更更高階的容器，提供了更多有用的功能，我們可以看到ApplicationContext的實現類GenericApplicationContext中有一個屬性

private final DefaultListableBeanFactory beanFactory;

 

那麼他既然已經繼承了BeanFactory介面，為什麼又要增加一個DefaultListableBeanFactory屬性呢，可以從上面看到DefaultListableBeanFactory實現了很多介面，擁有很多功能，這麼做的目的就是，使GenericApplicationContext通過DefaultListableBeanFactory間接擁有了DefaultListableBeanFactory繼承的那些功能，而無需在去繼承或者實現。o

這裡要說明一下別名和beanName的儲存，也是通過map去儲存的，{aliasname:beanname}，key為別名，value為bean的名字

3、BeanDefinitionReader

可以直接把某個類轉換為BeanDefinition，並且會解析該類上的註解，

它能解析的註解是：@Conditional，@Scope、@Lazy、@Primary、@DependsOn、@Role、@Description

DefaultListableBeanFactory factory = new DefaultListableBeanFactory();
AnnotatedBeanDefinitionReader Reader = new AnnotatedBeanDefinitionReader(factory);
/**
* 也可以使用registerBean(Testt.class) 或者 registerBean(Testt.class,"指定Bean名字")
**/
Reader.register(Testt.class);
Object testt = factory.getBean("testt");
System.out.println(testt);

 

 

4、ClassPathBeanDefinitionScanner

這個並不是BeanDefinitionReader，但是它的作用和BeanDefinitionReader類似，它可以進行掃描，掃描某個包路徑，對掃描到的類進行解析，比如，掃描到的類上如果存在@Component註解，那麼就會把這個類解析為一個BeanDefinition

DefaultListableBeanFactory factory = new DefaultListableBeanFactory();
ClassPathBeanDefinitionScanner classPathBeanDefinitionScanner = new ClassPathBeanDefinitionScanner(factory);
//得到該包下類的個數
//        int scan = classPathBeanDefinitionScanner.scan("com.beans");
//        System.out.println(scan);//6
//掃描沒有加@Componment註解的類，並註冊到容器中，未通過註解或其他方式定義Bean的類也不會新增到容器中
//classPathBeanDefinitionScanner.addExcludeFilter(new AnnotationTypeFilter(Component.class));
//掃描加了@Componment註解的類，並註冊到容器中
classPathBeanDefinitionScanner.addIncludeFilter(new AnnotationTypeFilter(Component.class));
//獲取bean
Object bean = factory.getBean(BeanTest.class);
System.out.println(bean);//com.beans.BeanTest@5ccddd20

 

5、ConditionEvaluator

ConditionEvaluator是一個Spring中的內部類，他提供了@Condition註解的判定條件作用，具體可以看它的shouldSkip方法。

 

6、Aware

Aware翻譯過來是感知的意思，他的用意是用來讓使用者感知到一些資訊，比如說BeanNameAware

@Component
public class User implements BeanNameAware {
    private String awareName;
    @Override
    public void setBeanName(String name) {
        this.awareName = name;
    }
    public String getAwareName(){
        return awareName;
    }
}

 

我們寫一個User類來實現BeanNameAware，重寫它的方法setBeanName，並將其賦值給我們的awareName

@ComponentScan("com.beans")
public class mainT {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(mainT.class);
        User bean = context.getBean(User.class);
        System.out.println(bean.getAwareName());
    }
}

 

 

結果顯示，得到的bean的名字。

 

相關文章