SSM源码分析之Spring03-IOC实现原理

前言

上一小节我们对Spring的组成模块做了一个整体的了解《SSM源码分析之Spring02-Spring源码分析前瞻》,这节我们跟着源码学习一下Spring是如何管理Bean的。

IOC/DI

IOC(Inversion of Control)控制反转:所谓控制反转,就是把原先我们代码里面需要实现的对象创建、依赖的代码,反转给容器来帮忙实现。那么必然的我们需要创建一个容器,同时需要一种描述来让容器知道需要创建的对象与对象的关系。这个描述最具体表现就是我们可配置的文件。

依赖注入,就是把BeanDefinition中的信息读取出来,利用反射机制,或者代理机制创建对象,新创建的对象,不会放到我们印象中的IOC容器中,它存入到另外一个cache容器

Wrapper对原生对象的包装,通过构造方法存储原始对象,放入cache的只是Wrapper

减少代码侵入,能够在原生的基础之上,再进行扩展,监听器,回调函数,标记信息

DI(Dependency Injection)依赖注入:就是指对象是被动接受依赖类而不是自己主动去找,换句话说就是指对象不是从容器中查找它依赖的类,而是在容器实例化对象的时候主动将它依赖的类注入给它。

先从我们自己设计这样一个视角来考虑:

对象和对象关系怎么表示?

可以用 xml,properties 文件等语义化配置文件表示。

扫描二维码关注公众号,回复: 8873438 查看本文章

描述对象关系的文件存放在哪里?

可能是 classpath,filesystem,或者是 URL 网络资源,servletContext 等。

回到正题,有了配置文件,还需要对配置文件解析。

不同的配置文件对对象的描述不一样,如标准的,自定义声明式的,如何统一?在内部需要有一个统一的关于对象的定义,所有外部的描述都必须转化成统一的描述定义。

如何对不同的配置文件进行解析?需要对不同的配置文件语法,采用不同的解析器

Spring 核心容器体系结构

BeanFactory

BeanDefinition 相当于是保存在内存中的配置文件,保存了所有的跟类属性相关信息

Spring Bean的创建是典型的工厂模式,这一系列的 Bean 工厂,也即 IOC 容器为开发者管理对象间的依赖关系提供了很多便利和基础服务,在 Spring 中有许多的 IOC 容器的实现供用户选择和使用,其相互关系如下:
在这里插入图片描述
其中 BeanFactory 作为最顶层的一个接口类,它定义了 IOC 容器的基本功能规范,BeanFactory 有三个子类:ListableBeanFactoryHierarchicalBeanFactoryAutowireCapableBeanFactory

但是从上图中我们可以发现最终的默认实现类是DefaultListableBeanFactory,他实现了所有的接口。那为何要定义这么多层次的接口呢?

查阅这些接口的源码和说明发现,每个接口都有他使用的场合,它主要是为了区分在 Spring 内部在操作过程中对象的传递和转化过程中,对对象的数据访问所做的限制。

例如 ListableBeanFactory 接口表示这些 Bean 是可列表的,而 HierarchicalBeanFactory 表示的是这些 Bean 是有继承关系的,也就是每个 Bean 有可能有父 Bean。

AutowireCapableBeanFactory接口定义 Bean 的自动装配规则。这四个接口共同定义了 Bean 的集合、Bean 之间的关系、以及 Bean 行为。

/**
  *最基本的 IOC 容器接口 BeanFactory
  **/
public interface BeanFactory {

	/**
	 * 对FactoryBean的转义定义,因为如果使用bean的名字检索FactoryBean得到的对象是工厂生成的对象,
	 * 如果需要得到工厂本身,需要转义
	 */
	String FACTORY_BEAN_PREFIX = "&";

	//根据 bean 的名字,获取在 IOC 容器中得到 bean 实例
	Object getBean(String name) throws BeansException;

	//根据 bean 的名字和 Class 类型来得到 bean 实例,增加了类型安全验证机制。
	<T> T getBean(String name, @Nullable Class<T> requiredType) throws BeansException;


	Object getBean(String name, Object... args) throws BeansException; 
	
	<T> T getBean(Class<T> requiredType) throws BeansException;

	<T> T getBean(Class<T> requiredType, Object... args) throws BeansException;

	//提供对 bean 的检索,看看是否在 IOC 容器有这个名字的 bean
	boolean containsBean(String name);

	//根据 bean 名字得到 bean 实例,并同时判断这个 bean 是不是单例
	boolean isSingleton(String name) throws NoSuchBeanDefinitionException; 

	boolean isPrototype(String name) throws NoSuchBeanDefinitionException;

	boolean isTypeMatch(String name, ResolvableType typeToMatch) throws NoSuchBeanDefinitionException; 

	boolean isTypeMatch(String name, @Nullable Class<?> typeToMatch) throws NoSuchBeanDefinitionException;

	//得到 bean 实例的 Class 类型
	@Nullable
	Class<?> getType(String name) throws NoSuchBeanDefinitionException;

	//得到 bean 的别名,如果根据别名检索,那么其原名也会被检索出来 
	String[] getAliases(String name);

}

在 BeanFactory 里只对 IOC 容器的基本行为作了定义,根本不关心你的 Bean 是如何定义怎样加载的。

正如我们只关心工厂里得到什么的产品对象,至于工厂是怎么生产这些对象的,这个基本的接口不关心。

而要知道工厂是如何产生对象的,我们需要看具体的 IOC 容器实现,Spring 提供了许多 IOC 容器的实现。比如 XmlBeanFactory,ClasspathXmlApplicationContext 等。

其中 XmlBeanFactory 就是针对最基本的 IOC 容器的实现,这个 IOC 容器可以读取 XML 文件定义的 BeanDefinition(XML 文件中对 bean 的描述),如果说 XmlBeanFactory 是容器中的屌丝,ApplicationContext 应该算容器中的高帅富.

ApplicationContext 是 Spring 提供的一个高级的 IOC 容器,它除了能够提供 IOC 容器的基本功能外,还为用户提供了以下的附加服务。

