`
calmness
  • 浏览: 354000 次
  • 性别: Icon_minigender_1
  • 来自: 珠海
社区版块
存档分类
最新评论

spring源码分析-XmlBeanFactory导读

    博客分类：
  • Java
SpringBean配置管理框架互联网 
阅读更多
源代码分析，是一件既痛苦又快乐的事情，看别人写的代码是通过的，但当你能够看明白的时候，相信快乐也会随之而来，为了减少痛苦，更快的带来快乐，在这里希望通过这篇文章对觉得困难的朋友有一个帮助。

本文以spring框架的XmlBeanFactory为入手点进行分析，希望能够以尽量简洁明了的方式给予有需要的朋友一定的帮助。

首先来打开该类的代码，我们将看到如下代码： 
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);
	}

}


这个类的代码很简单，一个成员对象加两个构造函数，从这里我们可以看出，最重要的地方在于最后一个构造函数： 

	super(parentBeanFactory);
	this.reader.loadBeanDefinitions(resource);


第一句就是将父亲工厂交给父类的构造函数，实际上最后也就是把父工厂保存到类的parentBeanFactory成员对象中，这个对象是在AbstractBeanFactory抽象类中定义的，而这个父工厂也会一直传递到该抽象类进行保存。第二句就是整个类中最重要的地方了，顾名思义，它的目的是通过XmlBeanDefinitionReader这个XML的Reader从资源resource中（也就是你的配置文件）读取bean的定义。接下来我们打开XmlBeanDefinitionReader的loadBeanDefinitions方法，我们可看到在这个方法里代码就一行，调用了一个同名不同参的方法，而参数是EncodedResource的一个实例，这个类实际上是Resource的一个包装类，用来保存资源的Encode的，那接下来我们再看被调用的loadBeanDefinitions方法，这个方法里最主要的部分就是： 

		InputSource inputSource = new InputSource(inputStream);
				if (encodedResource.getEncoding() != null) {
					inputSource.setEncoding(encodedResource.getEncoding());
				}
		return doLoadBeanDefinitions(inputSource, encodedResource.getResource());


这里的目的是将资源包装成一个InputSource，连同Resource作为参数传递到doLoadBeanDefinitions方法 

			DocumentBuilderFactory factory = createDocumentBuilderFactory();
			if (logger.isDebugEnabled()) {
				logger.debug("Using JAXP implementation [" + factory + "]");
			}
			DocumentBuilder builder = createDocumentBuilder(factory);
			Document doc = builder.parse(inputSource);
			return registerBeanDefinitions(doc, resource);


这个方法的目的一目了然，就是为了将资源解释成为Document对象，然后调用registerBeanDefinitions方法，这里不做详细解释，不了解的话请去看看关于JAXP的介绍。接下来我们打开registerBeanDefinitions方法： 
	public int registerBeanDefinitions(Document doc, Resource resource) throws BeansException {
		XmlBeanDefinitionParser parser =
				(XmlBeanDefinitionParser) BeanUtils.instantiateClass(this.parserClass);
		return parser.registerBeanDefinitions(this, doc, resource);
	}


这里创建了一个XmlBeanDefinitionParser接口的实现，这个接口的具体类是DefaultXmlBeanDefinitionParser，这个接口很简单，只有registerBeanDefinitions一个方法，这个方法的作用也很明了，就是用来注册Bean的定义的，所以说类和方法的名字一定要起得有意义，这样可以让人一看就大概了解其作用，减少了很多阅读代码的痛苦。废话不多说，我们打开DefaultXmlBeanDefinitionParser的registerBeanDefinitions方法，这个类就是解释XML配置文件的核心类了，打开registerBeanDefinitions方法后我们看到如下代码： 
	public int registerBeanDefinitions(BeanDefinitionReader reader, Document doc, Resource resource)
			throws BeanDefinitionStoreException {

		this.beanDefinitionReader = reader;
		this.resource = resource;

		logger.debug("Loading bean definitions");
		Element root = doc.getDocumentElement();
		//初始化根元素
		initDefaults(root);
		if (logger.isDebugEnabled()) {
			logger.debug("Default lazy init '" + getDefaultLazyInit() + "'");
			logger.debug("Default autowire '" + getDefaultAutowire() + "'");
			logger.debug("Default dependency check '" + getDefaultDependencyCheck() + "'");
		}

		preProcessXml(root);//一个空方法用于扩展
		int beanDefinitionCount = parseBeanDefinitions(root);//解释配置的主要方法
		if (logger.isDebugEnabled()) {
			logger.debug("Found " + beanDefinitionCount + " <bean> elements in " + resource);
		}
		postProcessXml(root); //一个空方法用于扩展

		return beanDefinitionCount;
	}


在这个方法当中，主要用于解释定义的有两个方法，一个是initDefaults，一个是parseBeanDefinitions，第一个方法是用来解释根元素的属性的，例如lazy-init, autowire等，而parseBeanDefinitions就是用来解释具体的bean定义了，方法代码如下： 
	protected int parseBeanDefinitions(Element root) throws BeanDefinitionStoreException {
		NodeList nl = root.getChildNodes();
		int beanDefinitionCount = 0;
		for (int i = 0; i < nl.getLength(); i++) {
			Node node = nl.item(i);
			if (node instanceof Element) {
				Element ele = (Element) node;
				if (IMPORT_ELEMENT.equals(node.getNodeName())) {
					importBeanDefinitionResource(ele);
				}
				else if (ALIAS_ELEMENT.equals(node.getNodeName())) {
					String name = ele.getAttribute(NAME_ATTRIBUTE);
					String alias = ele.getAttribute(ALIAS_ATTRIBUTE);
					this.beanDefinitionReader.getBeanFactory().registerAlias(name, alias);
				}
				else if (BEAN_ELEMENT.equals(node.getNodeName())) {
					beanDefinitionCount++;
					BeanDefinitionHolder bdHolder = parseBeanDefinitionElement(ele, false);
					BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, this.beanDefinitionReader.getBeanFactory());
				}
			}
		}
		return beanDefinitionCount;
	}


其他标签具体如何被解释这里就不多说，相信大家也能看得懂，这里主要讲一下解释bean的的处理，我们注意以下代码： 
				else if (BEAN_ELEMENT.equals(node.getNodeName())) {
					beanDefinitionCount++;
					BeanDefinitionHolder bdHolder = parseBeanDefinitionElement(ele, false);
					BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, this.beanDefinitionReader.getBeanFactory());
				}

这里是当碰到一个bean标签的时候所进行的处理，也既是对bean的定义进行解释，可以看到parseBeanDefinitionElement方法的第一个参数就是bean则个元素，第二个参数表示该bean是否为内置的bean，从这里进行解释的bean都不可能是内置的，所以这里直接以false为参数，打开parseBeanDefinitionElement方法，就可以看到这个方法里就是对bean的内部的解释，也很简单，也不多讲了，呵呵（下班时间已经到了，所以就写这么多了，基本的流程也就这样，没什么特别难的地方。），对了，最后还有一点就是解释完后，bean的定义将会被保存到beanFactory中，这个beanFactory的实现就是XmlBeanFactory了，该beanFactory是在new的时候被传递到reader中的，就是该类中以下这行代码： 
	private final XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(this);


好了，就这么多了，本文只作为参考，只讲解了如何加载bean定义这块，只作为一个参考，希望对其他朋友能有所帮助吧，因为时间匆忙，有错漏的地方请指正。
分享到：
| 关于接口暴露问题的解决思路
评论
18 楼 shazi 2007-08-14  
17 楼 wntaimoshen 2007-07-31  
知识是要学习的，谁做的不重要
16 楼 mailscheng 2007-06-02  
一个解析而已，转来转去都晕了，我以前公司自己的框架转一道弯就到了
15 楼 EnhyDra_ 2007-05-20  
期待更深入的讲解:P
14 楼 calmness 2007-05-19  
引用

受教了。其实解析和管理BEAN应该是一件比较容易的事情，只是稍微有点烦琐。细节挺多。
另外，觉得registerBeanDefinitions方法命名不是很好。怎么也不觉得是注册BeanDefiniton啊。
你无非就是要解析BeanDefinitions嘛，我认为应该用后面的方法名比较合适。


叫注册并没有不好，也很贴切啊，因为它需要把解释完的配置信息保存到容器中，就相当于一个注册的过程。
13 楼 spiritfrog 2007-05-18  
拜读一下，加入收藏了。
12 楼 hiwzg 2007-05-17  
受教了。其实解析和管理BEAN应该是一件比较容易的事情，只是稍微有点烦琐。细节挺多。
另外，觉得registerBeanDefinitions方法命名不是很好。怎么也不觉得是注册BeanDefiniton啊。
你无非就是要解析BeanDefinitions嘛，我认为应该用后面的方法名比较合适。



calmness 写道
源代码分析，是一件既痛苦又快乐的事情，看别人写的代码是通过的，但当你能够看明白的时候，相信快乐也会随之而来，为了减少痛苦，更快的带来快乐，在这里希望通过这篇文章对觉得困难的朋友有一个帮助。

本文以spring框架的XmlBeanFactory为入手点进行分析，希望能够以尽量简洁明了的方式给予有需要的朋友一定的帮助。

首先来打开该类的代码，我们将看到如下代码： 
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);
	}

}


这个类的代码很简单，一个成员对象加两个构造函数，从这里我们可以看出，最重要的地方在于最后一个构造函数： 

	super(parentBeanFactory);
	this.reader.loadBeanDefinitions(resource);


第一句就是将父亲工厂交给父类的构造函数，实际上最后也就是把父工厂保存到类的parentBeanFactory成员对象中，这个对象是在AbstractBeanFactory抽象类中定义的，而这个父工厂也会一直传递到该抽象类进行保存。第二句就是整个类中最重要的地方了，顾名思义，它的目的是通过XmlBeanDefinitionReader这个XML的Reader从资源resource中（也就是你的配置文件）读取bean的定义。接下来我们打开XmlBeanDefinitionReader的loadBeanDefinitions方法，我们可看到在这个方法里代码就一行，调用了一个同名不同参的方法，而参数是EncodedResource的一个实例，这个类实际上是Resource的一个包装类，用来保存资源的Encode的，那接下来我们再看被调用的loadBeanDefinitions方法，这个方法里最主要的部分就是： 

		InputSource inputSource = new InputSource(inputStream);
				if (encodedResource.getEncoding() != null) {
					inputSource.setEncoding(encodedResource.getEncoding());
				}
		return doLoadBeanDefinitions(inputSource, encodedResource.getResource());


这里的目的是将资源包装成一个InputSource，连同Resource作为参数传递到doLoadBeanDefinitions方法 

			DocumentBuilderFactory factory = createDocumentBuilderFactory();
			if (logger.isDebugEnabled()) {
				logger.debug("Using JAXP implementation [" + factory + "]");
			}
			DocumentBuilder builder = createDocumentBuilder(factory);
			Document doc = builder.parse(inputSource);
			return registerBeanDefinitions(doc, resource);


这个方法的目的一目了然，就是为了将资源解释成为Document对象，然后调用registerBeanDefinitions方法，这里不做详细解释，不了解的话请去看看关于JAXP的介绍。接下来我们打开registerBeanDefinitions方法： 
	public int registerBeanDefinitions(Document doc, Resource resource) throws BeansException {
		XmlBeanDefinitionParser parser =
				(XmlBeanDefinitionParser) BeanUtils.instantiateClass(this.parserClass);
		return parser.registerBeanDefinitions(this, doc, resource);
	}


这里创建了一个XmlBeanDefinitionParser接口的实现，这个接口的具体类是DefaultXmlBeanDefinitionParser，这个接口很简单，只有registerBeanDefinitions一个方法，这个方法的作用也很明了，就是用来注册Bean的定义的，所以说类和方法的名字一定要起得有意义，这样可以让人一看就大概了解其作用，减少了很多阅读代码的痛苦。废话不多说，我们打开DefaultXmlBeanDefinitionParser的registerBeanDefinitions方法，这个类就是解释XML配置文件的核心类了，打开registerBeanDefinitions方法后我们看到如下代码： 
	public int registerBeanDefinitions(BeanDefinitionReader reader, Document doc, Resource resource)
			throws BeanDefinitionStoreException {

		this.beanDefinitionReader = reader;
		this.resource = resource;

		logger.debug("Loading bean definitions");
		Element root = doc.getDocumentElement();
		//初始化根元素
		initDefaults(root);
		if (logger.isDebugEnabled()) {
			logger.debug("Default lazy init '" + getDefaultLazyInit() + "'");
			logger.debug("Default autowire '" + getDefaultAutowire() + "'");
			logger.debug("Default dependency check '" + getDefaultDependencyCheck() + "'");
		}

		preProcessXml(root);//一个空方法用于扩展
		int beanDefinitionCount = parseBeanDefinitions(root);//解释配置的主要方法
		if (logger.isDebugEnabled()) {
			logger.debug("Found " + beanDefinitionCount + " <bean> elements in " + resource);
		}
		postProcessXml(root); //一个空方法用于扩展

		return beanDefinitionCount;
	}


在这个方法当中，主要用于解释定义的有两个方法，一个是initDefaults，一个是parseBeanDefinitions，第一个方法是用来解释根元素的属性的，例如lazy-init, autowire等，而parseBeanDefinitions就是用来解释具体的bean定义了，方法代码如下： 
	protected int parseBeanDefinitions(Element root) throws BeanDefinitionStoreException {
		NodeList nl = root.getChildNodes();
		int beanDefinitionCount = 0;
		for (int i = 0; i < nl.getLength(); i++) {
			Node node = nl.item(i);
			if (node instanceof Element) {
				Element ele = (Element) node;
				if (IMPORT_ELEMENT.equals(node.getNodeName())) {
					importBeanDefinitionResource(ele);
				}
				else if (ALIAS_ELEMENT.equals(node.getNodeName())) {
					String name = ele.getAttribute(NAME_ATTRIBUTE);
					String alias = ele.getAttribute(ALIAS_ATTRIBUTE);
					this.beanDefinitionReader.getBeanFactory().registerAlias(name, alias);
				}
				else if (BEAN_ELEMENT.equals(node.getNodeName())) {
					beanDefinitionCount++;
					BeanDefinitionHolder bdHolder = parseBeanDefinitionElement(ele, false);
					BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, this.beanDefinitionReader.getBeanFactory());
				}
			}
		}
		return beanDefinitionCount;
	}


其他标签具体如何被解释这里就不多说，相信大家也能看得懂，这里主要讲一下解释bean的的处理，我们注意以下代码： 
				else if (BEAN_ELEMENT.equals(node.getNodeName())) {
					beanDefinitionCount++;
					BeanDefinitionHolder bdHolder = parseBeanDefinitionElement(ele, false);
					BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, this.beanDefinitionReader.getBeanFactory());
				}

这里是当碰到一个bean标签的时候所进行的处理，也既是对bean的定义进行解释，可以看到parseBeanDefinitionElement方法的第一个参数就是bean则个元素，第二个参数表示该bean是否为内置的bean，从这里进行解释的bean都不可能是内置的，所以这里直接以false为参数，打开parseBeanDefinitionElement方法，就可以看到这个方法里就是对bean的内部的解释，也很简单，也不多讲了，呵呵（下班时间已经到了，所以就写这么多了，基本的流程也就这样，没什么特别难的地方。），对了，最后还有一点就是解释完后，bean的定义将会被保存到beanFactory中，这个beanFactory的实现就是XmlBeanFactory了，该beanFactory是在new的时候被传递到reader中的，就是该类中以下这行代码： 
	private final XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(this);


好了，就这么多了，本文只作为参考，只讲解了如何加载bean定义这块，只作为一个参考，希望对其他朋友能有所帮助吧，因为时间匆忙，有错漏的地方请指正。
11 楼 calmness 2007-04-27  
我觉得应该把抄袭和转载给区分开来，两者目的也不一样，具体没必要也不想过多争论，还有就是如果想继续讨论这个问题建议重新开个帖子，虽然本文很菜，但是我也不希望在我这个帖子后面尽是讨论与本文无关的话题。
10 楼 robbin 2007-04-27  
rainlife 写道
robbin 写道
calmness 写道
其实也没什么的，即使没有注明也无所谓，只要不涉及到商业利益就行，分享才是重点


JavaEye是一个非常尊重版权的网站，不允许非授权的转载。

个在感觉是否是经过授权的很难去辨别吧，不涉及商业利益的，转载的时候指明原文出处及原文作者也就可以了吧。


指出作者和出处也不可以全文转载。国际通行的惯例是转载一个章节，然后给出link。

中国的互联网大环境就是抄来抄去给抄坏的。JavaEye不管别的网站怎么做，但是起码洁身自好，不干抄袭别人网站的事情。
9 楼 rainlife 2007-04-27  
robbin 写道
calmness 写道
其实也没什么的，即使没有注明也无所谓，只要不涉及到商业利益就行，分享才是重点


JavaEye是一个非常尊重版权的网站，不允许非授权的转载。

个在感觉是否是经过授权的很难去辨别吧，不涉及商业利益的，转载的时候指明原文出处及原文作者也就可以了吧。
8 楼 robbin 2007-04-27  
calmness 写道
其实也没什么的，即使没有注明也无所谓，只要不涉及到商业利益就行，分享才是重点


JavaEye是一个非常尊重版权的网站，不允许非授权的转载。
7 楼 calmness 2007-04-27  
其实也没什么的，即使没有注明也无所谓，只要不涉及到商业利益就行，分享才是重点
6 楼 rainlife 2007-04-27  
calmness 写道
哦，是大峡昨天晚上转我的，他已经和我说过了的。他在文章的最后面也著明了我的名字。

呵呵，转来转去，都转乱掉了。
引用
若作者同意转载，必须以超链接形式标明文章原始出处和作者

这个看来非常必要啊。
5 楼 calmness 2007-04-27  
哦，是大峡昨天晚上转我的，他已经和我说过了的。他在文章的最后面也著明了我的名字。
4 楼 robbin 2007-04-27  
大峡 写道
好久没写了， 转一下EasyJF里面的朋友写的。:-


貌似大峡转了别人的，本文应该是原作者发的。
3 楼 rainlife 2007-04-27  
http://blog.csdn.net/easyjf/archive/2007/04/26/1586395.aspx

又是两篇一模一样的，谁写的？谁转了谁？还是同一个人？
2 楼 lsy 2007-04-26  
谢谢lz
1 楼 fj_opensky 2007-04-26  
支持,辛苦了.~~
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    Spring源码分析.pdf

    Spring 源码分析 Spring 框架是 Java 语言中最流行的开源框架之一，它提供了一个强大且灵活的基础设施来构建企业级应用程序。在 Spring 框架中，IOC 容器扮演着核心角色，本文将深入分析 Spring 源码，了解 IOC ...

    Spring源码深度解析第二版

    Spring源码深度解析第二版 Spring是一款广泛应用于Java企业级应用程序的开源框架，旨在简化Java应用程序的开发和部署。Spring框架的核心主要包括了IoC容器、AOP、MVC框架等模块。 第1章 Spring整体架构和环境搭建 ...

    Spring源码分析_Spring_IOC

    ### Spring源码分析_Spring_IOC：深入理解Spring的IOC容器机制 #### 基本概念与核心作用 在探讨Spring框架的核心组件之一——IOC（Inversion of Control，控制反转）容器之前，首先需要理解它在Spring框架中的角色...

    二、Spring源码分析——BeanFactory

    《Spring源码分析——BeanFactory》 在Java的IoC（Inversion of Control）和DI（Dependency Injection）领域，Spring框架扮演着至关重要的角色。BeanFactory是Spring的核心组件之一，它是容器的基石，负责管理应用...

    Spring源码解析.pdf

    ### Spring源码解析知识点 #### 一、Spring IoC 容器详解 ##### 1. BeanFactory —— 最基础的IoC容器 - **概念**：`BeanFactory` 是Spring框架中最基本的IoC容器，它负责管理Bean的生命周期，包括创建、配置和...

    spring 源码分析

    通过源码分析Spring，可以帮助开发者深入理解Spring的运作机制，掌握其核心编程思想。 首先，BeanFactory是Spring中IOC容器的基础接口，它负责实例化、定位、配置应用程序中的对象及建立这些对象间的依赖关系。...

    Spring源码分析

    以下是对Spring源码分析中所涉及的关键知识点的详细说明。 首先，IoC容器在Spring框架中的重要性不言而喻。它是一种实现控制反转的设计模式，用来减少代码间的耦合度，提升系统的可测试性和可维护性。IoC容器能够...

    spring源码解析

    ### Spring源码解析知识点 #### 1. Spring IoC 容器概述 Spring 框架的核心特性之一是它的依赖注入（Dependency Injection, DI）能力，这种能力通过一个称为 Inversion of Control (IoC) 容器来实现。IoC 容器负责...

    spring源码分析

    ### Spring源码分析：深入理解IOC容器 #### 一、IOC容器的概念与作用 在Spring框架中，**IOC(Inversion of Control)**容器扮演着至关重要的角色。它负责管理应用程序中的对象（即Bean）的生命周期以及依赖关系。...

    spring 个人小结 源码分析机制原理

    本篇文章将基于标题"spring 个人小结 源码分析机制原理"及描述，深入探讨Spring的核心机制、源码分析以及创建Bean的过程。 首先，Spring的BeanUtils组件在处理Bean时，有一个重要的区别：Apache的BeanUtils支持`...

    spring源码解析思维导图

    XmlBeanFactory继承自DefaultListableBeanFactory，而DefaultListableBeanFactory是整个bean加载的核心部分，是Spring注册及加载bean的默认实现，XmlBeanFactory与DefaultListableBeanFactory不同的地方其实是在...

    shirayner#java-knowledge-hierarchy#Spring源码分析_100_容器的基本实现 - 副本1

    前言一、两个核心类XmlBeanFactory 继承向 DefaultListableBeanFactory ，而 DefaultListableBeanFac

    java8源码-spring_master:spring源码探究

    spring源码剖析，大部分都是基于Springframework5.0 交代： spring最核心的两个类： DefaultListableBeanFactory && XmlBeanDefinitionReader 容器的基础XMLBeanFactory XmlBeanFactory继承自...

    Spring ioc源码解读

    通过对Spring IoC容器的理解和源码分析，我们可以深入了解到Spring框架是如何管理和控制应用对象的生命周期及依赖关系的。在实际开发中，了解Spring IoC容器的工作原理有助于更好地利用Spring框架，提高开发效率和...

    spring 源码解析

    Spring 源码解析系列将深入探讨 Spring 框架的核心机制，特别是 IOC（Inversion of Control，控制反转）和 AOP...通过阅读和分析源码，开发者可以更好地掌握 Spring 的设计原则，从而更高效地利用这个强大的框架。

    Spring XmlBeanFactory 容器的基本实现.doc

    总结，Spring 的 `XmlBeanFactory` 容器是基于 XML 配置的 Bean 管理核心。它通过 `DefaultListableBeanFactory` 和 `XmlBeanDefinitionReader` 来加载、解析 XML 配置，将 Bean 定义存储为 `BeanDefinition` 对象，...

    Eclipse 搭建Spring 开发环境

    最后，编写测试程序 HelloApp，使用 Spring 的 BeanFactory 和 XmlBeanFactory 对象来加载配置文件和实例化 Bean。 Spring 开发环境搭建完成后，可以进行 Spring 项目的开发和测试。该环境提供了一个强大且灵活的...

Magicbox
Global site tag (gtag.js) - Google Analytics