springIOC源碼分析（2）

2019-11-14 15:24:53

字體：大中小

來源：轉載

供稿：網友

refresh這個方法包含了整個BeanFactory初始化的過程，定位資源由obtainFreshBeanFactory()來完成,

[java] view plaincopy

PRotected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
refreshBeanFactory();
ConfigurableListableBeanFactory beanFactory = getBeanFactory();
if (logger.isDebugEnabled()) {
logger.debug("Bean factory for " + getDisplayName() + ": " + beanFactory);
}
return beanFactory;
}

可以看到其調用了refreshBeanFactory()，refreshBeanFactory()在這個類中是抽象方法，其實現在AbstractRefreshableapplicationContext中。

[java] view plaincopy

protected final void refreshBeanFactory() throws BeansException {
if (hasBeanFactory()) {
destroyBeans();
closeBeanFactory();
}
try {
DefaultListableBeanFactory beanFactory = createBeanFactory();
beanFactory.setSerializationId(getId());
customizeBeanFactory(beanFactory);
loadBeanDefinitions(beanFactory);
synchronized (this.beanFactoryMonitor) {
this.beanFactory = beanFactory;
}
}
catch (IOException ex) {
……
}
}

在這個方法中，先判斷BeanFactory是否存在，如果存在則先銷毀beans并關閉beanFactory，接著創建DefaultListableBeanFactory，并調用loadBeanDefinitions(beanFactory)裝載bean定義。loadBeanDefinitions方法同樣是抽象方法，是由其子類實現的，也即在AbstractxmlApplicationContext中。

[java] view plaincopy

protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws IOException {
// 這里使用XMLBeanDefinitionReader來載入bean定義信息的XML文件
XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
//這里配置reader的環境，其中ResourceLoader是我們用來定位bean定義信息資源位置的
//因為上下文本身實現了ResourceLoader接口，所以可以直接把上下文作為ResourceLoader傳遞給XmlBeanDefinitionReader
beanDefinitionReader.setResourceLoader(this);
beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));
initBeanDefinitionReader(beanDefinitionReader);
//這里轉到定義好的XmlBeanDefinitionReader中對載入bean信息進行處理
loadBeanDefinitions(beanDefinitionReader);
}

接著我們轉到beanDefinitionReader中進行處理

[java] view plaincopy

protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException {
Resource[] configResources = getConfigResources();
if (configResources != null) {
//調用XmlBeanDefinitionReader來載入bean定義信息。
reader.loadBeanDefinitions(configResources);
}
String[] configLocations = getConfigLocations();
if (configLocations != null) {
reader.loadBeanDefinitions(configLocations);
}
}

可以到org.springframework.beans.factory.support看一下BeanDefinitionReader的結構

在其抽象父類AbstractBeanDefinitionReader中定義了載入過程

[java] view plaincopy

public int loadBeanDefinitions(String location) throws BeanDefinitionStoreException {
//這里得到當前定義的ResourceLoader,默認的我們使用DefaultResourceLoader
ResourceLoader resourceLoader = getResourceLoader();
//如果沒有找到我們需要的ResourceLoader，直接拋出異常
if (resourceLoader instanceof ResourcePatternResolver) {
// 這里處理我們在定義位置時使用的各種pattern,需要 ResourcePatternResolver來完成
try {
Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location);
int loadCount = loadBeanDefinitions(resources);
return loadCount;
}
........
}
else {
// 這里通過ResourceLoader來完成位置定位
Resource resource = resourceLoader.getResource(location);
// 這里已經把一個位置定義轉化為Resource接口，可以供XmlBeanDefinitionReader來使用了
int loadCount = loadBeanDefinitions(resource);
return loadCount;
}
}

看到第8、16行，結合上面的ResourceLoader與ApplicationContext的繼承關系圖，可以知道此時調用的是DefaultResourceLoader中的getSource()方法定位Resource，因為ClassPathXmlApplicationContext本身就是DefaultResourceLoader的實現類，所以此時又回到了ClassPathXmlApplicationContext中來。

繼續回到XmlBeanDefinitionReader的loadBeanDefinitions(Resource …)方法看得到代表bean文件的資源定義以后的載入過程。

[java] view plaincopy

public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
.......
try {
//這里通過Resource得到InputStream的IO流
InputStream inputStream = encodedResource.getResource().getInputStream();
try {
//從InputStream中得到XML的解析源
InputSource inputSource = new InputSource(inputStream);
if (encodedResource.getEncoding() != null) {
inputSource.setEncoding(encodedResource.getEncoding());
}
//這里是具體的解析和注冊過程
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}
finally {
//關閉從Resource中得到的IO流
inputStream.close();
}
}
.........
}
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
int validationMode = getValidationModeForResource(resource);
//通過解析得到DOM，然后完成bean在IOC容器中的注冊
Document doc = this.documentLoader.loadDocument(
inputSource, this.entityResolver, this.errorHandler, validationMode, this.namespaceAware);
return registerBeanDefinitions(doc, resource);
}
.......
}

