Spring源码学习-IOC（xml方式获取注册BeanDefinition）

小名dang
379 阅读8分钟

为什么写这篇文章

  用了这么长时间的Spring框架，对于如何配置使用是了然于胸，但是问到为什么就一脸懵逼了。所以最近开始学习Spring源码，网上对于Spring源码分析也有非常多的资料，学习的时候也有做过一些参考。但别人的东西永远是别人的，只有自己真正去看过理解了，才能成为自己的。写这个也是为了加深自己的理解。

概念理解

  概念理解这部分分享的是Iteye的开涛这位技术牛人对Spring框架的IOC的理解，写得非常通俗易懂，以下内容全部来自原文，原文地址：jinnianshilongnian.iteye.com/blog/141384…

1.1、IoC是什么

  Ioc—Inversion of Control，即“控制反转”，不是什么技术，而是一种设计思想。在Java开发中，Ioc意味着将你设计好的对象交给容器控制，而不是传统的在你的对象内部直接控制。如何理解好Ioc呢？理解好Ioc的关键是要明确“谁控制谁，控制什么，为何是反转（有反转就应该有正转了），哪些方面反转了”，那我们来深入分析一下：

  ●谁控制谁，控制什么：传统Java SE程序设计，我们直接在对象内部通过new进行创建对象，是程序主动去创建依赖对象；而IoC是有专门一个容器来创建这些对象，即由Ioc容器来控制对 象的创建；谁控制谁？当然是IoC 容器控制了对象；控制什么？那就是主要控制了外部资源获取（不只是对象包括比如文件等）。

  ●为何是反转，哪些方面反转了：有反转就有正转，传统应用程序是由我们自己在对象中主动控制去直接获取依赖对象，也就是正转；而反转则是由容器来帮忙创建及注入依赖对象；为何是反转？因为由容器帮我们查找及注入依赖对象，对象只是被动的接受依赖对象，所以是反转；哪些方面反转了？依赖对象的获取被反转了。

  用图例说明一下，传统程序设计如图2-1，都是主动去创建相关对象然后再组合起来：

                                                图1-1 传统应用程序示意图

  当有了IoC/DI的容器后，在客户端类中不再主动去创建这些对象了，如图2-2所示:

                                                图1-2有IoC/DI容器后程序结构示意图

1.2、IoC能做什么

  IoC 不是一种技术，只是一种思想，一个重要的面向对象编程的法则，它能指导我们如何设计出松耦合、更优良的程序。传统应用程序都是由我们在类内部主动创建依赖对象，从而导致类与类之间高耦合，难于测试；有了IoC容器后，把创建和查找依赖对象的控制权交给了容器，由容器进行注入组合对象，所以对象与对象之间是 松散耦合，这样也方便测试，利于功能复用，更重要的是使得程序的整个体系结构变得非常灵活。

  其实IoC对编程带来的最大改变不是从代码上，而是从思想上，发生了“主从换位”的变化。应用程序原本是老大，要获取什么资源都是主动出击，但是在IoC/DI思想中，应用程序就变成被动的了，被动的等待IoC容器来创建并注入它所需要的资源了。

  IoC很好的体现了面向对象设计法则之一—— 好莱坞法则：“别找我们，我们找你”；即由IoC容器帮对象找相应的依赖对象并注入，而不是由对象主动去找。

1.3、IoC和DI

  DI—Dependency Injection，即“依赖注入”：组件之间依赖关系由容器在运行期决定，形象的说，即由容器动态的将某个依赖关系注入到组件之中。依赖注入的目的并非为软件系统带来更多功能，而是为了提升组件重用的频率，并为系统搭建一个灵活、可扩展的平台。通过依赖注入机制，我们只需要通过简单的配置，而无需任何代码就可指定目标需要的资源，完成自身的业务逻辑，而不需要关心具体的资源来自何处，由谁实现。

  理解DI的关键是：“谁依赖谁，为什么需要依赖，谁注入谁，注入了什么”，那我们来深入分析一下：

  ●谁依赖于谁：当然是应用程序依赖于IoC容器；

  ●为什么需要依赖：应用程序需要IoC容器来提供对象需要的外部资源；

  ●谁注入谁：很明显是IoC容器注入应用程序某个对象，应用程序依赖的对象；

  ●注入了什么：就是注入某个对象所需要的外部资源（包括对象、资源、常量数据）。

  IoC和DI由什么关系呢？其实它们是同一个概念的不同角度描述，由于控制反转概念比较含糊（可能只是理解为容器控制对象这一个层面，很难让人想到谁来维护对象关系），所以2004年大师级人物Martin Fowler又给出了一个新的名字：“依赖注入”，相对IoC 而言，“依赖注入”明确描述了“被注入对象依赖IoC容器配置依赖对象”。

  看过很多对Spring的Ioc理解的文章，好多人对Ioc和DI的解释都晦涩难懂，反正就是一种说不清，道不明的感觉，读完之后依然是一头雾水，感觉就是开涛这位技术牛人写得特别通俗易懂，他清楚地解释了IoC(控制反转) 和DI(依赖注入)中的每一个字，读完之后给人一种豁然开朗的感觉。我相信对于初学Spring框架的人对Ioc的理解应该是有很大帮助的。

源码学习