从ApplicationContext 接口的实现,我们看出其特点:

1.支持信息源,可以实现国际化。(实现 MessageSource 接口)

2.访问资源。(实现 ResourcePatternResolver 接口,后面章节会讲到)

3.支持应用事件。(实现 ApplicationEventPublisher 接口)

BeanDefinition

静态配置文件的一个内存版本,保存了所有的OOP关系
SpringIOC 容器管理了我们定义的各种 Bean 对象及其相互的关系,Bean 对象在 Spring 实现中是以BeanDefinition 来描述的,其继承体系如下:
在这里插入图片描述
Bean 的解析过程非常复杂,功能被分的很细,因为这里需要被扩展的地方很多,必须保证有足够的灵活性,以应对可能的变化。Bean 的解析主要就是对 Spring 配置文件的解析。这个解析过程主要通过下图中的类完成:
在这里插入图片描述

IOC容器的初始化

IOC容器的初始化包括 BeanDefinition的Resource 定位、载入和注册这三个基本的过程。

  • 定位:资源配置Import、classpath、url
  • 加载:解析配置文件,把bean包装成BeanDefinition对象
  • 注册:把已经初始化的BeanDefinition对象放入到IOC容器之中

我们以ApplicationContext 为例讲解,ApplicationContext 系列容器也许是我们最熟悉的,因为Web项目中使用的 XmlWebApplicationContext 就属于这个继承体系,还有ClasspathXmlApplicationContext 等,其继承体系如下图所示:
在这里插入图片描述
ApplicationContext 允许上下文嵌套,通过保持父上下文可以维持一个上下文体系。对于 Bean 的查找可以在这个上下文体系中发生,首先检查当前上下文,其次是父上下文,逐级向上,这样为不同的 Spring 应用提供了一个共享的 Bean 定义环境。

下面我们分别简单地演示一下两种 IOC 容器的创建过程

XmlBeanFactory的整个流程

通过 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);

}

}

参照源码,自己演示一遍,理解定位、载入、注册的全过程

//根据 Xml 配置文件创建 Resource 资源对象,该对象中包含了 BeanDefinition 的信息 ClassPathResource resource = new ClassPathResource("application-context.xml");

//创建 DefaultListableBeanFactory

DefaultListableBeanFactory factory = new DefaultListableBeanFactory(); //创建 XmlBeanDefinitionReader 读取器,用于载入 BeanDefinition。

//之所以需要 BeanFactory 作为参数,是因为会将读取的信息回调配置给 factory XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(factory);

//XmlBeanDefinitionReader 执行载入 BeanDefinition 的方法,最后会完成 Bean 的载入和注册。

//完成后 Bean 就成功的放置到 IOC 容器当中,以后我们就可以从中取得 Bean 来使用 reader.loadBeanDefinitions(resource);

通过前面的源码,XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(this); 中其中 this 传的是 factory 对象

FileSystemXmlApplicationContext 的 IOC 容器流程

我们以FileSystemXmlApplicationContext为引,进入Spring源码的世界

IOC 解剖

ApplicationContext = new FileSystemXmlApplicationContext(xmlPath);
先看其构造函数的调用:

public FileSystemXmlApplicationContext(String... configLocations) throws BeansException {

this(configLocations, true, null);

}

其实际调用的构造函数为:

public FileSystemXmlApplicationContext(
String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)throws BeansException {

super(parent);
setConfigLocations(configLocations);

if (refresh) {
refresh();
}

}

设置资源加载器和资源定位

通过分析FileSystemXmlApplicationContext的源代码可以知道,在创建

FileSystemXmlApplicationContext 容器时,构造方法做以下两项重要工作:

首先,调用父类容器的构造方法(super(parent)方法)为容器设置好 Bean 资源加载器。

然后,再调用父类AbstractRefreshableConfigApplicationContext的setConfigLocations(configLocations)方法设置Bean定义资源文件的定位路径。

通过追踪FileSystemXmlApplicationContext的继承体系,发现其父类的父类

AbstractApplicationContext 中初始化 IOC 容器所做的主要源码如下:

public abstract class AbstractApplicationContext extends DefaultResourceLoader implements ConfigurableApplicationContext {
//静态初始化块,在整个容器创建过程中只执行一次

static {

//为了避免应用程序在 Weblogic8.1 关闭时出现类加载异常加载问题,加载 IOC 容

//器关闭事件(ContextClosedEvent)类

ContextClosedEvent.class.getName();

}

public AbstractApplicationContext() {

this.resourcePatternResolver = getResourcePatternResolver();

}

public AbstractApplicationContext(@Nullable ApplicationContext parent) { this();
setParent(parent);

}

//获取一个 Spring Source 的加载器用于读入 Spring Bean 定义资源文件 protected ResourcePatternResolver getResourcePatternResolver() {

//AbstractApplicationContext 继承 DefaultResourceLoader,因此也是一个资源加载器

//Spring 资源加载器,其 getResource(String location)方法用于载入资源

return new PathMatchingResourcePatternResolver(this);

}

//...

}

AbstractApplicationContext 构造方法中调用 PathMatchingResourcePatternResolver 的构造方法创建 Spring 资源加载器:

public PathMatchingResourcePatternResolver(ResourceLoader resourceLoader) { Assert.notNull(resourceLoader, "ResourceLoader must not be null"); //设置 Spring 的资源加载器

this.resourceLoader = resourceLoader;

}

在 设 置 容 器 的 资 源 加 载 器 之 后 , 接 下 来 FileSystemXmlApplicationContext 执 行 setConfigLocations 方法通过调用其父类 AbstractRefreshableConfigApplicationContext 的方法进行对 Bean 定义资源文件的定位,该方法的源码如下:

//处理单个资源文件路径为一个字符串的情况

