spring 知識(shí)整理（二）：spring ioc 的一個(gè)簡(jiǎn)單例子

為了使用ioc，先撇開(kāi)我們常用的ApplicationContext，來(lái)個(gè)簡(jiǎn)單版的BeanFactory。

例子

先建一個(gè)maven項(xiàng)目

  • 添加SimpleBean

beldon.learn.ioc.sample.SimpleBean

package beldon.learn.ioc.sample;
public class SimpleBean {
    // something
}
  • 在resource 下添加個(gè) sample.xml
<?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="simpleBean" class="beldon.learn.ioc.sample.SimpleBean">
    </bean>
</beans>
  • 添加個(gè)SampleApplication

beldon.learn.ioc.sample.SampleApplication

package beldon.learn.ioc.sample;
import org.springframework.beans.factory.xml.XmlBeanFactory;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
public class SampleApplication {
    public static void main(String[] args) {
        Resource resource = new ClassPathResource("sample.xml");
        XmlBeanFactory factory = new XmlBeanFactory(resource);
        System.out.println(factory.containsBean("simpleBean"));
        SimpleBean bean = factory.getBean(SimpleBean.class);
        System.out.println(bean);
    }
}

運(yùn)行結(jié)果

true
beldon.learn.ioc.sample.SimpleBean@d7b1517

上面代碼簡(jiǎn)單地使用簡(jiǎn)單的spring ioc容器，先用ClassPathResource定位了sample.xml、然后通過(guò)XmlBeanFactory的構(gòu)造方法把resouce傳遞進(jìn)去，最后就可以通過(guò)XmlBeanFactory 來(lái)獲取定義的bean了。

源碼

先來(lái)看下XmlBeanFactory源碼。

package beldon.learn.ioc.sample;
import org.springframework.beans.factory.xml.XmlBeanFactory;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
public class XmlBeanFactory extends DefaultListableBeanFactory {
    private final XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(this);
    public XmlBeanFactory(Resource resource) throws BeansException {
        this(resource, null);
    }

    public XmlBeanFactory(Resource resource, BeanFactory parentBeanFactory) throws BeansException {
        super(parentBeanFactory);
        //被內(nèi)部的reader去加載。
        this.reader.loadBeanDefinitions(resource);
    }
}

XmlBeanFactory是繼承DefaultListableBeanFactory,實(shí)現(xiàn)就簡(jiǎn)單的幾行代碼，其通過(guò)構(gòu)造方法參數(shù)傳輸進(jìn)去的Resource是被內(nèi)部的XmlBeanDefinitionReader去加載。

也就是說(shuō)，如果我們不用XmlBeanFactory的話，自己也可以手動(dòng)寫(xiě)

package beldon.learn.ioc.sample;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.support.BeanDefinitionReader;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;

public class SampleApplication {
    public static void main(String[] args) {
        //資源定位
        Resource resource = new ClassPathResource("sample.xml");
        BeanDefinitionRegistry registry = new DefaultListableBeanFactory();
        BeanDefinitionReader reader = new XmlBeanDefinitionReader(registry);
        //加載BeanDefinitions
        reader.loadBeanDefinitions(resource);
        BeanFactory beanFactory = (BeanFactory) registry;
        System.out.println(beanFactory.containsBean("simpleBean"));
        SimpleBean bean = beanFactory.getBean(SimpleBean.class);
        System.out.println(bean);
    }
}

從上面代碼可以看出，簡(jiǎn)單的可以看出實(shí)現(xiàn)一個(gè)spring ioc，主要是Resource資源定位和BeanDefinitionReader加載beanDefinition的一個(gè)過(guò)程，而BeanDefinitionReader需要一個(gè)BeanDefinitionRegistry來(lái)完成beanDefinition的注冊(cè)。

注：至于Resource、BeanDefinitionRegistry、BeanDefinitionReader的說(shuō)明，可以看上一篇文章

代碼研究

從名字及注釋上看，XmlBeanDefinitionReader的作用就是把xml解析為BeanDefinition。

跟蹤XmlBeanDefinitionReader可以看到

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
    BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
    int countBefore = getRegistry().getBeanDefinitionCount();
    documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
    return getRegistry().getBeanDefinitionCount() - countBefore;
}

XmlBeanDefinitionReader最終的讓一個(gè)DefaultBeanDefinitionDocumentReader去讀取bean信息并注冊(cè)BeanDefinition。繼續(xù)追蹤下去。

org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader#doRegisterBeanDefinitions

protected void doRegisterBeanDefinitions(Element root) {
    BeanDefinitionParserDelegate parent = this.delegate;
    this.delegate = createDelegate(getReaderContext(), root, parent);

    if (this.delegate.isDefaultNamespace(root)) {
        String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
        if (StringUtils.hasText(profileSpec)) {
            String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
                profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
            if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
                if (logger.isInfoEnabled()) {
                    logger.info("Skipped XML bean definition file due to specified profiles [" + profileSpec +
                                "] not matching: " + getReaderContext().getResource());
                }
                return;
            }
        }
    }

    preProcessXml(root);
    //真正解析BeanDefinitions
    parseBeanDefinitions(root, this.delegate);
    postProcessXml(root);

    this.delegate = parent;
}

從上面代碼可以看出，真正解析的是parseBeanDefinitions(root, this.delegate);。繼續(xù)跟下去會(huì)發(fā)現(xiàn).

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
    BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
    if (bdHolder != null) {
        bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
        try {
            // Register the final decorated instance.
            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));
    }
}

DefaultBeanDefinitionDocumentReader最終是委派了一個(gè)BeanDefinitionParserDelegate來(lái)解析xml元素，把解析處來(lái)的BeanDefinitionHolder用

BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());

來(lái)注冊(cè)。而getReaderContext().getRegistry()拿到的BeanDefinitionRegistry就是我們一開(kāi)始傳進(jìn)去的DefaultListableBeanFactory。

再看下 BeanDefinitionReaderUtils.registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry) throws BeanDefinitionStoreException;

public static void registerBeanDefinition(
            BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
            throws BeanDefinitionStoreException {
    // Register bean definition under primary name.
    String beanName = definitionHolder.getBeanName();
    registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
    // Register aliases for bean name, if any.
    String[] aliases = definitionHolder.getAliases();
    if (aliases != null) {
        for (String alias : aliases) {
            registry.registerAlias(beanName, alias);
        }
    }
}

可以從上面代碼可以看出，最終是調(diào)用BeanDefinitionRegistry的void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) throws BeanDefinitionStoreException;來(lái)進(jìn)行BeanDefinition注冊(cè)。

總結(jié)

上面只是簡(jiǎn)單跟蹤了下XmlBeanDefinitionReader，目的是為了清楚spring ioc的加載的一個(gè)過(guò)程。這個(gè)過(guò)程主要分為三個(gè)步驟，分別是定位、加載，注冊(cè)。

  • 定位

定位主要是org.springframework.core.io.Resource的資源定位。ClassPathResource就是一個(gè)例子，除此之外還有FileSystemResource、PathResource、UrlResource、InputStreamResource等等。

  • 加載

加載其實(shí)就是把用戶定義bean的外部資源轉(zhuǎn)換成spring ioc可以讀的數(shù)據(jù)結(jié)構(gòu)，也就是轉(zhuǎn)換成BeanDefinition，上面sample的XmlBeanFactory就是通過(guò)xml中的bean標(biāo)簽來(lái)解析成BeanDefinition

  • 注冊(cè)

注冊(cè)就是上一步轉(zhuǎn)成的BeanDefinition通過(guò)BeanDefinitionRegistry來(lái)注冊(cè)。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容