首先要明白几个类的含义：

1.Beandefinition :bean定义，所有通过xml配置和扫描到的bean的都会被解析为BeanDefinition的实例存储在BeanFactory中。BeanDefinition中定义了所有的配置信息。下面是一部分获取属性的方法

    /**
	 * Return the current bean class name of this bean definition.
	 * <p>Note that this does not have to be the actual class name used at runtime, in
	 * case of a child definition overriding/inheriting the class name from its parent.
	 * Also, this may just be the class that a factory method is called on, or it may
	 * even be empty in case of a factory bean reference that a method is called on.
	 * Hence, do <i>not</i> consider this to be the definitive bean type at runtime but
	 * rather only use it for parsing purposes at the individual bean definition level.
	 * @see #getParentName()
	 * @see #getFactoryBeanName()
	 * @see #getFactoryMethodName()
	 */
       @Nullable
	String getBeanClassName();
	/**
	 * Return the name of the current target scope for this bean,
	 * or {@code null} if not known yet.
	 */
	@Nullable
	String getScope();
	/**
	 * Return whether this bean should be lazily initialized, i.e. not
	 * eagerly instantiated on startup. Only applicable to a singleton bean.
	 */
	boolean isLazyInit();
	/**
	 * Return the bean names that this bean depends on.
	 */
	@Nullable
	String[] getDependsOn();

2.BeanDefinitionRegistry:BeanDefinition注册器，实现了该接口就可以对BeanDefinition进行注册

	/**
	 * Register a new bean definition with this registry.
	 * Must support RootBeanDefinition and ChildBeanDefinition.
	 * @param beanName the name of the bean instance to register
	 * @param beanDefinition definition of the bean instance to register
	 * @throws BeanDefinitionStoreException if the BeanDefinition is invalid
	 * @throws BeanDefinitionOverrideException if there is already a BeanDefinition
	 * for the specified bean name and we are not allowed to override it
	 * @see GenericBeanDefinition
	 * @see RootBeanDefinition
	 * @see ChildBeanDefinition
	 */
	void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
			throws BeanDefinitionStoreException;

3.DefaultListableBeanFactory：BeanFactory的默认实现，同时还实现了BeanDefinitionRegistry。 DefaultListableBeanFactory定义了一个Map用于存放BeanDefinition

2.1 入口在哪

ApplicationContext:

//xml配置方式 配置文件
ApplicationContext context = new ClassPathXmlApplicationContext("application.xml");

//注解配置方式 扫描包
ApplicationContext context2 = new AnnotationConfigApplicationContext("com.study.spring");

2.2 xml方式怎么解析并注册BeanDefinition

这里我根据调用链画了一个粗略的流程图

从方法和参数上我们可以看出这 4 部分分别是做什么：
    第一部分：初始化 IOC 容器，创建了内部的 BeanFactory，然后将加载 xml 的工作委托给了
XmlBeanDefinitionReader。
    第二部分： XmlBeanDefinitionReader 完成了对输入数据：字符串 -> Resource -> EncodedResource ->
InputSource -> Document 的转变。
    第三部分： DefaultBeanDefinitionDocumentReader 完成对 Document 中元素的解析，获得 Bean 定义等
信息。
第四部分：就是简单的完成 bean 定义的注册。
接下来，你就可以针对每一部分去看你感兴趣的处理逻辑、数据结构了。
比如：你可能对第三部分 Document 中元素的解析很感兴趣，想搞清楚它是如何解析 xml 文档中的各种标
签元素的。

下面来看几段代码

    AbstractBeanDefinitionReader:遍历所有的配置文件获取beanDefinition

     public int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException {
		Assert.notNull(locations, "Location array must not be null");
		int count = 0;
		for (String location : locations) {
			count += loadBeanDefinitions(location);
		}
		return count;
	}
	
	@Override
	public int loadBeanDefinitions(Resource... resources) throws BeanDefinitionStoreException {
		Assert.notNull(resources, "Resource array must not be null");
		int count = 0;
		for (Resource resource : resources) {
			count += loadBeanDefinitions(resource);
		}
		return count;
	}
	

转换为Document准备解析


DefaultBeanDefinitionDocumentReader：解析xml

 /**
	 * Parse the elements at the root level in the document:
	 * "import", "alias", "bean".
	 * @param root the DOM root element of the document
	 */
	protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {//解析<beans>
		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);//解析spring下定义的标签
					}
					else {
						delegate.parseCustomElement(ele);//解析自定义的标签，通过自定义NamespaceHandler接口的实现解析自定义标签
					}
				}
			}
		}
		else {
			delegate.parseCustomElement(root);
		}
	}
	
	
	private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
		if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {//解析<import>
			importBeanDefinitionResource(ele);
		}
		else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {//解析<alias>
			processAliasRegistration(ele);
		}
		else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {//解析<bean>
			processBeanDefinition(ele, delegate);
		}
		else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {//解析<beans>
			// recurse
			doRegisterBeanDefinitions(ele);
		}
	}


    最后就是DefaultListableBeanFactory的registerBeanDefinition方法把Beandefinition放入到beanDefinitionMap中。
    这就完成了整个根据xml配置获取并注册BeanDefinition的过程。
avatar
文章
阅读
粉丝