public void setConfigLocation(String location) {

//String CONFIG_LOCATION_DELIMITERS = ",; /t/n";

//即多个资源文件路径之间用” ,; \t\n”分隔,解析成数组形式

setConfigLocations(StringUtils.tokenizeToStringArray(location, CONFIG_LOCATION_DELIMITERS));

}

//解析 Bean 定义资源文件的路径,处理多个资源文件字符串数组

public void setConfigLocations(@Nullable String... locations) { if (locations != null) {
Assert.noNullElements(locations, "Config locations must not be null"); this.configLocations = new String[locations.length]; for (int i = 0; i < locations.length; i++) {
//resolvePath 为同一个类中将字符串解析为路径的方法

this.configLocations[i] = resolvePath(locations[i]).trim();

}

}

else {

this.configLocations = null;

}

}

通过这两个方法的源码我们可以看出,我们既可以使用一个字符串来配置多个 Spring Bean 定义资源文件,也可以使用字符串数组,即下面两种方式都是可以的:

ClasspathResource res = new ClasspathResource(“a.xml,b.xml,……”);

多个资源文件路径之间可以是用” , ; \t\n”等分隔。

B. ClasspathResource res = new ClasspathResource(newString[]{“a.xml”,”b.xml”,……});

至此,SpringIOC 容器在初始化时将配置的 Bean 定义资源文件定位为 Spring 封装的 Resource。

refresh函数载入

AbstractApplicationContext 的 refresh 函数载入 Bean 定义过程:
SpringIOC 容器对 Bean 定义资源的载入是从 refresh()函数开始的,refresh()是一个模板方法,refresh()方法的作用是:在创建 IOC 容器前,如果已经有容器存在,则需要把已有的容器销毁和关闭,
以保证在 refresh 之后使用的是新建立起来的 IOC 容器。refresh 的作用类似于对 IOC 容器的重启,在新建立好的容器中对容器进行初始化,对 Bean 定义资源进行载入

FileSystemXmlApplicationContext 通过调用其父类 AbstractApplicationContext 的 refresh()

函数启动整个 IOC 容器对 Bean 定义的载入过程:

public void refresh() throws BeansException, IllegalStateException { synchronized (this.startupShutdownMonitor) {
//调用容器准备刷新的方法,获取容器的当时时间,同时给容器设置同步标识 prepareRefresh();

//告诉子类启动 refreshBeanFactory()方法,Bean 定义资源文件的载入从

//子类的 refreshBeanFactory()方法启动

ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

//为 BeanFactory 配置容器特性,例如类加载器、事件处理器等

prepareBeanFactory(beanFactory);

try {

//为容器的某些子类指定特殊的 BeanPost 事件处理器

postProcessBeanFactory(beanFactory);

//调用所有注册的 BeanFactoryPostProcessor 的 Bean

invokeBeanFactoryPostProcessors(beanFactory);

//为 BeanFactory 注册 BeanPost 事件处理器.

//BeanPostProcessor 是 Bean 后置处理器,用于监听容器触发的事件

registerBeanPostProcessors(beanFactory);

//初始化信息源,和国际化相关.

initMessageSource();

//初始化容器事件传播器.

initApplicationEventMulticaster();

//调用子类的某些特殊 Bean 初始化方法

onRefresh();

//为事件传播器注册事件监听器.

registerListeners();

//初始化所有剩余的单例 Bean

finishBeanFactoryInitialization(beanFactory);

//初始化容器的生命周期事件处理器,并发布容器的生命周期事件

finishRefresh();

}

catch (BeansException ex) {

if (logger.isWarnEnabled()) {

logger.warn("Exception encountered during context initialization - " + "cancelling refresh attempt: " + ex);
}

//销毁已创建的 Bean

destroyBeans();

//取消 refresh 操作,重置容器的同步标识.

cancelRefresh(ex);
throw ex;

}

finally {

resetCommonCaches();

}

}

}

refresh()方法主要为IOC容器Bean的生命周期管理提供条件,Spring IOC 容器载入Bean定义资源文 件从其子类容器的refreshBeanFactory() 方法启 动,所以整 个refresh() 中 “ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();”这句以后代码的都是注册容器的信息源和生命周期事件,载入过程就是从这句代码启动。

refresh()方法的作用是:在创建 IOC 容器前,如果已经有容器存在,则需要把已有的容器销毁和关闭,以保证在 refresh 之后使用的是新建立起来的 IOC 容器。refresh 的作用类似于对 IOC 容器的重启,在新建立好的容器中对容器进行初始化,对 Bean 定义资源进行载入。

启动容器

AbstractApplicationContext的obtainFreshBeanFactory() 方 法 调 用 子 类 容 器 的refreshBeanFactory()方法,启动容器载入 Bean 定义资源文件的过程,代码如下:

protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {

//这里使用了委派设计模式,父类定义了抽象的 refreshBeanFactory()方法,具体实现调用子类容器的 refreshBeanFactory()方法
refreshBeanFactory();

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

}

return beanFactory;

}

AbstractApplicationContext 类中只抽象定义了 refreshBeanFactory()方法,容器真正调用的是其子类 AbstractRefreshableApplicationContext 实现的 refreshBeanFactory()方法,方法的源码如下:

protected final void refreshBeanFactory() throws BeansException { //如果已经有容器,销毁容器中的 bean,关闭容器

if (hasBeanFactory()) {

destroyBeans();

closeBeanFactory();

}

try {

//创建 IOC 容器

DefaultListableBeanFactory beanFactory = createBeanFactory(); beanFactory.setSerializationId(getId());
//对 IOC 容器进行定制化,如设置启动参数,开启注解的自动装配等

customizeBeanFactory(beanFactory);

//调用载入 Bean 定义的方法,主要这里又使用了一个委派模式,在当前类中只定义了抽象的 loadBeanDefinitions 方法,具体的实现调用子类容器

loadBeanDefinitions(beanFactory);

synchronized (this.beanFactoryMonitor) {

this.beanFactory = beanFactory;

}

}

catch (IOException ex) {

throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(),ex);

}

}

