Spring Bean生命週期之Bean元資訊的設定與解析階段詳解

2022-03-04 16:00:17

public class XmlBeanMetaDataConfigDemo {
    public static void main(String[] args) {
        DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
        XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
        int beanDefinitions = beanDefinitionReader.loadBeanDefinitions("META-INF/spring.xml");
        System.out.println("載入的BeanDefinition個數為:" + beanDefinitions);
		//User就是普通的POJO類 這裡不再給出User定義
        User user = beanFactory.getBean("user", User.class);
        System.out.println(user);
    }
}

<?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
        https://www.springframework.org/schema/beans/spring-beans.xsd">
    <bean id="user" class="com.wojiushiwo.dto.User">
        <property name="name" value="wojiushiwo"/>
        <property name="age" value="18"/>
    </bean>
</beans>

上面程式碼是使用BeanDefinitionReader去載入XML檔案中的Bean定義

BeanDefinitionReader體系

先來看一下BeanDefinitionReader的介面定義以及繼承關係

通過上面的類圖我們發現BeanDefinitionReader有三個實現類,可以看出針對BeanDefiniiton的不同載體均提供瞭解析手段，有XML形式的、有Properties形式的等等。

BeanDefinitionReader介面定義

public interface BeanDefinitionReader {
  //返回註冊了當前BeanDefinition的 BeanFactory
	BeanDefinitionRegistry getRegistry();
	@Nullable
	ResourceLoader getResourceLoader();
	@Nullable
	ClassLoader getBeanClassLoader();
	//BeanName 生成器，預設是DefaultBeanNameGenerator
	BeanNameGenerator getBeanNameGenerator();

  //從指定資源中載入BeanDefinition，並返回載入到的BeanDefinition的個數
	int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException;
	int loadBeanDefinitions(Resource... resources) throws BeanDefinitionStoreException;
	//從指定資源路徑中中載入BeanDefinition，並返回載入到的BeanDefinition的個數
	int loadBeanDefinitions(String location) throws BeanDefinitionStoreException;
	int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException;
}

由於Bean元資訊的設定與解析是息息相關的，下面的一些例子也是將它們揉在一起討論的。

元資訊設定與解析方式

1、API方式

這種方式直接採用BeanDefinitionAPI 來構成Bean元資訊，並將其注入到IoC容器中，這裡主要使用到BeanDefinitionBuilder或GenericBeanDefinition兩種方式來建立Bean元資訊

關於BeanDefinition這個議題的討論會放在其他篇章中，這裡不再贅述了。

public class ApiBeanMetaDataConfigDemo {
    public static void main(String[] args) {
        //建立註解相關的上下文
        AnnotationConfigApplicationContext context=new AnnotationConfigApplicationContext();
	    //建立GenericBeanDefinition			
        GenericBeanDefinition beanDefinition=new GenericBeanDefinition();
        //設定BeanClass
        beanDefinition.setBeanClass(User.class);
        //設定屬性
        MutablePropertyValues propertyValues=new MutablePropertyValues();
        propertyValues.addPropertyValue("name","我就是我");
        propertyValues.addPropertyValue("age",18);
        beanDefinition.setPropertyValues(propertyValues);
		//註冊BeanDefinition
        context.registerBeanDefinition("user",beanDefinition);
		//重新整理IoC容器
        context.refresh();
		//獲取Bean
        User user = context.getBean("user", User.class);
        System.out.println(user);
		//關閉上下文
        context.close();
    }
}

2、面向XML設定

從XML設定資源處載入BeanDefinition

<?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
        https://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="user" class="com.wojiushiwo.dto.User">
        <property name="name" value="wojiushiwo"/>
        <property name="age" value="18"/>
    </bean>
</beans>

public class XmlBeanMetaDataConfigDemo {
    public static void main(String[] args) {
        DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
        XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
        //載入指定檔案的BeanDefinition，並獲取載入地BeanDefinition個數
        int beanDefinitions = beanDefinitionReader.loadBeanDefinitions("META-INF/spring.xml");
        System.out.println("載入的BeanDefinition個數為:" + beanDefinitions);
        User user = beanFactory.getBean("user", User.class);
        System.out.println(user);
    }
}

3、面向Properties設定

這種設定方式不太常用，設定資源時需要遵守規則，設定規則可參考PropertiesBeanDefinitionReader註釋檔案，其規則如下