在doLoadBeanDefinitions(…)先把定義文件解析為DOM對象，然后進行具體的注冊過程。

[java] view plaincopy

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
//具體的注冊過程，首先得到XmlBeanDefinitionDocumentReader來處理xml的bean定義文件
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
documentReader.setEnvironment(this.getEnvironment());
int countBefore = getRegistry().getBeanDefinitionCount();
//調用注冊方法
documentReader.registerBeanDefinitions(doc,createReaderContext(resource));
return getRegistry().getBeanDefinitionCount() - countBefore;
}

具體的過程在BeanDefinitionDocumentReader中完成,在DefaultBeanDefinitionDocumentReader的方法中完成bean定義文件的解析和IOC容器中bean的初始化。

[java] view plaincopy

public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
this.readerContext = readerContext;
logger.debug("Loading bean definitions");
Element root = doc.getDocumentElement();
doRegisterBeanDefinitions(root);
}

[java] view plaincopy

protected void doRegisterBeanDefinitions(Element root) {
……（注：省略號表示省略掉了代碼）
//通過代理delegate解析
BeanDefinitionParserDelegate parent = this.delegate;
this.delegate = createHelper(readerContext, root, parent);
preProcessXml(root);
parseBeanDefinitions(root, this.delegate);
postProcessXml(root);
this.delegate = parent;
}

[java] view plaincopy

protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
if (delegate.isDefaultNamespace(root)) {
//得到xml文件的子節點，比如各個bean節點
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)) {
//這里是解析過程的調用，對缺省的元素進行分析比如bean元素
parseDefaultElement(ele, delegate);
}
else {
delegate.parseCustomElement(ele);
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}

[java] view plaincopy

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
//對元素Import進行處理
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
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);
}
}

[java] view plaincopy

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
//委托給BeanDefinitionParserDelegate來完成對bean元素的處理，這個類包括了具體的bean解析過程。把解析bean文件得到的信息放在BeanDefinition里，它是bean信息的主要載體，也是IOC容器的管理對象。
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// Register the final decorated instance.
//向IOC容器注冊，實際是放到IOC容器的一個map里

[java] view plaincopy

BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
……
}
// Send registration event.
//這里向IOC容器發送事件，表示解析和注冊完成
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}

可以看到在processBeanDefinition中對具體bean元素的解析是交給BeanDefinitionParserDelegate來完成的。我們接著看其實現的函數：

[java] view plaincopy

public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {
……（省略）
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
if (beanDefinition != null) {
//BeanDefinition解析過程
……（省略）
String[] aliasesArray = StringUtils.toStringArray(aliases);
//將解析完的bean定義包裝后返回
return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
}
return null;
}

在這里對定義文件中的bean元素進行解析，得到AbstractBeanDefinition，并用BeanDefinitionHolder封裝后返回。

下面我們看解析完的bean如何在IOC容器中注冊：在BeanDefinitionReaderUtils中調用的是：

[java] view plaincopy

public static void registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
// Register bean definition under primary name.
//得到需要注冊bean的名字
String beanName = definitionHolder.getBeanName();
//調用IOC來注冊bean的過程，需要得到BeanDefinition
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
// Register aliases for bean name, if any.
//將別名通過IOC容器和bean聯系起來進行注冊
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String aliase : aliases) {
registry.registerAlias(beanName, aliase);
}
}
}

接著我們看看bean的注冊實現，從上面看到其調用的是BeanDefinitionRegistry的方法registerBeanDefinition完成注冊，跟蹤代碼可知BeanFactory容器的一個實現DefaultListableBeanFactory實現了這個接口并提供了注冊的具體實現：

[java] view plaincopy

public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)throws BeanDefinitionStoreException {
......
if (beanDefinition instanceof AbstractBeanDefinition) {
try {
((AbstractBeanDefinition) beanDefinition).validate();
}
catch (BeanDefinitionValidationException ex) {
//拋出異常BeanDefinitionStoreException
……
}
}
synchronized (this.beanDefinitionMap) {
Object oldBeanDefinition = this.beanDefinitionMap.get(beanName);
if (oldBeanDefinition != null) {
if (!this.allowBeanDefinitionOverriding) {
//拋出異常BeanDefinitionStoreException
……
}
else {
if (this.logger.isInfoEnabled()) {
……
}
}
}
else {
this.beanDefinitionNames.add(beanName);
this.frozenBeanDefinitionNames = null;
}
this.beanDefinitionMap.put(beanName, beanDefinition);
resetBeanDefinition(beanName);
}
}