在这个方法中,先判断 BeanFactory 是否存在,如果存在则先销毁 beans 并关闭 beanFactory,接着创建 DefaultListableBeanFactory,并调用 loadBeanDefinitions(beanFactory)装载 bean 定义。

loadBeanDefinitions

AbstractRefreshableApplicationContext 子类的 loadBeanDefinitions 方法:
AbstractRefreshableApplicationContext 中只定义了抽象的 loadBeanDefinitions 方法,容器真 正 调 用 的 是 其 子 类 AbstractXmlApplicationContext对该方法的实现, AbstractXmlApplicationContext的主要源码如下:

loadBeanDefinitions方法同样是抽象方法,是由其子类实现的,也即在AbstractXmlApplicationContext 中。

public abstract class AbstractXmlApplicationContext extends AbstractRefreshable, ConfigApplicationContext {

...
//实现父类抽象的载入 Bean 定义方法

@Override
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException{

//创建 XmlBeanDefinitionReader,即创建 Bean 读取器,并通过回调设置到容器中去,容器使用该读取器读取 Bean 定义资源 
XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);

/**
  *为 Bean 读取器设置 Spring 资源加载器,AbstractXmlApplicationContext 的
祖先父类 AbstractApplicationContext 继承 DefaultResourceLoader,因此,容器本身也是一个资源加载器 
**/
beanDefinitionReader.setEnvironment(this.getEnvironment()); beanDefinitionReader.setResourceLoader(this);

//为 Bean 读取器设置 SAX xml 解析器
beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));


//当 Bean 读取器读取 Bean 定义的 Xml 资源文件时,启用 Xml 的校验机制
 initBeanDefinitionReader(beanDefinitionReader);

//Bean 读取器真正实现加载的方法
loadBeanDefinitions(beanDefinitionReader);

}


protected void initBeanDefinitionReader(XmlBeanDefinitionReader reader) { reader.setValidating(this.validating);
}


//Xml Bean 读取器加载 Bean 定义资源
protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException { //获取 Bean 定义资源的定位

Resource[] configResources = getConfigResources();

if (configResources != null) {

//Xml Bean 读取器调用其父类 AbstractBeanDefinitionReader 读取定位的 Bean 定义资源 
reader.loadBeanDefinitions(configResources);

}

//如果子类中获取的 Bean 定义资源定位为空,则获取 FileSystemXmlApplicationContext

//构造方法中 setConfigLocations 方法设置的资源
String[] configLocations = getConfigLocations();

if (configLocations != null) {

//Xml Bean 读取器调用其父类 AbstractBeanDefinitionReader 读取定位
//的 Bean 定义资源
reader.loadBeanDefinitions(configLocations);

}

}


//这里又使用了一个委托模式,调用子类的获取 Bean 定义资源定位的方法

//该方法在 ClassPathXmlApplicationContext 中进行实现,对于我们
//举例分析源码的 FileSystemXmlApplicationContext 没有使用该方法

 @Nullable
protected Resource[] getConfigResources() {

return null;

}

}

Xml Bean 读取器 (XmlBeanDefinitionReader) 调用其父类 AbstractBeanDefinitionReader 的 reader.loadBeanDefinitions 方法读取 Bean 定义资源。

由于我们使用 FileSystemXmlApplicationContext 作为例子分析,因此 getConfigResources 的返回值为 null,因此程序执行 reader.loadBeanDefinitions(configLocations)分支。

读取Bean定义资源

AbstractBeanDefinitionReader 读 取 Bean 定 义 资 源 , 在其抽象父类AbstractBeanDefinitionReader 中定义了载入过程。
AbstractBeanDefinitionReader 的 loadBeanDefinitions 方法源码如下:

//重载方法,调用下面的 loadBeanDefinitions(String, Set<Resource>);方法

@Override

public int loadBeanDefinitions(String location) throws BeanDefinitionStoreException { return loadBeanDefinitions(location, null);
}


public int loadBeanDefinitions(String location, @Nullable Set<Resource> actualResources) throws BeanDefinitionStoreException {
//获取在 IOC 容器初始化过程中设置的资源加载器

ResourceLoader resourceLoader = getResourceLoader();

if (resourceLoader == null) {

throw new BeanDefinitionStoreException(

"Cannot import bean definitions from location [" + location + "]: no ResourceLoader available");

}


if (resourceLoader instanceof ResourcePatternResolver) {

//Resource pattern matching available. try {
//将指定位置的 Bean 定义资源文件解析为 Spring IOC 容器封装的资源

//加载多个指定位置的 Bean 定义资源文件

Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location); 
//委派调用其子类 XmlBeanDefinitionReader 的方法,实现加载功能

int loadCount = loadBeanDefinitions(resources);

if (actualResources != null) {

for (Resource resource : resources) {

actualResources.add(resource);

}

}

if (logger.isDebugEnabled()) {

logger.debug("Loaded " + loadCount + " bean definitions from location pattern [" + location + "]");

}

return loadCount;

}

catch (IOException ex) {

throw new BeanDefinitionStoreException(

"Could not resolve bean definition resource pattern [" + location + "]", ex);

}

}

else {

// Can only load single resources by absolute URL.

//将指定位置的 Bean 定义资源文件解析为 Spring IOC 容器封装的资源

//加载单个指定位置的 Bean 定义资源文件

Resource resource = resourceLoader.getResource(location); //委派调用其子类 XmlBeanDefinitionReader 的方法,实现加载功能

int loadCount = loadBeanDefinitions(resource);

if (actualResources != null) {

actualResources.add(resource);

}

if (logger.isDebugEnabled()) {

logger.debug("Loaded " + loadCount + " bean definitions from location [" + location + "]");

}

return loadCount;

}

}


//重载方法,调用 loadBeanDefinitions(String);

@Override
public int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException { Assert.notNull(locations, "Location array must not be null");
int counter = 0;

for (String location : locations) {

counter += loadBeanDefinitions(location);

}

return counter;

}

