`

IOC实现原理

阅读更多

对Spring IOC的理解离不开对依赖反转模式的理解,我们知道,关于如何反转对依赖的控制,把控制权从具体业务对象手中转交到平台或者框架中,是解决面向对象系统设计复杂性和提高面向对象系统可测试性的一个有效的解决方案。这个问题触发了IoC设计模式的发展,是IoC容器要解决的核心问题。同时,也是产品化的IoC容器出现的推动力。而我觉得Spring的IoC容器,就是一个开源的实现依赖反转模式的产品。

那具体什么是IoC容器呢?它在Spring框架中到底长什么样?说了这么多,其实对IoC容器的使用者来说,我们常常接触到的BeanFactory和ApplicationContext都可以看成是容器的具体表现形式。这些就是IoC容器,或者说在Spring中提IoC容器,从实现来说,指的是一个容器系列。这也就是说,我们通常所说的IoC容器,如果深入到Spring的实现去看,会发现IoC容器实际上代表着一系列功能各异的容器产品。只是容器的功能有大有小,有各自的特点。打个比方来说,就像是百货商店里出售的商品,我们举水桶为例子,在商店中出售的水桶有大有小;制作材料也各不相同,有金属的,有塑料的等等,总之是各式各样,但只要能装水,具备水桶的基本特性,那就可以作为水桶来出售来让用户使用。这在Spring中也是一样,它有各式各样的IoC容器的实现供用户选择和使用;使用什么样的容器完全取决于用户的需要,但在使用之前如果能够了解容器的基本情况,那会对容器的使用是非常有帮助的;就像我们在购买商品时进行的对商品的考察和挑选那样。

我们从最基本的XmlBeanFactory看起,它是容器系列的最底层实现,这个容器的实现与我们在Spring应用中用到的那些上下文相比,有一个非常明显的特点,它只提供了最基本的IoC容器的功能。从它的名字中可以看出,这个IoC容器可以读取以XML形式定义的BeanDefinition。理解这一点有助于我们理解ApplicationContext与基本的BeanFactory之间的区别和联系。我们可以认为直接的BeanFactory实现是IoC容器的基本形式,而各种ApplicationContext的实现是IoC容器的高级表现形式。

仔细阅读XmlBeanFactory的源码,在一开始的注释里面已经对 XmlBeanFactory的功能做了简要的说明,从代码的注释还可以看到,这是Rod Johnson在2001年就写下的代码,可见这个类应该是Spring的元老类了。它是继承DefaultListableBeanFactory这个类的,这个DefaultListableBeanFactory就是一个很值得注意的容器!

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);   
        this.reader.loadBeanDefinitions(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);
                this.reader.loadBeanDefinitions(resource);
        }
}

 

XmlBeanFactory的功能是建立在DefaultListableBeanFactory这个基本容器的基础上的,在这个基本容器的基础上实现了其他诸如XML读取的附加功能。对于这些功能的实现原理,看一看XmlBeanFactory的代码实现就能很容易地理解。在如下的代码中可以看到,在XmlBeanFactory构造方法中需要得到Resource对象。对XmlBeanDefinitionReader对象的初始化,以及使用这个这个对象来完成loadBeanDefinitions的调用,就是这个调用启动了从Resource中载入BeanDefinitions的过程,这个loadBeanDefinitions同时也是IoC容器初始化的重要组成部分。

简单来说,IoC容器的初始化包括BeanDefinition的Resouce定位、载入和注册这三个基本的过程。我觉得重点是在载入和对BeanDefinition做解析的这个过程。可以从DefaultListableBeanFactory来入手看看IoC容器是怎样完成BeanDefinition载入的。在refresh调用完成以后,可以看到loadDefinition的调用:

public abstract class AbstractXmlApplicationContext extends AbstractRefreshableConfigApplicationContext {   
    public AbstractXmlApplicationContext() {   
    }   
    public AbstractXmlApplicationContext(ApplicationContext parent) {   
        super(parent);   
    }   
    //这里是实现loadBeanDefinitions的地方   
    protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws IOException {   
        // Create a new XmlBeanDefinitionReader for the given BeanFactory.   
        // 创建 XmlBeanDefinitionReader,并通过回调设置到 BeanFactory中去,创建BeanFactory的使用的也是 DefaultListableBeanFactory。   
        XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);   
  
        // Configure the bean definition reader with this context's   
        // resource loading environment.   
        // 这里设置 XmlBeanDefinitionReader, 为XmlBeanDefinitionReader 配置ResourceLoader,因为DefaultResourceLoader是父类,所以this可以直接被使用   
        beanDefinitionReader.setResourceLoader(this);   
        beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));   
  
        // Allow a subclass to provide custom initialization of the reader,   
        // then proceed with actually loading the bean definitions.   
    // 这是启动Bean定义信息载入的过程   
        initBeanDefinitionReader(beanDefinitionReader);   
        loadBeanDefinitions(beanDefinitionReader);   
    }   
  
    protected void initBeanDefinitionReader(XmlBeanDefinitionReader beanDefinitionReader) {   
    }  

public abstract class AbstractXmlApplicationContext extends AbstractRefreshableConfigApplicationContext {
        public AbstractXmlApplicationContext() {
        }
        public AbstractXmlApplicationContext(ApplicationContext parent) {
                super(parent);
        }
        //这里是实现loadBeanDefinitions的地方
        protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws IOException {
                // Create a new XmlBeanDefinitionReader for the given BeanFactory.
                // 创建 XmlBeanDefinitionReader,并通过回调设置到 BeanFactory中去,创建BeanFactory的使用的也是 DefaultListableBeanFactory。
                XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);

                // Configure the bean definition reader with this context's
                // resource loading environment.
                // 这里设置 XmlBeanDefinitionReader, 为XmlBeanDefinitionReader 配置ResourceLoader,因为DefaultResourceLoader是父类,所以this可以直接被使用
                beanDefinitionReader.setResourceLoader(this);
                beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));

                // Allow a subclass to provide custom initialization of the reader,
                // then proceed with actually loading the bean definitions.
        // 这是启动Bean定义信息载入的过程
                initBeanDefinitionReader(beanDefinitionReader);
                loadBeanDefinitions(beanDefinitionReader);
        }

        protected void initBeanDefinitionReader(XmlBeanDefinitionReader beanDefinitionReader) {
        }

 

这里使用 XmlBeanDefinitionReader来载入BeanDefinition到容器中,如以下代码清单所示:

 //这里是调用的入口。   
    public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {   
        return loadBeanDefinitions(new EncodedResource(resource));   
    }   
    //这里是载入XML形式的BeanDefinition的地方。   
    public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {   
        Assert.notNull(encodedResource, "EncodedResource must not be null");   
        if (logger.isInfoEnabled()) {   
            logger.info("Loading XML bean definitions from " + encodedResource.getResource());   
        }   
  
        Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();   
        if (currentResources == null) {   
            currentResources = new HashSet<EncodedResource>(4);   
            this.resourcesCurrentlyBeingLoaded.set(currentResources);   
        }   
        if (!currentResources.add(encodedResource)) {   
            throw new BeanDefinitionStoreException(   
                    "Detected recursive loading of " + encodedResource + " - check your import definitions!");   
        }   
        //这里得到XML文件,并得到IO的InputSource准备进行读取。   
        try {   
            InputStream inputStream = encodedResource.getResource().getInputStream();   
            try {   
                InputSource inputSource = new InputSource(inputStream);   
                if (encodedResource.getEncoding() != null) {   
                    inputSource.setEncoding(encodedResource.getEncoding());   
                }   
                return doLoadBeanDefinitions(inputSource, encodedResource.getResource());   
            }   
            finally {   
                inputStream.close();   
            }   
        }   
        catch (IOException ex) {   
            throw new BeanDefinitionStoreException(   
                    "IOException parsing XML document from " + encodedResource.getResource(), ex);   
        }   
        finally {   
            currentResources.remove(encodedResource);   
            if (currentResources.isEmpty()) {   
                this.resourcesCurrentlyBeingLoaded.set(null);   
            }   
        }   
    }   
//具体的读取过程可以在doLoadBeanDefinitions方法中找到:   
    //这是从特定的XML文件中实际载入BeanDefinition的地方   
    protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)   
            throws BeanDefinitionStoreException {   
        try {   
            int validationMode = getValidationModeForResource(resource);   
            //这里取得XML文件的Document对象,这个解析过程是由 documentLoader完成的,这个documentLoader是DefaultDocumentLoader,在定义documentLoader的地方创建   
            Document doc = this.documentLoader.loadDocument(   
                    inputSource, getEntityResolver(), this.errorHandler, validationMode, isNamespaceAware());   
            //这里启动的是对BeanDefinition解析的详细过程,这个解析会使用到Spring的Bean配置规则,是我们下面需要详细关注的地方。   
            return registerBeanDefinitions(doc, resource);   
        }   
        catch (BeanDefinitionStoreException ex) {   
            throw ex;   
        }   
        catch (SAXParseException ex) {   
            throw new XmlBeanDefinitionStoreException(resource.getDescription(),   
                    "Line " + ex.getLineNumber() + " in XML document from " + resource + " is invalid", ex);   
        }   
        catch (SAXException ex) {   
            throw new XmlBeanDefinitionStoreException(resource.getDescription(),   
                    "XML document from " + resource + " is invalid", ex);   
        }   
        catch (ParserConfigurationException ex) {   
            throw new BeanDefinitionStoreException(resource.getDescription(),   
                    "Parser configuration exception parsing XML from " + resource, ex);   
        }   
        catch (IOException ex) {   
            throw new BeanDefinitionStoreException(resource.getDescription(),   
                    "IOException parsing XML document from " + resource, ex);   
        }   
        catch (Throwable ex) {   
            throw new BeanDefinitionStoreException(resource.getDescription(),   
                    "Unexpected exception parsing XML document from " + resource, ex);   
        }   
    }  

        //这里是调用的入口。
        public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {
                return loadBeanDefinitions(new EncodedResource(resource));
        }
        //这里是载入XML形式的BeanDefinition的地方。
        public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
                Assert.notNull(encodedResource, "EncodedResource must not be null");
                if (logger.isInfoEnabled()) {
                        logger.info("Loading XML bean definitions from " + encodedResource.getResource());
                }

                Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();
                if (currentResources == null) {
                        currentResources = new HashSet<EncodedResource>(4);
                        this.resourcesCurrentlyBeingLoaded.set(currentResources);
                }
                if (!currentResources.add(encodedResource)) {
                        throw new BeanDefinitionStoreException(
                                        "Detected recursive loading of " + encodedResource + " - check your import definitions!");
                }
                //这里得到XML文件,并得到IO的InputSource准备进行读取。
                try {
                        InputStream inputStream = encodedResource.getResource().getInputStream();
                        try {
                                InputSource inputSource = new InputSource(inputStream);
                                if (encodedResource.getEncoding() != null) {
                                        inputSource.setEncoding(encodedResource.getEncoding());
                                }
                                return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
                        }
                        finally {
                                inputStream.close();
                        }
                }
                catch (IOException ex) {
                        throw new BeanDefinitionStoreException(
                                        "IOException parsing XML document from " + encodedResource.getResource(), ex);
                }
                finally {
                        currentResources.remove(encodedResource);
                        if (currentResources.isEmpty()) {
                                this.resourcesCurrentlyBeingLoaded.set(null);
                        }
                }
        }
//具体的读取过程可以在doLoadBeanDefinitions方法中找到:
        //这是从特定的XML文件中实际载入BeanDefinition的地方
        protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
                        throws BeanDefinitionStoreException {
                try {
                        int validationMode = getValidationModeForResource(resource);
                        //这里取得XML文件的Document对象,这个解析过程是由 documentLoader完成的,这个documentLoader是DefaultDocumentLoader,在定义documentLoader的地方创建
                        Document doc = this.documentLoader.loadDocument(
                                        inputSource, getEntityResolver(), this.errorHandler, validationMode, isNamespaceAware());
                        //这里启动的是对BeanDefinition解析的详细过程,这个解析会使用到Spring的Bean配置规则,是我们下面需要详细关注的地方。
                        return registerBeanDefinitions(doc, resource);
                }
                catch (BeanDefinitionStoreException ex) {
                        throw ex;
                }
                catch (SAXParseException ex) {
                        throw new XmlBeanDefinitionStoreException(resource.getDescription(),
                                        "Line " + ex.getLineNumber() + " in XML document from " + resource + " is invalid", ex);
                }
                catch (SAXException ex) {
                        throw new XmlBeanDefinitionStoreException(resource.getDescription(),
                                        "XML document from " + resource + " is invalid", ex);
                }
                catch (ParserConfigurationException ex) {
                        throw new BeanDefinitionStoreException(resource.getDescription(),
                                        "Parser configuration exception parsing XML from " + resource, ex);
                }
                catch (IOException ex) {
                        throw new BeanDefinitionStoreException(resource.getDescription(),
                                        "IOException parsing XML document from " + resource, ex);
                }
                catch (Throwable ex) {
                        throw new BeanDefinitionStoreException(resource.getDescription(),
                                        "Unexpected exception parsing XML document from " + resource, ex);
                }
        }

 

关于具体的Spring BeanDefinition的解析,是在BeanDefinitionParserDelegate中完成的。这个类里包含了各种Spring Bean定义规则的处理,感兴趣的同学可以仔细研究。我们举一个例子来分析这个处理过程,比如我们最熟悉的对Bean元素的处理是怎样完成的,也就是我们在XML定义文件中出现的<bean></bean>这个最常见的元素信息是怎样被处理的。在这里,我们会看到那些熟悉的BeanDefinition定义的处理,比如id、name、aliase等属性元素。把这些元素的值从XML文件相应的元素的属性中读取出来以后,会被设置到生成的BeanDefinitionHolder中去。这些属性的解析还是比较简单的。对于其他元素配置的解析,比如各种Bean的属性配置,通过一个较为复杂的解析过程,这个过程是由parseBeanDefinitionElement来完成的。解析完成以后,会把解析结果放到BeanDefinition对象中并设置到BeanDefinitionHolder中去,如以下清单所示:

public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {   
        //这里取得在<bean>元素中定义的id、name和aliase属性的值   
        String id = ele.getAttribute(ID_ATTRIBUTE);   
        String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);   
  
        List<String> aliases = new ArrayList<String>();   
        if (StringUtils.hasLength(nameAttr)) {   
            String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, BEAN_NAME_DELIMITERS);   
            aliases.addAll(Arrays.asList(nameArr));   
        }   
  
        String beanName = id;   
        if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {   
            beanName = aliases.remove(0);   
            if (logger.isDebugEnabled()) {   
                logger.debug("No XML 'id' specified - using '" + beanName +   
                        "' as bean name and " + aliases + " as aliases");   
            }   
        }   
  
        if (containingBean == null) {   
            checkNameUniqueness(beanName, aliases, ele);   
        }   
  
        //这个方法会引发对bean元素的详细解析   
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);   
        if (beanDefinition != null) {   
            if (!StringUtils.hasText(beanName)) {   
                try {   
                    if (containingBean != null) {   
                        beanName = BeanDefinitionReaderUtils.generateBeanName(   
                                beanDefinition, this.readerContext.getRegistry(), true);   
                    }   
                    else {   
                        beanName = this.readerContext.generateBeanName(beanDefinition);   
                        // Register an alias for the plain bean class name, if still possible,   
                        // if the generator returned the class name plus a suffix.   
                        // This is expected for Spring 1.2/2.0 backwards compatibility.   
                        String beanClassName = beanDefinition.getBeanClassName();   
                        if (beanClassName != null &&   
                                beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&   
                                !this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {   
                            aliases.add(beanClassName);   
                        }   
                    }   
                    if (logger.isDebugEnabled()) {   
                        logger.debug("Neither XML 'id' nor 'name' specified - " +   
                                "using generated bean name [" + beanName + "]");   
                    }   
                }   
                catch (Exception ex) {   
                    error(ex.getMessage(), ele);   
                    return null;   
                }   
            }   
            String[] aliasesArray = StringUtils.toStringArray(aliases);   
            return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);   
        }   
  
        return null;   
    }  

public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {
                //这里取得在<bean>元素中定义的id、name和aliase属性的值
                String id = ele.getAttribute(ID_ATTRIBUTE);
                String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);

                List<String> aliases = new ArrayList<String>();
                if (StringUtils.hasLength(nameAttr)) {
                        String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, BEAN_NAME_DELIMITERS);
                        aliases.addAll(Arrays.asList(nameArr));
                }

                String beanName = id;
                if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
                        beanName = aliases.remove(0);
                        if (logger.isDebugEnabled()) {
                                logger.debug("No XML 'id' specified - using '" + beanName +
                                                "' as bean name and " + aliases + " as aliases");
                        }
                }

                if (containingBean == null) {
                        checkNameUniqueness(beanName, aliases, ele);
                }

                //这个方法会引发对bean元素的详细解析
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
                if (beanDefinition != null) {
                        if (!StringUtils.hasText(beanName)) {
                                try {
                                        if (containingBean != null) {
                                                beanName = BeanDefinitionReaderUtils.generateBeanName(
                                                                beanDefinition, this.readerContext.getRegistry(), true);
                                        }
                                        else {
                                                beanName = this.readerContext.generateBeanName(beanDefinition);
                                                // Register an alias for the plain bean class name, if still possible,
                                                // if the generator returned the class name plus a suffix.
                                                // This is expected for Spring 1.2/2.0 backwards compatibility.
                                                String beanClassName = beanDefinition.getBeanClassName();
                                                if (beanClassName != null &&
                                                                beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&
                                                                !this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
                                                        aliases.add(beanClassName);
                                                }
                                        }
                                        if (logger.isDebugEnabled()) {
                                                logger.debug("Neither XML 'id' nor 'name' specified - " +
                                                                "using generated bean name [" + beanName + "]");
                                        }
                                }
                                catch (Exception ex) {
                                        error(ex.getMessage(), ele);
                                        return null;
                                }
                        }
                        String[] aliasesArray = StringUtils.toStringArray(aliases);
                        return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
                }

                return null;
        }

 

在具体生成BeanDefinition以后。我们举一个对property进行解析的例子来完成对整个BeanDefinition载入过程的分析,还是在类BeanDefinitionParserDelegate的代码中,它对BeanDefinition中的定义一层一层地进行解析,比如从属性元素集合到具体的每一个属性元素,然后才是对具体的属性值的处理。根据解析结果,对这些属性值的处理会封装成PropertyValue对象并设置到BeanDefinition对象中去,如以下代码清单所示。

/**  
* 这里对指定bean元素的property子元素集合进行解析。  
*/  
public void parsePropertyElements(Element beanEle, BeanDefinition bd) {   
    //遍历所有bean元素下定义的property元素   
    NodeList nl = beanEle.getChildNodes();   
    for (int i = 0; i < nl.getLength(); i++) {   
        Node node = nl.item(i);   
        if (node instanceof Element && DomUtils.nodeNameEquals(node, PROPERTY_ELEMENT)) {   
            //在判断是property元素后对该property元素进行解析的过程   
            parsePropertyElement((Element) node, bd);   
        }   
    }   
}   
public void parsePropertyElement(Element ele, BeanDefinition bd) {   
    //这里取得property的名字   
    String propertyName = ele.getAttribute(NAME_ATTRIBUTE);   
    if (!StringUtils.hasLength(propertyName)) {   
        error("Tag 'property' must have a 'name' attribute", ele);   
        return;   
    }   
    this.parseState.push(new PropertyEntry(propertyName));   
    try {   
        //如果同一个bean中已经有同名的存在,则不进行解析,直接返回。也就是说,如果在同一个bean中有同名的property设置,那么起作用的只是第一个。   
        if (bd.getPropertyValues().contains(propertyName)) {   
            error("Multiple 'property' definitions for property '" + propertyName + "'", ele);   
            return;   
        }   
        //这里是解析property值的地方,返回的对象对应对Bean定义的property属性设置的解析结果,这个解析结果会封装到PropertyValue对象中,然后设置到BeanDefinitionHolder中去。   
        Object val = parsePropertyValue(ele, bd, propertyName);   
        PropertyValue pv = new PropertyValue(propertyName, val);   
        parseMetaElements(ele, pv);   
        pv.setSource(extractSource(ele));   
        bd.getPropertyValues().addPropertyValue(pv);   
    }   
    finally {   
        this.parseState.pop();   
    }   
}   
/**  
* 这里取得property元素的值,也许是一个list或其他。  
*/  
public Object parsePropertyValue(Element ele, BeanDefinition bd, String propertyName) {   
    String elementName = (propertyName != null) ?   
                    "<property> element for property '" + propertyName + "'" :   
                    "<constructor-arg> element";   
  
    // Should only have one child element: ref, value, list, etc.   
    NodeList nl = ele.getChildNodes();   
    Element subElement = null;   
    for (int i = 0; i < nl.getLength(); i++) {   
        Node node = nl.item(i);   
        if (node instanceof Element && !DomUtils.nodeNameEquals(node, DESCRIPTION_ELEMENT) &&   
                !DomUtils.nodeNameEquals(node, META_ELEMENT)) {   
            // Child element is what we're looking for.   
            if (subElement != null) {   
                error(elementName + " must not contain more than one sub-element", ele);   
            }   
            else {   
                subElement = (Element) node;   
            }   
        }   
    }   
    //这里判断property的属性,是ref还是value,不允许同时是ref和value。   
    boolean hasRefAttribute = ele.hasAttribute(REF_ATTRIBUTE);   
    boolean hasValueAttribute = ele.hasAttribute(VALUE_ATTRIBUTE);   
    if ((hasRefAttribute && hasValueAttribute) ||   
            ((hasRefAttribute || hasValueAttribute) && subElement != null)) {   
        error(elementName +   
                " is only allowed to contain either 'ref' attribute OR 'value' attribute OR sub-element", ele);   
    }   
    //如果是ref,创建一个ref的数据对象RuntimeBeanReference,这个对象封装了ref的信息。   
    if (hasRefAttribute) {   
        String refName = ele.getAttribute(REF_ATTRIBUTE);   
        if (!StringUtils.hasText(refName)) {   
            error(elementName + " contains empty 'ref' attribute", ele);   
        }   
        RuntimeBeanReference ref = new RuntimeBeanReference(refName);   
        ref.setSource(extractSource(ele));   
        return ref;   
    } //如果是value,创建一个value的数据对象TypedStringValue ,这个对象封装了value的信息。   
    else if (hasValueAttribute) {   
        TypedStringValue valueHolder = new TypedStringValue(ele.getAttribute(VALUE_ATTRIBUTE));   
        valueHolder.setSource(extractSource(ele));   
        return valueHolder;   
    } //如果还有子元素,触发对子元素的解析   
    else if (subElement != null) {   
        return parsePropertySubElement(subElement, bd);   
    }   
    else {   
        // Neither child element nor "ref" or "value" attribute found.   
        error(elementName + " must specify a ref or value", ele);   
        return null;   
    }   
}  

        /**
         * 这里对指定bean元素的property子元素集合进行解析。
         */
        public void parsePropertyElements(Element beanEle, BeanDefinition bd) {
                //遍历所有bean元素下定义的property元素
                NodeList nl = beanEle.getChildNodes();
                for (int i = 0; i < nl.getLength(); i++) {
                        Node node = nl.item(i);
                        if (node instanceof Element && DomUtils.nodeNameEquals(node, PROPERTY_ELEMENT)) {
                                //在判断是property元素后对该property元素进行解析的过程
                                parsePropertyElement((Element) node, bd);
                        }
                }
        }
        public void parsePropertyElement(Element ele, BeanDefinition bd) {
                //这里取得property的名字
                String propertyName = ele.getAttribute(NAME_ATTRIBUTE);
                if (!StringUtils.hasLength(propertyName)) {
                        error("Tag 'property' must have a 'name' attribute", ele);
                        return;
                }
                this.parseState.push(new PropertyEntry(propertyName));
                try {
                        //如果同一个bean中已经有同名的存在,则不进行解析,直接返回。也就是说,如果在同一个bean中有同名的property设置,那么起作用的只是第一个。
                        if (bd.getPropertyValues().contains(propertyName)) {
                                error("Multiple 'property' definitions for property '" + propertyName + "'", ele);
                                return;
                        }
                        //这里是解析property值的地方,返回的对象对应对Bean定义的property属性设置的解析结果,这个解析结果会封装到PropertyValue对象中,然后设置到BeanDefinitionHolder中去。
                        Object val = parsePropertyValue(ele, bd, propertyName);
                        PropertyValue pv = new PropertyValue(propertyName, val);
                        parseMetaElements(ele, pv);
                        pv.setSource(extractSource(ele));
                        bd.getPropertyValues().addPropertyValue(pv);
                }
                finally {
                        this.parseState.pop();
                }
        }
        /**
         * 这里取得property元素的值,也许是一个list或其他。
         */
        public Object parsePropertyValue(Element ele, BeanDefinition bd, String propertyName) {
                String elementName = (propertyName != null) ?
                                                "<property> element for property '" + propertyName + "'" :
                                                "<constructor-arg> element";

                // Should only have one child element: ref, value, list, etc.
                NodeList nl = ele.getChildNodes();
                Element subElement = null;
                for (int i = 0; i < nl.getLength(); i++) {
                        Node node = nl.item(i);
                        if (node instanceof Element && !DomUtils.nodeNameEquals(node, DESCRIPTION_ELEMENT) &&
                                        !DomUtils.nodeNameEquals(node, META_ELEMENT)) {
                                // Child element is what we're looking for.
                                if (subElement != null) {
                                        error(elementName + " must not contain more than one sub-element", ele);
                                }
                                else {
                                        subElement = (Element) node;
                                }
                        }
                }
                //这里判断property的属性,是ref还是value,不允许同时是ref和value。
                boolean hasRefAttribute = ele.hasAttribute(REF_ATTRIBUTE);
                boolean hasValueAttribute = ele.hasAttribute(VALUE_ATTRIBUTE);
                if ((hasRefAttribute && hasValueAttribute) ||
                                ((hasRefAttribute || hasValueAttribute) && subElement != null)) {
                        error(elementName +
                                        " is only allowed to contain either 'ref' attribute OR 'value' attribute OR sub-element", ele);
                }
                //如果是ref,创建一个ref的数据对象RuntimeBeanReference,这个对象封装了ref的信息。
                if (hasRefAttribute) {
                        String refName = ele.getAttribute(REF_ATTRIBUTE);
                        if (!StringUtils.hasText(refName)) {
                                error(elementName + " contains empty 'ref' attribute", ele);
                        }
                        RuntimeBeanReference ref = new RuntimeBeanReference(refName);
                        ref.setSource(extractSource(ele));
                        return ref;
                } //如果是value,创建一个value的数据对象TypedStringValue ,这个对象封装了value的信息。
                else if (hasValueAttribute) {
                        TypedStringValue valueHolder = new TypedStringValue(ele.getAttribute(VALUE_ATTRIBUTE));
                        valueHolder.setSource(extractSource(ele));
                        return valueHolder;
                } //如果还有子元素,触发对子元素的解析
                else if (subElement != null) {
                        return parsePropertySubElement(subElement, bd);
                }
                else {
                        // Neither child element nor "ref" or "value" attribute found.
                        error(elementName + " must specify a ref or value", ele);
                        return null;
                }
        }

 

比如,再往下看,我们看到像List这样的属性配置是怎样被解析的,依然在BeanDefinitionParserDelegate中:返回的是一个List对象,这个List是Spring定义的ManagedList,作为封装List这类配置定义的数据封装,如以下代码清单所示。

public List parseListElement(Element collectionEle, BeanDefinition bd) {   
    String defaultElementType = collectionEle.getAttribute(VALUE_TYPE_ATTRIBUTE);   
    NodeList nl = collectionEle.getChildNodes();   
    ManagedList<Object> target = new ManagedList<Object>(nl.getLength());   
    target.setSource(extractSource(collectionEle));   
    target.setElementTypeName(defaultElementType);   
    target.setMergeEnabled(parseMergeAttribute(collectionEle));   
    //具体的List元素的解析过程。   
    parseCollectionElements(nl, target, bd, defaultElementType);   
    return target;   
}   
protected void parseCollectionElements(   
        NodeList elementNodes, Collection<Object> target, BeanDefinition bd, String defaultElementType) {   
    //遍历所有的元素节点,并判断其类型是否为Element。   
    for (int i = 0; i < elementNodes.getLength(); i++) {   
        Node node = elementNodes.item(i);   
        if (node instanceof Element && !DomUtils.nodeNameEquals(node, DESCRIPTION_ELEMENT)) {   
    //加入到target中去,target是一个ManagedList,同时触发对下一层子元素的解析过程,这是一个递归的调用。   
            target.add(parsePropertySubElement((Element) node, bd, defaultElementType));   
        }   
    }   
}  

        public List parseListElement(Element collectionEle, BeanDefinition bd) {
                String defaultElementType = collectionEle.getAttribute(VALUE_TYPE_ATTRIBUTE);
                NodeList nl = collectionEle.getChildNodes();
                ManagedList<Object> target = new ManagedList<Object>(nl.getLength());
                target.setSource(extractSource(collectionEle));
                target.setElementTypeName(defaultElementType);
                target.setMergeEnabled(parseMergeAttribute(collectionEle));
                //具体的List元素的解析过程。
                parseCollectionElements(nl, target, bd, defaultElementType);
                return target;
        }
        protected void parseCollectionElements(
                        NodeList elementNodes, Collection<Object> target, BeanDefinition bd, String defaultElementType) {
                //遍历所有的元素节点,并判断其类型是否为Element。
                for (int i = 0; i < elementNodes.getLength(); i++) {
                        Node node = elementNodes.item(i);
                        if (node instanceof Element && !DomUtils.nodeNameEquals(node, DESCRIPTION_ELEMENT)) {
                //加入到target中去,target是一个ManagedList,同时触发对下一层子元素的解析过程,这是一个递归的调用。
                                target.add(parsePropertySubElement((Element) node, bd, defaultElementType));
                        }
                }
        }

 

经过这样一层一层的解析,我们在XML文件中定义的BeanDefinition就被整个给载入到了IoC容器中,并在容器中建立了数据映射。在IoC容器中建立了对应的数据结构,或者说可以看成是POJO对象在IoC容器中的映像,这些数据结构可以以AbstractBeanDefinition为入口,让IoC容器执行索引、查询和操作。

分享到:
评论

相关推荐

    springIoc实现原理

    **Spring Ioc 实现原理详解** Spring Ioc(Inversion of Control,控制反转)是Spring框架的核心特性之一,它改变了传统应用程序中对象的创建和管理方式。在传统的软件设计中,对象的创建和依赖关系的维护通常由...

    Spring IOC实现原理demo

    总结一下,Spring IOC实现原理主要包括以下步骤: 1. 解析XML配置文件,获取Bean的定义。 2. 使用反射创建Bean实例,处理构造参数和属性注入。 3. 管理Bean的依赖关系,实现依赖注入。 4. 提供`getBean`方法,使外部...

    Spring框架系列(7) - Spring IOC实现原理详解之IOC初始化流程.doc

    Spring 框架系列(7)- Spring IOC 实现原理详解之 IOC 初始化流程 本文将详细解释 Spring 框架中的 IOC(Inversion of Control,控制反转)实现原理之 IOC 初始化流程。IOC 是一种软件设计模式,用于将软件系统中...

    SpringIOC原理实现

    在这个例子中,我们将通过导入Excel数据来深入理解Spring IOC的工作原理,并探讨如何自定义实现。 1. **控制反转**:在传统的编程模式中,我们经常手动创建和管理对象,但在Spring中,对象的创建、初始化、依赖关系...

    Spring框架系列(8) - Spring IOC实现原理详解之Bean实例化(生命周期,循环依赖等).doc

    Spring 框架系列(8)- Spring IOC 实现原理详解之 Bean 实例化(生命周期、循环依赖等) 本文主要研究 Spring 框架中 Bean 的实例化过程,包括 Bean 的生命周期和循环依赖问题的解决方案。在 Spring 框架中,Bean ...

    Spring框架系列(6) - Spring IOC实现原理详解之IOC体系结构设计.doc

    Spring 框架的IoC(Inversion of Control,控制反转)实现原理是其核心特性之一,它使得组件之间的依赖关系不再由代码直接管理,而是交由容器负责。本篇文章将详细探讨Spring IoC的体系结构设计,以及如何实现这些...

    IOC 基础实现 IOCBlue (研究用) C#

    根据自己所了解的一些知识,以比较简单的方式实现一下IOC模式(包括反射和XML文件读取数据访问中间件,和一些网上摘录的资料文本)供大家学习研究之用.本人MSN:xia_xiujun@hotmail.com 欢迎一起加油提高(本模块只用研究...

    简单实现Spring的IOC原理详解

    简单实现Spring的IOC原理详解 Spring IOC(Inversion of Control,控制反转)是一种软件设计模式,它将对象的创建和管理交给容器,实现了对象之间的解耦合。Spring IOC容器是Spring框架的核心,用于管理应用程序中...

    自己实现ioc实例demo

    但理解如何手动实现这个过程可以帮助我们更好地理解IoC的核心原理,从而更有效地利用现有的IoC框架。 总的来说,这个“自己实现ioc实例demo”旨在帮助开发者理解依赖注入的基本概念,并通过XPath解析XML文件实践这...

    Spring的IOC原理

    **四、Spring的IOC实现** Spring框架是实现IOC的一个典型例子。在Spring中,IOC容器(ApplicationContext)负责管理对象的生命周期和装配。开发者通过XML配置、注解或Java配置来定义对象及其依赖关系。Spring容器...

    spring ioc和aop原理流程图(详细)

    Spring 框架是Java开发中的核心框架,它主要由两个关键部分组成:IOC(Inversion of Control,控制反转)和AOP(Aspect Oriented Programming,面向切面编程)。这两个概念是Spring框架的核心特性,极大地简化了企业...

    Spring实现原理及IoC容器的优点

    本篇文章将深入探讨Spring实现原理,阐述IoC容器的优点,并指导如何在Eclipse中创建一个Spring的Web应用。 首先,让我们理解Spring的核心——IoC容器。IoC是一种设计模式,它改变了对象获取依赖的方式。在传统的...

    IoC原理的最基础实现

    此项目是对spring ioc原理的简单实践,主要是对xml配置的解析完成依赖注入;此项目依赖于 Dom4j 、common-beanutils、common-logging、jaxen的jar包。希望可以帮助大家更轻易的理解spring ioc部分原理

    Spring2.5 IOC的简单实现

    以下将详细讲解 Spring 2.5 中的 IOC 实现原理以及如何创建简单的应用。 **1. IOC 简介** IOC 是一种设计模式,它将对象的创建和管理交给容器处理,使得代码更加松耦合。Spring 框架通过 XML 配置文件或注解方式来...

    IOC的原理以及自定义使用

    虽然有许多成熟的IOC容器,如Spring、Guice等,但理解其原理并自定义实现有助于深入学习。自定义IOC主要包括以下几个步骤: 1. **创建Bean仓库**:用于存储所有的Bean定义,包括类名、构造函数、依赖关系等信息。 2....

    ioc原理实现BufferKnife

    **IOC原理实现BufferKnife** IOC(Inversion of Control),即控制反转,是软件设计模式中的一种,它将对象的创建和管理权交给了容器,而不是由对象自身来负责。这种设计思想使得代码更加灵活,降低了模块间的耦合...

    使用Java的xml API、Java反射技术演示Spring的DI或者IoC原理

    3. 如果一切正常,你会看到使用Java集合、XML API,以及反射技术模拟Spring的get注入和自定义的IoC容器实现的例子--get注入了Hello类和一个MyFrame类,并且实例化之后可以运行! 4. 看一下testDemoSpringDI()方法,...

    Spring IOC设计原理解析.docx

    Spring IOC(Inversion of Control,控制反转)设计原理解析 一、什么是IOC/DI? IOC,即控制反转,是软件设计模式中的一种,它将对象的创建和管理权交给了框架,而不是由对象自身负责。DI(Dependency Injection,...

    所有j2ee框架方面的原理全集

    对所有j2ee框架的原理做了解析,dwr的实现原理 hibernate缓存的配置 ioc实现原理 javascript原型 javacript中继承 jboss ibatis 解决延迟加载等等本人近段时间的呕心之做

    SpringIoC的简单实现

    我们从一个简单的容器开始,一步步的重构,最后实现一个基本的Spring框架的雏形,为了帮助我们更加深入的理解Spring的IoC的原理和源码。 详细内容见博文: 【SSH进阶之路】一步步重构容器实现Spring的IoC——从一个...

Global site tag (gtag.js) - Google Analytics