Properties 屬性名	使用場景
(class) Bean	類全稱限定名
(abstract)	是否為抽象的 BeanDefinition
(parent)	指定 parent BeanDefinition 名稱
(lazy-init)	是否為延遲初始化
(ref)	參照其他 Bean 的名稱
(scope)	設定 Bean 的 scope 屬性
${n}	n 表示第 n+1 個構造器引數

## 指定BeanClass
user.(class)=com.wojiushiwo.dto.User
## 屬性
user.name=我就是我
user.age=19

public class PropertiesBeanMetaDataConfigDemo {
    public static void main(String[] args) {
        DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
        PropertiesBeanDefinitionReader beanDefinitionReader = new PropertiesBeanDefinitionReader(beanFactory);
        ClassPathResource classPathResource=new ClassPathResource("META-INF/user.properties");
        EncodedResource resource=new EncodedResource(classPathResource,"UTF-8");
        int beanDefinitions = beanDefinitionReader.loadBeanDefinitions(resource);
        System.out.println("載入的BeanDefinition個數為:" + beanDefinitions);
        User user = beanFactory.getBean("user", User.class);
        System.out.println(user);
    }
}

上面 Properties檔案預設讀寫編碼為ISO-8859-1 因此這種直接載入方式會出現中文亂碼，可通過載入在載入資源時指定編碼方式來解決

4、面向註解

比如@Autowired、@Bean、@Component、@Configuration等，這些在當下都比較常用不再贅述

XmlBeanDefinitionReader元資訊解析原始碼分析

下面就XmlBeanDefinitionReader呼叫鏈中比較重要的地方進行分析

protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
			throws BeanDefinitionStoreException {
		try {
		    //解析Xml檔案生成Document，這裡不再展開
			Document doc = doLoadDocument(inputSource, resource);
			// 解析Document 註冊BeanDefinition
			int count = registerBeanDefinitions(doc, resource);
			//省略紀錄檔列印
			return count;
		}
		catch (BeanDefinitionStoreException ex) {
			//... 異常及紀錄檔
			}
	}

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
        //獲取DefaultBeanDefinitionReader
		BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
		//獲取IoC容器中 已經存在的BeanDefinition的個數
		int countBefore = getRegistry().getBeanDefinitionCount();
		//這裡實際上執行解析Document檔案樹 註冊BeanDefinition
		documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
		//返回此次載入的BeanDefinition個數
		return getRegistry().getBeanDefinitionCount() - countBefore;
	}

protected void doRegisterBeanDefinitions(Element root) {
		BeanDefinitionParserDelegate parent = this.delegate;
		this.delegate = createDelegate(getReaderContext(), root, parent);
		// namespace=http://www.springframework.org/schema/beans 表示為預設名稱空間 則使用預設的解析方式去解析元素，否則將採用NamespaceHandler去解析
		if (this.delegate.isDefaultNamespace(root)) {
		    //獲取profile屬性，profile與Spring設定環境有關係
			String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
			//如果設定了profile
			if (StringUtils.hasText(profileSpec)) {
				String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
						profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
      //如果當前Environment環境與profile不匹配 則流程結束
				if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
					//省略紀錄檔
					return;
				}
			}
		}
	    //解析xml前置操作		
		preProcessXml(root);
		//解析xml
		parseBeanDefinitions(root, this.delegate);
		//解析xml後置操作
		postProcessXml(root);
		this.delegate = parent;
	}

關於上面原始碼分析中profile以及NameSpace的理解請看這裡的XML

<beans
        xmlns="http://www.springframework.org/schema/beans" 
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd" profile="dev">
        <!-- 一些設定-->
</beans>

可以看出 xmlns所指代的就是namespace，而profile也可以設定在beans標籤上，其中

http://www.springframework.org/schema/beans

表示預設名稱空間。因為Spring允許自定義標籤，所以通過是否為預設名稱空間作為判斷依據來選擇使用不同的解析方式去解析標籤

protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
		//如果是預設名稱空間
		if (delegate.isDefaultNamespace(root)) {
			NodeList nl = root.getChildNodes();
			for (int i = 0; i < nl.getLength(); i++) {
				Node node = nl.item(i);
				if (node instanceof Element) {
					Element ele = (Element) node;
					if (delegate.isDefaultNamespace(ele)) {
						parseDefaultElement(ele, delegate);
					}
					else {
					    // 使用NamespaceHandler去解析標籤，比如ContextNamespaceHandler去解析<context:xx>的標籤等
						delegate.parseCustomElement(ele);
					}
				}
			}
		}
		else {
		  // 使用NamespaceHandler去解析標籤，比如ContextNamespaceHandler去解析<context:xx>的標籤等
			delegate.parseCustomElement(root);
		}
	}