loadBeanDefinitions(Resource…resources)方法和上面分析的 3 个方法类似,同样也是调用 XmlBeanDefinitionReader 的 loadBeanDefinitions 方法。

从对 AbstractBeanDefinitionReader 的 loadBeanDefinitions 方法源码分析可以看出该方法做了以下两件事:

首先,调用资源加载器的获取资源方法 resourceLoader.getResource(location),获取到要加载的资源。其次,真正执行加载功能是其子类 XmlBeanDefinitionReader 的 loadBeanDefinitions 方法。

在这里插入图片描述
在这里插入图片描述
看到上面的ResourceLoader 与 ApplicationContext 的继承系图,可以知道其实际调用的是DefaultResourceLoader 中 的 getSource() 方法定位 Resource , 因 为 FileSystemXmlApplicationContext 本身就是 DefaultResourceLoader 的实现类,所以此时又回到了FileSystemXmlApplicationContext中来。

资源加载器获取要读入的资源

XmlBeanDefinitionReader 通过调用其父类 DefaultResourceLoader 的 getResource 方法获取要加载的资源,其源码如下

//获取 Resource 的具体实现方法

@Override
public Resource getResource(String location) {

Assert.notNull(location, "Location must not be null");


for (ProtocolResolver protocolResolver : this.protocolResolvers) { Resource resource = protocolResolver.resolve(location, this); if (resource != null) {

return resource;

}

}

//如果是类路径的方式,那需要使用 ClassPathResource 来得到 bean 文件的资源对象
if (location.startsWith("/")) {

return getResourceByPath(location);

}

else if (location.startsWith(CLASSPATH_URL_PREFIX)) {

return new ClassPathResource(location.substring(CLASSPATH_URL_PREFIX.length()), getClassLoader());

}

else {

try {

//如果是 URL 方式,使用 UrlResource 作为 bean 文件的资源对象 URL url = new URL(location);

return (ResourceUtils.isFileURL(url) ? new FileUrlResource(url) : new UrlResource(url));

}

catch (MalformedURLException ex) {

//如果既不是 classpath 标识,又不是 URL 标识的 Resource 定位,则调用
//容器本身的 getResourceByPath 方法获取 Resource

return getResourceByPath(location);

}

}

}

FileSystemXmlApplicationContext 容器提供了 getResourceByPath 方法的实现,就是为了处理既不是 classpath 标识,又不是 URL 标识的 Resource 定位这种情况。

@Override

protected Resource getResourceByPath(String path) {

if (path.startsWith("/")) {

path = path.substring(1);

}

//这里使用文件系统资源对象来定义 bean 文件
return new FileSystemResource(path);

}

这样代码就回到了 FileSystemXmlApplicationContext 中来,他提供了 FileSystemResource 来完成从文件系统得到配置文件的资源定义。

这样,就可以从文件系统路径上对 IOC 配置文件进行加载,当然我们可以按照这个逻辑从任何地方加载,在Spring中我们看到它提供的各种资源抽象,比如
ClassPathResource,URLResource,FileSystemResource 等来供我们使用。上面我们看到的是定位Resource 的一个过程,而这只是加载过程的一部分.

XmlBeanDefinitionReader加载 Bean定义资源

继续回到 XmlBeanDefinitionReader 的 loadBeanDefinitions(Resource …) 方法看到代表bean 文件的资源定义以后的载入过程。

//XmlBeanDefinitionReader 加载资源的入口方法

@Override

public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException { //将读入的 XML 资源进行特殊编码处理

return loadBeanDefinitions(new EncodedResource(resource));

}


//这里是载入 XML 形式 Bean 定义资源文件方法

public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {

...

try {

//将资源文件转为 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();

}

}

...

}

//从特定 XML 文件中实际载入 Bean 定义资源的方法

protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)

throws BeanDefinitionStoreException {

try {

//将 XML 文件转换为 DOM 对象,解析过程由 documentLoader 实现

Document doc = doLoadDocument(inputSource, resource);

//这里是启动对 Bean 定义解析的详细过程,该解析过程会用到 Spring 的 Bean 配置规则 
return registerBeanDefinitions(doc, resource);

}

...

}

通过源码分析,载入 Bean 定义资源文件的最后一步是将 Bean 定义资源转换为 Document 对象,该过程由documentLoader 实现

Bean定义资源转换为Document 对象

DocumentLoader将Bean定义资源转换成 Document对象的源码如下:


//使用标准的 JAXP 将载入的 Bean 定义资源转换成 document 对象

@Override
public Document loadDocument(InputSource inputSource, EntityResolver entityResolver, ErrorHandler errorHandler, int validationMode, boolean namespaceAware) throws Exception {

//创建文件解析器工厂
DocumentBuilderFactory factory = createDocumentBuilderFactory(validationMode, namespaceAware);

if (logger.isDebugEnabled()) {

logger.debug("Using JAXP provider [" + factory.getClass().getName() + "]");

}

//创建文档解析器

DocumentBuilder builder = createDocumentBuilder(factory, entityResolver, errorHandler); //解析 Spring 的 Bean 定义资源

return builder.parse(inputSource);

}


protected DocumentBuilderFactory createDocumentBuilderFactory(int validationMode, boolean namespaceAware) throws ParserConfigurationException {

//创建文档解析工厂
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); factory.setNamespaceAware(namespaceAware);

//设置解析 XML 的校验
if (validationMode != XmlValidationModeDetector.VALIDATION_NONE) { factory.setValidating(true);
if (validationMode == XmlValidationModeDetector.VALIDATION_XSD) {

//Enforce namespace aware for XSD...

factory.setNamespaceAware(true); try {
factory.setAttribute(SCHEMA_LANGUAGE_ATTRIBUTE, XSD_SCHEMA_LANGUAGE);

}

catch (IllegalArgumentException ex) { ParserConfigurationException pcex = new ParserConfigurationException(
"Unable to validate using XSD: Your JAXP provider [" + factory +

"] does not support XML Schema. Are you running on Java 1.4 with Apache Crimson? " + "Upgrade to Apache Xerces (or Java 1.5) for full XSD support.");
pcex.initCause(ex); throw pcex;
}

}

}


return factory;

}

该解析过程调用 JavaEE 标准的 JAXP 标准进行处理。

至此 Spring IOC 容器根据定位的 Bean 定义资源文件,将其加载读入并转换成为 Document 对象过程完成。接下来我们要继续分析Spring IOC容器将载入的 Bean 定义资源文件转换为 Document对象之后,是如何将其解析为 Spring IOC 管理的 Bean 对象并将其注册到容器中的。

XmlBeanDefinitionReader解析载入的Bean定义资源文件

XmlBeanDefinitionReader类中的doLoadBeanDefinitions方法是从特定 XML文件中实际载入Bean定义资源的方法,该方法在载入Bean定义资源之后将其转换为 Document对象,接下来调用 registerBeanDefinitions 启 动 Spring IOC 容器对Bean定义的解析过程, registerBeanDefinitions 方法源码如下:

//按照 Spring 的 Bean 语义要求将 Bean 定义资源解析并转换为容器内部数据结构

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
 //得到 BeanDefinitionDocumentReader 来对 xml 格式的 BeanDefinition 解析 
 BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader(); //获得容器中注册的 Bean 数量

int countBefore = getRegistry().getBeanDefinitionCount();

//解析过程入口,这里使用了委派模式,BeanDefinitionDocumentReader 只是个接口,
 //具体的解析实现过程有实现类 DefaultBeanDefinitionDocumentReader 完成 
 documentReader.registerBeanDefinitions(doc, createReaderContext(resource)); //统计解析的 Bean 数量

return getRegistry().getBeanDefinitionCount() - countBefore;

}

Bean 定义资源的载入解析分为以下两个过程:

首先,通过调用 XML 解析器将 Bean 定义资源文件转换得到Document对象,但是这些 Document对象并没有按照Spring的Bean规则进行解析。这一步是载入的过程

其次,在完成通用的XML解析之后,按照Spring的Bean规则对Document 对象进行解析。

按照Spring的Bean规则对Document对象解析的过程是在接口 BeanDefinitionDocumentReader的实现类 DefaultBeanDefinitionDocumentReader中实现的。

解析Document对象

DefaultBeanDefinitionDocumentReader对Bean定义的Document对象解析:

BeanDefinitionDocumentReader 接 口 通 过 registerBeanDefinitions 方 法 调 用 其 实 现 类 DefaultBeanDefinitionDocumentReader 对 Document 对象进行解析,解析的代码在Spring源码地址:
org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader
(此类由于篇幅过长,需读者自行查阅)
通过上述 Spring IOC 容器对载入的 Bean 定义 Document 解析可以看出,我们使用 Spring 时,在 Spring 配置文件中可以使用元素来导入 IOC 容器所需要的其他资源,Spring IOC 容器在解析时会首先将指定导入的资源加载进容器中。使用别名时,Spring IOC 容器首先将别名元素所定义的别名注册到容器中。

对于既不是元素,又不是元素的元素,即 Spring 配置文件中普通的元素的解析由 BeanDefinitionParserDelegate 类的 parseBeanDefinitionElement 方法来实现。

BeanDefinitionParserDelegate解析<bean>元素

Bean 定义资源文件中的和元素解析在 DefaultBeanDefinitionDocumentReader

中已经完成,对 Bean 定义资源文件中使用最多的元素交由 BeanDefinitionParserDelegate 来解析,其解析,解析的代码在Spring源码地址:
org.springframework.beans.factory.xml.BeanDefinitionParserDelegate
(此类由于篇幅过长,需读者自行查阅)
只要使用过 Spring,对 Spring 配置文件比较熟悉的人,通过对上述源码的分析,就会明白我们在 Spring 配置文件中元素的中配置的属性就是通过该方法解析和设置到 Bean 中去的。

注意:在解析 元素过程中没有创建和实例化 Bean 对象,只是创建了 Bean 对象的定义类BeanDefinition,将元素中的配置信息设置到 BeanDefinition 中作为记录,当依赖注入时才使用这些记录信息创建和实例化具体的 Bean 对象。

上面方法中一些对一些配置如元信息(meta)、qualifier 等的解析,我们在 Spring 中配置时使用的也不多,我们在使用 Spring 的元素时,配置最多的是属性,因此我们下面继续分析源码,了解 Bean 的属性在解析时是如何设置的。

BeanDefinitionParserDelegate 解析 <property> 元素

BeanDefinitionParserDelegate 在解析调用 parsePropertyElements 方法解析元素中的属性子元素,解析的代码在Spring源码地址:

org.springframework.beans.factory.xml.BeanDefinitionParserDelegate#parsePropertyElement
(此类由于篇幅过长,需读者自行查阅)
通过对上述源码的分析,我们可以了解在 Spring 配置文件中,元素中元素的相关配置是如何处理的:

a.ref 被封装为指向依赖对象一个引用。

b.value 配置都会封装成一个字符串类型的对象。

c.ref 和 value 都通过“解析的数据类型属性值.setSource(extractSource(ele));”方法将属性值/引用与所引用的属性关联起来。

在方法的最后对于元素的子元素通过 parsePropertySubElement 方法解析,我们继续分析该方法的源码,了解其解析过程。

解析 <property> 元素的子元素

在BeanDefinitionParserDelegate 类中的 parsePropertySubElement 方法对中的子元素解析,解析的代码在Spring源码地址:
org.springframework.beans.factory.xml.BeanDefinitionParserDelegate#parsePropertySubElement
(此类由于篇幅过长,需读者自行查阅)
通过上述源码分析,我们明白了在 Spring 配置文件中,对元素中配置的 array、list、set、map、prop 等各种集合子元素的都通过上述方法解析,生成对应的数据对象,比如 ManagedList、
ManagedArray、ManagedSet 等,这些 Managed 类是 Spring 对象 BeanDefiniton 的数据封装,对集