上面的程式碼邏輯，根據是否為預設名稱空間從而選擇不同的解析方式，自定義標籤或非預設名稱空間指令需要繼承NamespaceHandler去實現自己的標籤解析方式

非預設名稱空間指令舉例

<context:component-scan base-package="com.wojiushiwo"/><aop:xx></aop><context:component-scan base-package="com.wojiushiwo"/>
<aop:xx></aop>

這裡直接看針對預設名稱空間的解析程式碼

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
        //如果是import指令
		if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
			importBeanDefinitionResource(ele);
		}
		//如果是alias指令
		else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
			processAliasRegistration(ele);
		}
		//如果是bean指令
		else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
			processBeanDefinition(ele, delegate);
		}
		else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
			// recurse
			doRegisterBeanDefinitions(ele);
		}
	}

針對bean指令

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
		BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
		if (bdHolder != null) {
			bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
			try {
//使用BeanRegistry對BeanDefinition進行註冊		BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
			}
			catch (BeanDefinitionStoreException ex) {
				getReaderContext().error("Failed to register bean definition with name '" +
						bdHolder.getBeanName() + "'", ele, ex);
			}
			// Send registration event.
			getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
		}
	}

我們再來梳理下主要流程：

1、解析Xml檔案生成Document

2、針對Document名稱空間進行標籤解析

預設名稱空間標籤解析
非預設名稱空間或自定義標籤自行實現NamespaceHandler去解析(Spring 內建了一些NamespaceHandler解析自定義標籤)

3、使用BeanRegistry對BeanDefinition進行註冊

AnnotatedBeanDefinitionReader元資訊解析原始碼分析

AnnotatedBeanDefinitionReader從名稱上看它似乎與BeanDefinitionReader有千絲萬縷的關係，實質上二者沒有關係。
AnnotatedBeanDefinitionReader主要是對註解Bean進行解析的。

先舉例說明下

@Configuration
public class BeanInitializationDemo {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
        // 註冊 Configuration Class（設定類）
      applicationContext.register(BeanInitializationDemo.class);
        // 啟動 Spring 應用上下文
        applicationContext.refresh();
        applicationContext.close();
    }
}

藉助上面的例子我們看一下其呼叫流程

以上面的例子來看，AnnotationBeanDefinitionReader的建立是在AnnotationConfigApplicationContext建構函式中進行的。

public class AnnotationConfigApplicationContext extends GenericApplicationContext implements AnnotationConfigRegistry {
	private final AnnotatedBeanDefinitionReader reader;
	private final ClassPathBeanDefinitionScanner scanner;
	public AnnotationConfigApplicationContext() {
	  //建立AnnotatedBeanDefinitionReader
		this.reader = new AnnotatedBeanDefinitionReader(this);
		this.scanner = new ClassPathBeanDefinitionScanner(this);
	}
}

public static void registerBeanDefinition(
			BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
			throws BeanDefinitionStoreException {
		// 獲取BeanName
		String beanName = definitionHolder.getBeanName();
		//註冊bd到IoC容器
		registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
		// 如果bean存在別名，則將beanName與alias的關係也存起來
		String[] aliases = definitionHolder.getAliases();
		if (aliases != null) {
			for (String alias : aliases) {
				registry.registerAlias(beanName, alias);
			}
		}
	}

透過上面XmlBeanDefinitionReader和AnnotationBeanDefinitionReader對BeanDefinition的解析來看，最終BeanDefinition的註冊都指向了BeanDefinitionReaderUtils.registerBeanDefinition。我們先來大概看一下程式碼實現

public static void registerBeanDefinition(
			BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
			throws BeanDefinitionStoreException {
		// 獲取BeanName
		String beanName = definitionHolder.getBeanName();
		//註冊bd到IoC容器
		registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
		// 如果bean存在別名，則將beanName與alias的關係也存起來
		String[] aliases = definitionHolder.getAliases();
		if (aliases != null) {
			for (String alias : aliases) {
				registry.registerAlias(beanName, alias);
			}
		}
	}