合数据类型的具体解析有各自的解析方法实现,解析方法的命名非常规范,一目了然,我们对集合元素的解析方法进行源码分析,了解其实现过程。

解析<list>子元素

在BeanDefinitionParserDelegate 类中的 parseListElement 方法就是具体实现解析:

//解析<list>集合子元素

public List<Object> parseListElement(Element collectionEle, @Nullable BeanDefinition bd) { //获取<list>元素中的 value-type 属性,即获取集合元素的数据类型

String defaultElementType = collectionEle.getAttribute(VALUE_TYPE_ATTRIBUTE); //获取<list>集合元素中的所有子节点

NodeList nl = collectionEle.getChildNodes();

//Spring 中将 List 封装为 ManagedList

ManagedList<Object> target = new ManagedList<>(nl.getLength());

target.setSource(extractSource(collectionEle));

//设置集合目标数据类型

target.setElementTypeName(defaultElementType);

target.setMergeEnabled(parseMergeAttribute(collectionEle));

//具体的<list>元素解析

parseCollectionElements(nl, target, bd, defaultElementType); return target;
}


//具体解析<list>集合元素,<array>、<list>和<set>都使用该方法解析 protected void parseCollectionElements(

NodeList elementNodes, Collection<Object> target, @Nullable BeanDefinition bd, String defaultElementType)

{

//遍历集合所有节点

for (int i = 0; i < elementNodes.getLength(); i++) {

Node node = elementNodes.item(i);

//节点不是 description 节点

if (node instanceof Element && !nodeNameEquals(node, DESCRIPTION_ELEMENT)) { 
//将解析的元素加入集合中,递归调用下一个子元素
 target.add(parsePropertySubElement((Element) node, bd, defaultElementType));

}

}

}

经过对 Spring Bean 定义资源文件转换的 Document 对象中的元素层层解析,Spring IOC 现在已经将 XML 形式定义的 Bean 定义资源文件转换为 Spring IOC 所识别的数据结构——BeanDefinition,它是 Bean 定 义 资 源 文 件 中 配 置 的 POJO 对 象 在 Spring IOC 容 器 中 的 映 射 , 我 们 可 以 通 过

AbstractBeanDefinition 为入口,看到了 IOC 容器进行索引、查询和操作。

通过 Spring IOC 容器对 Bean 定义资源的解析后,IOC 容器大致完成了管理 Bean 对象的准备工作,即初始化过程,但是最为重要的依赖注入还没有发生,现在在 IOC 容器中 BeanDefinition 存储的只是一些静态信息,接下来需要向容器注册 Bean 定义信息才能全部完成 IOC 容器的初始化过程

解析过后的BeanDefinition 在IOC 容器中的注册

让我们继续跟踪程序的执行顺序,接下来我们来分析 DefaultBeanDefinitionDocumentReader 对 Bean 定义转换的 Document 对象解析的流程中,在其 parseDefaultElement 方法中完成对 Document 对 象 的 解 析 后 得 到 封 装 BeanDefinition 的 BeanDefinitionHold 对 象 , 然 后 调 用 BeanDefinitionReaderUtils 的 registerBeanDefinition 方法向 IOC 容器注册解析的 Bean , BeanDefinitionReaderUtils 的注册的源码如下:

//将解析的 BeanDefinitionHold 注册到容器中
public static void registerBeanDefinition(

BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)

throws BeanDefinitionStoreException {

//获取解析的 BeanDefinition 的名称
String beanName = definitionHolder.getBeanName();

//向 IOC 容器注册 BeanDefinition
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());

//如果解析的 BeanDefinition 有别名,向容器为其注册别名
String[] aliases = definitionHolder.getAliases();

if (aliases != null) {

for (String alias : aliases) {

registry.registerAlias(beanName, alias);

}

}

}

当调用 BeanDefinitionReaderUtils 向 IOC 容器注册解析的 BeanDefinition 时,真正完成注册功能的是 DefaultListableBeanFactory。

DefaultListableBeanFactory向IOC容器注册解析后的BeanDefinition

在这里插入图片描述
DefaultListableBeanFactory 中使用一个 HashMap 的集合对象存放 IOC 容器中注册解析的BeanDefinition,向 IOC 容器注册的主要源码如下:

//存储注册信息的 BeanDefinition

private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256);


//向 IOC 容器注册解析的 BeanDefiniton

@Override
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)

throws BeanDefinitionStoreException {


Assert.hasText(beanName, "Bean name must not be empty");

Assert.notNull(beanDefinition, "BeanDefinition must not be null");


//校验解析的 BeanDefiniton

if (beanDefinition instanceof AbstractBeanDefinition) { try {
((AbstractBeanDefinition) beanDefinition).validate();

}

catch (BeanDefinitionValidationException ex) {

throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName, "Validation of bean definition failed", ex);
}

}


BeanDefinition oldBeanDefinition;

oldBeanDefinition = this.beanDefinitionMap.get(beanName);


if (oldBeanDefinition != null) {

if (!isAllowBeanDefinitionOverriding()) {

throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName, "Cannot register bean definition [" + beanDefinition + "] for bean '" + beanName + "': There is already [" + oldBeanDefinition + "] bound.");

}

else if (oldBeanDefinition.getRole() < beanDefinition.getRole()) {

//e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE if (this.logger.isWarnEnabled()) {
this.logger.warn("Overriding user-defined bean definition for bean '" + beanName + "' with a framework-generated bean definition: replacing [" + oldBeanDefinition + "] with [" + beanDefinition + "]");
}

}

else if (!beanDefinition.equals(oldBeanDefinition)) {

if (this.logger.isInfoEnabled()) {

this.logger.info("Overriding bean definition for bean '" + beanName + "' with a different definition: replacing [" + oldBeanDefinition + "] with [" + beanDefinition + "]");

}

}

else {

if (this.logger.isDebugEnabled()) {

this.logger.debug("Overriding bean definition for bean '" + beanName +

"' with an equivalent definition: replacing [" + oldBeanDefinition +

"] with [" + beanDefinition + "]");

}

}

this.beanDefinitionMap.put(beanName, beanDefinition);

}

else {

if (hasBeanCreationStarted()) {

//注册的过程中需要线程同步,以保证数据的一致性

synchronized (this.beanDefinitionMap) {

this.beanDefinitionMap.put(beanName, beanDefinition);

List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1); 

updatedDefinitions.addAll(this.beanDefinitionNames); updatedDefinitions.add(beanName);

this.beanDefinitionNames = updatedDefinitions;

if (this.manualSingletonNames.contains(beanName)) {

Set<String> updatedSingletons = new LinkedHashSet<>(this.manualSingletonNames);


updatedSingletons.remove(beanName);

this.manualSingletonNames = updatedSingletons;

}

}

}

else {

this.beanDefinitionMap.put(beanName, beanDefinition);

this.beanDefinitionNames.add(beanName);

this.manualSingletonNames.remove(beanName);

}

this.frozenBeanDefinitionNames = null;

}


//检查是否有同名的 BeanDefinition 已经在 IOC 容器中注册

if (oldBeanDefinition != null || containsSingleton(beanName)) { //重置所有已经注册过的 BeanDefinition 的缓存 
resetBeanDefinition(beanName);

}

}

至此,Bean 定义资源文件中配置的 Bean 被解析过后,已经注册到 IOC 容器中,被容器管理起来,真正完成了 IOC 容器初始化所做的全部工作。
现在 IOC 容器中已经建立了整个 Bean 的配置信息,这些BeanDefinition 信息已经可以使用,并且可以被检索,IOC 容器的作用就是对这些注册的 Bean 定义信息进行处理和维护。
这些的注册的 Bean 定义信息是 IOC 容器控制反的基础,正是有了这些注册的数据,容器才可以进行依赖注入。

后记

完整版的Spring注释版源码,请见我的github:spring-framework-5.0.2.RELEASE-中文注释版

现在通过上面的代码,总结一下 IOC 容器初始化的基本步骤:

(1).初始化的入口在容器实现中的 refresh()调用来完成。

(2).对 bean 定义载入 IOC 容器使用的方法是 loadBeanDefinition,

其中的大致过程如下:

通过 ResourceLoader 来完成资源文件位置的定位,DefaultResourceLoader是默认的实现,同时上下文本身就给出了 ResourceLoader的实现,可以从类路径,文件系统,URL 等方式来定为资源位置。
如果是 XmlBeanFactory 作为 IOC 容器,那么需要为它指定 bean 定义的资源,也 就 是 说 bean 定 义 文 件 时 通 过 抽 象 成 Resource 来 被 IOC 容 器处理的,容器通过BeanDefinitionReader 来 完 成 定 义 信 息 的 解 析和Bean信息的注册 , 往往使用的是XmlBeanDefinitionReader 来 解 析bean的xml定义文件 - 实际的处理过程是委 托 给 BeanDefinitionParserDelegate 来完成的,从而得到 bean 的定义信息,这些信息在 Spring 中使用 BeanDefinition对象来表示 - 这 个 名 字 可 以 让 我 们 想 到 loadBeanDefinition,RegisterBeanDefinition 这些相关方法-他们都是为处理 BeanDefinitin 服务的,容器解析得到 BeanDefinition 以后,需要把它在 IOC 容器中注册,这由IOC实现BeanDefinitionRegistry 接口来实现。

注册过程就是在 IOC 容器内部维护的一个 HashMap 来保存得到的 BeanDefinition 的过程。这个 HashMap 是 IOC 容器持有 Bean 信息的场所,以后对 Bean 的操作都是围绕这个 HashMap 来实现的。

然后我们就可以通过 BeanFactory 和 ApplicationContext 来享受到 SpringIOC 的服务了,在使用IOC 容器的时候,我们注意到除了少量粘合代码,绝大多数以正确 IOC 风格编写的应用程序代码完全不用关心如何到达工厂,因为容器将把这些对象与容器管理的其他对象钩在一起。基本的策略是把工厂放到已知的地方,最好是放在对预期使用的上下文有意义的地方,以及代码将实际需要访问工厂的地方。 Spring 本身提供了对声明式载入 web 应用程序用法的应用程序上下文,并将其存储在 ServletContext 中的框架实现。

以下是容器初始化全过程的时序图:

在这里插入图片描述
在使用 SpringIOC 容器的时候我们还需要区别两个概念:

BeanFactory 和 FactoryBean ,其中 BeanFactory 指的是 IOC 容器的编程抽象,比如ApplicationContext,XmlBeanFactory 等,这些都是 IOC 容器的具体表现,需要使用什么样的容器由客户决定,但 Spring 为我们提供了丰富的选择。FactoryBean 只是一个可以在 IOC 而容器中被管理的一个 Bean,是对各种处理过程和资源使用的抽象,FactoryBean 在需要时产生另一个对象,而不返回FactoryBean 本身,我们可以把它看成是一个抽象工厂,对它的调用返回的是工厂生产的产品。

所有的 FactoryBean 都实现特殊的 org.springframework.beans.factory.FactoryBean 接口,当使用容器中 FactoryBean 的时候,该容器不会返回 FactoryBean 本身,而是返回其生成的对象。Spring 包括了大部分的通用资源和服务访问抽象的 FactoryBean 的实现,其中包括:对 JNDI 查询的处理,对代理对象的处理,对事务性代理的处理,对 RMI 代理的处理等,这些我们都可以看成是具体的工厂,看成是Spring 为我们建立好的工厂。

也就是说 Spring 通过使用抽象工厂模式为我们准备了一系列工厂来生产一些特定的对象,免除我们手工重复的工作,我们要使用时只需要在 IOC 容器里配置好就能很方便的使用了。

发布了47 篇原创文章 · 获赞 5 · 访问量 1866

猜你喜欢

转载自blog.csdn.net/qq_34361283/article/details/103544866