msb-public
/
source-code-hunter
mirror of https://github.com/doocs/source-code-hunter.git
4
2
Code Issues Projects Releases Wiki Activity

review一下 “将bean解析封装成BeanDefinition.md”文件，修正一些小瑕疵

Browse Source
pull/28/head
AmyliaY 5 years ago
parent a816dc360b
commit bf5bf3603e
1 changed files with 901 additions and 871 deletions
Show Stats Download Patch File Download Diff File

440
docs/Spring/IoC/2、将bean解析封装成BeanDefinition.md
Unescape View File

@ -1,30 +1,32 @@
接着上一篇的 BeanDefinition 资源定位开始讲。Spring IoC 容器 BeanDefinition 解析过程就是把用户在配置文件中定义好的 bean，解析并封装成容器可以装载的 BeanDefinition，BeanDefinition 是 spring 定义的基本数据结构，也是为了方便对 bean 进行管理和操作。
（PS：可以结合我 GitHub 上对 spring 框架源码的阅读及个人理解一起看，会更有助于各位开发大佬理解。
## 前言
接着上一篇的 BeanDefinition 资源定位开始讲。Spring IoC 容器 BeanDefinition 解析过程就是把用户在配置文件中配置的 bean，解析并封装成 IoC 容器可以装载的 BeanDefinition 对象，BeanDefinition 是 Spring 定义的基本数据结构，其中的属性与配置文件中 bean 的属性相对应。
（PS：可以结合我 GitHub 上对 Spring 框架源码的阅读及个人理解一起看，会更有助于各位开发大佬理解。地址如下。
spring-beans https://github.com/AmyliaY/spring-beans-reading
spring-context https://github.com/AmyliaY/spring-context-reading ）
spring-context https://github.com/AmyliaY/spring-context-reading
）
## 1、先看一下 AbstractRefreshableApplicationContext 中 refreshBeanFactory() 方法的 loadBeanDefinitions(beanFactory)
## 正文
首先看一下 AbstractRefreshableApplicationContext 的 refreshBeanFactory() 方法，这是一个模板方法，其中调用的 loadBeanDefinitions() 方法是一个抽象方法，交由子类实现。
```java
// 在这里完成了容器的初始化，并赋值给自己 private 的 beanFactory 属性，为下一步调用做准备
// 从父类 AbstractApplicationContext 继承的抽象方法，自己做了实现
@Override
protected final void refreshBeanFactory() throws BeansException {
/**
* 在这里完成了容器的初始化，并赋值给自己私有的 beanFactory 属性，为下一步调用做准备
* 从父类 AbstractApplicationContext 继承的抽象方法，自己做了实现
*/
@Override
protected final void refreshBeanFactory() throws BeansException {
// 如果已经建立了 IoC 容器，则销毁并关闭容器
if (hasBeanFactory()) {
destroyBeans();
closeBeanFactory();
}
try {
// 创建 IoC 容器，DefaultListableBeanFactory 类实现了 ConfigurableListableBeanFactory 接口
// 创建 IoC 容器，DefaultListableBeanFactory 实现了 ConfigurableListableBeanFactory 接口
DefaultListableBeanFactory beanFactory = createBeanFactory();
beanFactory.setSerializationId(getId());
// 对 IoC 容器进行定制化，如设置启动参数，开启注解的自动装配等
customizeBeanFactory(beanFactory);
// 载入 BeanDefinition，当前类中只定义了抽象的 loadBeanDefinitions 方法，具体的实现调用子类容器
// 载入 BeanDefinition，当前类中只定义了抽象的 loadBeanDefinitions() 方法，具体的实现调用子类容器
loadBeanDefinitions(beanFactory);
synchronized (this.beanFactoryMonitor) {
// 给自己的属性赋值
@ -34,82 +36,88 @@ spring-context https://github.com/AmyliaY/spring-context-reading
catch (IOException ex) {
throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
}
}
}
```
## 2、实现类 AbstractXmlApplicationContext 中的 loadBeanDefinitions(DefaultListableBeanFactory beanFactory)
下面看一下 AbstractRefreshableApplicationContext 的子类 AbstractXmlApplicationContext 对 loadBeanDefinitions() 方法的实现。
```java
/*
* 实现了爷类 AbstractRefreshableApplicationContext 的抽象方法
*/
@Override
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException {
// DefaultListableBeanFactory 实现了 BeanDefinitionRegistry 接口，在初始化 XmlBeanDefinitionReader 时
// 将 BeanDefinition 注册器注入该 BeanDefinition 读取器
// 创建 用于从 Xml 中读取 BeanDefinition 的读取器，并通过回调设置到 IoC 容器中去，容器使用该读取器读取 BeanDefinition 资源
@Override
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException {
// DefaultListableBeanFactory 实现了 BeanDefinitionRegistry 接口，所以在初始化 XmlBeanDefinitionReader 时
// 将该 beanFactory 传入 XmlBeanDefinitionReader 的构造方法中。
// 从名字也能看出来它的功能，这是一个用于从 .xml文件 中读取 BeanDefinition 的读取器
XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
beanDefinitionReader.setEnvironment(this.getEnvironment());
// 为 beanDefinition 读取器设置 资源加载器，由于本类的太爷爷类 AbstractApplicationContext
// 为 beanDefinition 读取器设置 资源加载器，由于本类的基类 AbstractApplicationContext
// 继承了 DefaultResourceLoader，因此，本容器自身也是一个资源加载器
beanDefinitionReader.setResourceLoader(this);
// 设置 SAX 解析器，SAX（simple API for XML）是另一种 XML 解析方法。相比于 DOM，SAX 速度更快，占用内存更小。
// 它逐行扫描文档，一边扫描一边解析。相比于先将整个 XML 文件扫描近内存，再进行解析的 DOM，SAX 可以在解析文档的任意时刻停止解析，但操作也比 DOM 复杂。
// 为 beanDefinitionReader 设置用于解析的 SAX 实例解析器，SAX（simple API for XML）是另一种XML解析方法。
// 相比于DOM，SAX速度更快，占用内存更小。它逐行扫描文档，一边扫描一边解析。相比于先将整个XML文件扫描进内存，
// 再进行解析的DOM，SAX可以在解析文档的任意时刻停止解析，但操作也比DOM复杂。
beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));
// 初始化 beanDefinition 读取器，该方法同时启用了 Xml 的校验机制
// 初始化 beanDefinition 读取器，该方法同时启用了 XML 的校验机制
initBeanDefinitionReader(beanDefinitionReader);
// Bean 读取器真正实现加载的方法
// 用传进来的 XmlBeanDefinitionReader 读取器读取 .xml 文件中配置的 bean
loadBeanDefinitions(beanDefinitionReader);
}
}
```
## 3、loadBeanDefinitions(XmlBeanDefinitionReader reader)
接着看一下上面最后一个调用的方法 loadBeanDefinitions(XmlBeanDefinitionReader reader)。
```java
// 用传进来的 XmlBeanDefinitionReader 读取器加载 Xml 文件中的 BeanDefinition
protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException {
/**
* 读取并解析 .xml 文件中配置的 bean，然后封装成 BeanDefinition 对象
*/
protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException {
/**
* ClassPathXmlApplicationContext 与 FileSystemXmlApplicationContext
* 在这里的调用出现分歧，各自按不同的方式加载解析 Resource 资源
* 最后在具体的解析和 BeanDefinition 定位上又会殊途同归
*/
// 获取存放了 BeanDefinition 的所有 Resource，
// FileSystemXmlApplicationContext 类未对 getConfigResources() 进行重新，
// 所以调用父类的，return null。
// 获取存放了 BeanDefinition 的所有 Resource，FileSystemXmlApplicationContext 中未对
// getConfigResources() 进行重写，所以调用父类的，return null。
// 而 ClassPathXmlApplicationContext 对该方法进行了重写，返回设置的值
Resource[] configResources = getConfigResources();
if (configResources != null) {
// Xml Bean 读取器调用其父类 AbstractBeanDefinitionReader 读取定位的 Bean 定义资源
// 这里调用的是其父类 AbstractBeanDefinitionReader 中的方法，解析加载 BeanDefinition对象
reader.loadBeanDefinitions(configResources);
}
// 调用父类 AbstractRefreshableConfigApplicationContext 实现的返回值为 String[] 的 getConfigLocations() 方法，
// 优先返回 FileSystemXmlApplicationContext 构造方法中调用 setConfigLocations() 方法设置的资源
// 调用其父类 AbstractRefreshableConfigApplicationContext 中的实现，优先返回
// FileSystemXmlApplicationContext 构造方法中调用 setConfigLocations() 方法设置的资源路径
String[] configLocations = getConfigLocations();
if (configLocations != null) {
// XmlBeanDefinitionReader 读取器调用其父类 AbstractBeanDefinitionReader 的方法从配置位置加载 BeanDefinition
// 这里调用其父类 AbstractBeanDefinitionReader 的方法从配置位置加载 BeanDefinition
reader.loadBeanDefinitions(configLocations);
}
}
}
```
## 4、AbstractBeanDefinitionReader 对 loadBeanDefinitions() 方法的三重重载
AbstractBeanDefinitionReader 对 loadBeanDefinitions() 方法的三重重载。
```java
// loadBeanDefinitions() 方法的重载方法之一，调用了另一个重载方法 loadBeanDefinitions(String)
public int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException {
/**
* loadBeanDefinitions() 方法的重载方法之一，调用了另一个重载方法 loadBeanDefinitions(String location)
*/
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(String, Set<Resource>) 方法
public int loadBeanDefinitions(String location) throws BeanDefinitionStoreException {
/**
* 重载方法之一，调用了下面的 loadBeanDefinitions(String location, Set<Resource> actualResources) 方法
*/
public int loadBeanDefinitions(String location) throws BeanDefinitionStoreException {
return loadBeanDefinitions(location, null);
}
}
// 获取在 IoC 容器初始化过程中设置的资源加载器
public int loadBeanDefinitions(String location, Set<Resource> actualResources) throws BeanDefinitionStoreException {
// 在实例化 XmlBeanDefinitionReader 后 IoC 容器将自己注入进该读取器作为 resourceLoader 属性
/**
* 获取在 IoC 容器初始化过程中设置的资源加载器
*/
public int loadBeanDefinitions(String location, Set<Resource> actualResources) throws BeanDefinitionStoreException {
// 在实例化 XmlBeanDefinitionReader 时 曾将 IoC 容器注入该对象，作为 resourceLoader 属性
ResourceLoader resourceLoader = getResourceLoader();
if (resourceLoader == null) {
throw new BeanDefinitionStoreException(
@ -118,10 +126,10 @@ spring-context https://github.com/AmyliaY/spring-context-reading
if (resourceLoader instanceof ResourcePatternResolver) {
try {
// 将指定位置的 BeanDefinition 资源文件解析为 IoC 容器封装的资源
// 加载多个指定位置的 BeanDefinition 资源文件
// 将指定位置的 bean 配置文件解析为 BeanDefinition 对象
// 加载多个指定位置的 BeanDefinition 资源
Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location);
// 委派调用其子类 XmlBeanDefinitionReader 的方法，实现加载功能
// 调用其子类 XmlBeanDefinitionReader 的方法，实现加载功能
int loadCount = loadBeanDefinitions(resources);
if (actualResources != null) {
for (Resource resource : resources) {
@ -142,7 +150,7 @@ spring-context https://github.com/AmyliaY/spring-context-reading
/**
* ！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！
* AbstractApplicationContext 继承了 DefaultResourceLoader，所以 AbstractApplicationContext
* 及其子类都会调用 DefaultResourceLoader 中的实现，将指定位置的资源文件解析为 Resource，
* 及其子类都可以调用 DefaultResourceLoader 中的方法，将指定位置的资源文件解析为 Resource，
* 至此完成了对 BeanDefinition 的资源定位
* ！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！
*/
@ -160,19 +168,23 @@ spring-context https://github.com/AmyliaY/spring-context-reading
}
return loadCount;
}
}
}
```
## 5、XmlBeanDefinitionReader 读取器中的方法执行流，按代码的先后顺序
XmlBeanDefinitionReader 读取器中的方法执行流，按代码的先后顺序。
```java
// XmlBeanDefinitionReader 加载资源的入口方法
public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {
// 调用本类的重载方法，通过 new EncodedResource(resource) 获得的
// EncodedResource 对象能够将资源与读取资源所需的编码组合在一起
/**
* XmlBeanDefinitionReader 加载资源的入口方法
*/
public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {
// 调用本类的重载方法，通过 new EncodedResource(resource) 获得的 EncodedResource 对象
// 能够将资源与读取资源所需的编码组合在一起
return loadBeanDefinitions(new EncodedResource(resource));
}
}
// 通过 encodedResource 进行资源解析，encodedResource 对象持有 resource 对象和 encoding 编码格式
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
/**
* 通过 encodedResource 进行资源解析，encodedResource 对象持有 resource 对象和 encoding 编码格式
*/
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());
@ -201,7 +213,7 @@ spring-context https://github.com/AmyliaY/spring-context-reading
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}
finally {
// 关闭从 Resource 中得到的 IO 流
// 关闭 IO 流
inputStream.close();
}
}
@ -215,10 +227,12 @@ spring-context https://github.com/AmyliaY/spring-context-reading
this.resourcesCurrentlyBeingLoaded.remove();
}
}
}
}
// 从指定 XML 文件中实际载入 BeanDefinition 资源的方法
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
/**
* 从指定 XML 文件中解析 bean，封装成 BeanDefinition 对象的具体实现
*/
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
int validationMode = getValidationModeForResource(resource);
@ -251,26 +265,28 @@ spring-context https://github.com/AmyliaY/spring-context-reading
throw new BeanDefinitionStoreException(resource.getDescription(),
"Unexpected exception parsing XML document from " + resource, ex);
}
}
}
// 按照 Spring 的 Bean 语义要求将 BeanDefinition 资源解析并转换为容器内部数据结构
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
// 得到 BeanDefinitionDocumentReader 来对 xml 格式的 BeanDefinition 解析
/**
* 按照 Spring 对配置文件中 bean 元素的语义定义，将 bean 元素 解析成 BeanDefinition 对象
*/
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
// 得到 BeanDefinitionDocumentReader，将 xml 中配置的 bean 解析成 BeanDefinition 对象
// BeanDefinitionDocumentReader 只是个接口，这里实际上是一个 DefaultBeanDefinitionDocumentReader 对象
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
documentReader.setEnvironment(this.getEnvironment());
// 获得容器中注册的 Bean 数量
// 获得容器中注册的 bean 数量
int countBefore = getRegistry().getBeanDefinitionCount();
// 解析过程入口，这里使用了委派模式，BeanDefinitionDocumentReader 只是个接口，
// 具体的解析实现过程由实现类 DefaultBeanDefinitionDocumentReader 完成
// 解析过程入口
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
// 统计解析的 Bean 数量
return getRegistry().getBeanDefinitionCount() - countBefore;
}
}
```
## 6、文档解析器 DefaultBeanDefinitionDocumentReader 对配置文件中元素的解析
文档解析器 DefaultBeanDefinitionDocumentReader 对配置文件中元素的解析。
```java
// 根据 Spring 对 Bean 的定义规则进行解析
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
// 根据 Spring 对 Bean 的定义规则进行解析
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
// 获得 XML 描述符
this.readerContext = readerContext;
logger.debug("Loading bean definitions");
@ -278,14 +294,13 @@ spring-context https://github.com/AmyliaY/spring-context-reading
Element root = doc.getDocumentElement();
// 解析的具体实现
doRegisterBeanDefinitions(root);
}
}
/**
* Register each bean definition within the given root {@code <beans/>} element.
/**
* 依次注册 BeanDefinition，使用给定的根元素
*/
protected void doRegisterBeanDefinitions(Element root) {
protected void doRegisterBeanDefinitions(Element root) {
String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
if (StringUtils.hasText(profileSpec)) {
Assert.state(this.environment != null, "Environment must be set for evaluating profiles");
@ -297,26 +312,28 @@ spring-context https://github.com/AmyliaY/spring-context-reading
}
// 具体的解析过程由 BeanDefinitionParserDelegate 实现，
// BeanDefinitionParserDelegate 中定义了 Spring Bean 定义 XML 文件的各种元素
// BeanDefinitionParserDelegate中定义了用于解析 bean 的各种属性及方法
BeanDefinitionParserDelegate parent = this.delegate;
this.delegate = createDelegate(this.readerContext, root, parent);
// 在解析 BeanDefinition 之前，进行自定义的解析，增强解析过程的可扩展性
// 前置解析处理，可以在解析 bean 之前进行自定义的解析，增强解析的可扩展性
preProcessXml(root);
// 从 Document 的根元素开始进行 Bean 定义的 Document 对象
parseBeanDefinitions(root, this.delegate);
// 在解析 Bean 定义之后，进行自定义的解析，增加解析过程的可扩展性
// 后置解析处理，可以在解析 bean 之后进行自定义的解析，增加解析的可扩展性
postProcessXml(root);
this.delegate = parent;
}
}
// 使用 Spring 的 Bean 规则从 Document 的根元素开始进行 Bean Definition 的解析
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
// Bean 定义的 Document 对象是否使用了 Spring 默认的 XML 命名空间
/**
* 根据 Spring 的 bean解析规则，从 Document 的根元素开始进行解析
*/
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
// 根节点 root 是否使用了 Spring 默认的 XML 命名空间
if (delegate.isDefaultNamespace(root)) {
// 获取 root 根元素的所有子节点
// 获取根元素的所有子节点
NodeList nl = root.getChildNodes();
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
@ -324,48 +341,50 @@ spring-context https://github.com/AmyliaY/spring-context-reading
Element ele = (Element) node;
// 如果 ele 定义的 Document 的元素节点使用的是 Spring 默认的 XML 命名空间
if (delegate.isDefaultNamespace(ele)) {
// 使用 Spring 的 Bean 规则解析元素节点
// 使用 Spring 的 bean解析规则 解析元素节点
parseDefaultElement(ele, delegate);
}
else {
// 没有使用 Spring 默认的 XML 命名空间，则使用用户自定义的解
// 析规则解析元素节点
// 若没有使用 Spring 默认的 XML 命名空间，则使用用户自定义的解析规则解析元素节点
delegate.parseCustomElement(ele);
}
}
}
}
else {
// Document 的根节点没有使用 Spring 默认的命名空间，则使用用户自定义的
// 解析规则解析 Document 根节点
// 若 Document 的根节点没有使用 Spring 默认的命名空间，则使用用户自定义的解析规则
// 解析 Document 根节点
delegate.parseCustomElement(root);
}
}
}
// 使用 Spring 的 Bean 规则解析 Document 元素节点
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
// 如果元素节点是 <Import> 导入元素，进行导入解析
/**
* 使用 Spring 的 bean解析规则 解析 Spring元素节点
*/
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
// 解析 <Import> 元素
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
// 如果元素节点是 <Alias> 别名元素，进行别名解析
// 解析 <Alias> 元素
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
}
// 元素节点既不是导入元素，也不是别名元素，即普通的 <Bean> 元素，
// 按照 Spring 的 Bean 规则解析元素
// 若元素节点既不是 <Import> 也不是 <Alias>，即普通的 <Bean> 元素，
// 则按照 Spring 的 bean解析规则 解析元素
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
}
// 如果被解析的元素是 beans，则递归调用 doRegisterBeanDefinitions(Element root) 方法
// 如果被解析的元素是 beans，则递归调用 doRegisterBeanDefinitions(Element root) 方法进行解析
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
doRegisterBeanDefinitions(ele);
}
}
}
// 解析 <Import> 导入元素，从给定的导入路径加载 Bean 定义资源到 Spring IoC 容器中
protected void importBeanDefinitionResource(Element ele) {
/**
* 解析 <import> 元素
*/
protected void importBeanDefinitionResource(Element ele) {
// 获取给定的导入元素的 location 属性
String location = ele.getAttribute(RESOURCE_ATTRIBUTE);
// 如果导入元素的 location 属性值为空，则没有导入任何资源，直接返回
@ -379,19 +398,17 @@ spring-context https://github.com/AmyliaY/spring-context-reading
Set<Resource> actualResources = new LinkedHashSet<Resource>(4);
// 标识给定的导入元素的 location 是否是绝对路径
// 标识给定的 <Import> 元素的 location 是否是绝对路径
boolean absoluteLocation = false;
try {
absoluteLocation = ResourcePatternUtils.isUrl(location) || ResourceUtils.toURI(location).isAbsolute();
}
catch (URISyntaxException ex) {
// 给定的导入元素的 location 不是绝对路径
}
// 给定的导入元素的 location 是绝对路径
if (absoluteLocation) {
try {
// 使用资源读入器加载给定路径的 Bean 定义资源
// 使用资源读取器加载给定路径的 bean
int importCount = getReaderContext().getReader().loadBeanDefinitions(location, actualResources);
if (logger.isDebugEnabled()) {
logger.debug("Imported " + importCount + " bean definitions from URL location [" + location + "]");
@ -403,22 +420,22 @@ spring-context https://github.com/AmyliaY/spring-context-reading
}
}
else {
// 给定的导入元素的 location 是相对路径
// 给定的 <import> 元素的 location 是相对路径
try {
int importCount;
// 将给定导入元素的 location 封装为相对路径资源
// 将给定 <import> 元素的 location 封装为相对路径资源
Resource relativeResource = getReaderContext().getResource().createRelative(location);
// 封装的相对路径资源存在
if (relativeResource.exists()) {
// 使用资源读入器加载 Bean 定义资源
// 使用资源读取器加载 bean
importCount = getReaderContext().getReader().loadBeanDefinitions(relativeResource);
actualResources.add(relativeResource);
}
// 封装的相对路径资源不存在
else {
// 获取 Spring IOC 容器资源读入器的基本路径
// 获取 Spring IOC 容器资源读取器的基本路径
String baseLocation = getReaderContext().getResource().getURL().toString();
// 根据 Spring IoC 容器资源读入器的基本路径加载给定导入路径的资源
// 根据 Spring IoC 容器资源读取器的基本路径加载给定导入路径的资源
importCount = getReaderContext().getReader().loadBeanDefinitions(
StringUtils.applyRelativePath(baseLocation, location), actualResources);
}
@ -437,48 +454,47 @@ spring-context https://github.com/AmyliaY/spring-context-reading
Resource[] actResArray = actualResources.toArray(new Resource[actualResources.size()]);
// 在解析完 <Import> 元素之后，发送容器导入其他资源处理完成事件
getReaderContext().fireImportProcessed(location, actResArray, extractSource(ele));
}
}
/**
* Process the given alias element, registering the alias with the registry.
/**
* 解析 <Alias> 元素
*/
// 解析 <Alias> 别名元素，为 Bean 向 Spring IoC 容器注册别名
protected void processAliasRegistration(Element ele) {
// 获取 <Alias> 别名元素中 name 的属性值
protected void processAliasRegistration(Element ele) {
// 获取 <Alias> 元素中的 name 属性值
String name = ele.getAttribute(NAME_ATTRIBUTE);
// 获取 <Alias> 别名元素中 alias 的属性值
// 获取 <Alias> 元素中的 alias 属性值
String alias = ele.getAttribute(ALIAS_ATTRIBUTE);
boolean valid = true;
// <alias> 别名元素的 name 属性值为空
// 若 <alias> 元素的 name 属性值为空
if (!StringUtils.hasText(name)) {
getReaderContext().error("Name must not be empty", ele);
valid = false;
}
// <alias> 别名元素的 alias 属性值为空
// 若 <alias> 元素的 alias 属性值为空
if (!StringUtils.hasText(alias)) {
getReaderContext().error("Alias must not be empty", ele);
valid = false;
}
if (valid) {
try {
// 向容器的资源读入器注册别名
// 向容器的资源读取器 注册别名
getReaderContext().getRegistry().registerAlias(name, alias);
}
catch (Exception ex) {
getReaderContext().error("Failed to register alias '" + alias +
"' for bean with name '" + name + "'", ele, ex);
}
// 在解析完 <Alias> 元素之后，发送容器别名处理完成事件
// 在解析完 <Alias> 元素之后，向容器发送别名处理完成事件
getReaderContext().fireAliasRegistered(name, alias, extractSource(ele));
}
}
}
// 解析 Bean 定义资源 Document 对象的普通元素
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
/**
* 解析 bean 元素
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
// BeanDefinitionHolder 是对 BeanDefinition 的封装，即 BeanDefinition 的封装类
// 对 Document 对象中 <Bean> 元素的解析由 BeanDefinitionParserDelegate 实现
// BeanDefinitionHolder 是对 BeanDefinition 的进一步封装，持有一个 BeanDefinition 对象 及其对应
// 的 beanName、aliases别名。对 <Bean> 元素的解析由 BeanDefinitionParserDelegate 实现
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
// 对 bdHolder 进行包装处理
@ -486,7 +502,7 @@ spring-context https://github.com/AmyliaY/spring-context-reading
try {
/**
* ！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！
* 向 Spring IoC 容器注册解析 BeanDefinition，这是 BeanDefinition 向 IoC 容器注册的入口
* 向 Spring IoC 容器注册解析完成的 BeanDefinition对象，这是 BeanDefinition 向 IoC 容器注册的入口
* ！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！！
*/
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
@ -495,37 +511,41 @@ spring-context https://github.com/AmyliaY/spring-context-reading
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
// 在完成向 Spring IOC 容器注册解析得到的 Bean 定义之后，发送注册事件
// 在完成向 Spring IOC 容器注册 BeanDefinition对象 之后，发送注册事件
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
}
```
## 7、看一下 BeanDefinitionParserDelegate 中对 bean 元素的详细解析过程
看一下 BeanDefinitionParserDelegate 中对 bean 元素的详细解析过程。
```java
// 解析 <Bean> 元素的入口
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
/**
* 解析 <bean> 元素的入口
*/
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
return parseBeanDefinitionElement(ele, null);
}
}
// 解析 BeanDefinition 资源文件中的 <Bean> 元素，这个方法中主要处理 <Bean> 元素的 id，name 和别名属性
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {
// 获取 <Bean> 元素中的 id 属性值
/**
* 解析 <bean> 元素，这个方法中主要处理 <bean> 元素的 id、name 和 alias 属性
*/
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {
// 获取 <bean> 元素中的 id 属性值
String id = ele.getAttribute(ID_ATTRIBUTE);
// 获取 <Bean> 元素中的 name 属性值
// 获取 <bean> 元素中的 name 属性值
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
// 获取 <Bean> 元素中的 alias 属性值
// 获取 <bean> 元素中的 alias 属性值
List<String> aliases = new ArrayList<String>();
// 将 <Bean> 元素中的所有 name 属性值存放到别名中
// 将 <bean> 元素中的所有 name 属性值存放到别名中
if (StringUtils.hasLength(nameAttr)) {
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
aliases.addAll(Arrays.asList(nameArr));
}
String beanName = id;
// 如果 <Bean> 元素中没有配置 id 属性时，将别名中的第一个值赋值给 beanName
// 如果 <bean> 元素中没有配置 id 属性，则将 别名alias 中的第一个值赋值给 beanName
if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
beanName = aliases.remove(0);
if (logger.isDebugEnabled()) {
@ -534,30 +554,27 @@ spring-context https://github.com/AmyliaY/spring-context-reading
}
}
// 检查 <Bean> 元素所配置的 id 或者 name 的唯一性，containingBean 标识 <Bean>
// 元素中是否包含子 <Bean> 元素
// 检查 <bean> 元素所配置的 id 或者 name 的唯一性
// 元素中是否包含子 <bean> 元素
if (containingBean == null) {
// 检查 <Bean> 元素所配置的 id、name 或者别名是否重复
// 检查 <bean> 元素所配置的 id、name 或者 别名alias 是否重复
checkNameUniqueness(beanName, aliases, ele);
}
// 详细对 <Bean> 元素中配置的 Bean 定义进行解析的地方
// 将 <bean> 元素解析成 BeanDefinition对象
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
if (beanDefinition != null) {
if (!StringUtils.hasText(beanName)) {
try {
// 如果 <bean> 元素中没有配置 id、name 或者 alias，且没有包含子元素
if (containingBean != null) {
// 如果 <Bean> 元素中没有配置 id、别名或者 name，且没有包含子元素
// <Bean> 元素，为解析的 Bean 生成一个唯一 beanName 并注册
// 为解析的 BeanDefinition 生成一个唯一的 beanName
beanName = BeanDefinitionReaderUtils.generateBeanName(
beanDefinition, this.readerContext.getRegistry(), true);
}
else {
// 如果 <Bean> 元素中没有配置 id、别名或者 name，且包含了子元素
// <Bean> 元素，为解析的 Bean 使用别名向 IOC 容器注册
beanName = this.readerContext.generateBeanName(beanDefinition);
// 为解析的 Bean 使用别名注册时，为了向后兼容
// Spring1.2/2.0，给别名添加类名后缀
// 在别名集合 aliases 中添加 bean 的类名
String beanClassName = beanDefinition.getBeanClassName();
if (beanClassName != null &&
beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&
@ -580,18 +597,19 @@ spring-context https://github.com/AmyliaY/spring-context-reading
}
// 当解析出错时，返回 null
return null;
}
}
// 详细对 <Bean> 元素中配置的 Bean 定义其他属性进行解析，由于上面的方法中已经对
// Bean 的 id、name 和别名等属性进行了处理，该方法中主要处理除这三个以外的其他属性数据
public AbstractBeanDefinition parseBeanDefinitionElement(
/**
* 详细对 <bean> 元素中的其他属性进行解析，上面的方法中已经对 bean 的 id、name 及 alias 属性进行了处理
*/
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, BeanDefinition containingBean) {
// 记录解析的 <Bean>
// 记录解析的 <bean>
this.parseState.push(new BeanEntry(beanName));
// 这里只读取 <Bean> 元素中配置的 class 名字，然后载入到 BeanDefinition 中去
// 只是记录配置的 class 名字，不做实例化，对象的实例化在依赖注入时完成
// 这里只读取 <bean> 元素中配置的 class 名字，然后载入到 BeanDefinition 中去
// 只是记录配置的 class 名字，不做实例化，对象的实例化在 getBean() 时发生
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
@ -599,35 +617,34 @@ spring-context https://github.com/AmyliaY/spring-context-reading
try {
String parent = null;
// 如果 <Bean> 元素中配置了 parent 属性，则获取 parent 属性的值
// 如果 <bean> 元素中配置了 parent 属性，则获取 parent 属性的值
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
// 根据 <Bean> 元素配置的 class 名称和 parent 属性值创建 BeanDefinition
// 为载入 Bean 定义信息做准备
// 根据 <bean> 元素配置的 class 名称和 parent 属性值创建 BeanDefinition
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
// 对当前的 <Bean> 元素中配置的一些属性进行解析和设置，如配置的单态 (singleton) 属性等
// 对当前的 <bean> 元素中配置的一些属性进行解析和设置，如配置的单例 (singleton) 属性等
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
// 为 <Bean> 元素解析的 Bean 设置 description 信息
// 为 BeanDefinition对象 注入 description属性值
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
// 对 <Bean> 元素的 meta(元信息) 属性解析
// 解析 <bean> 元素中的 meta 属性
parseMetaElements(ele, bd);
// 对 <Bean> 元素的 lookup-method 属性解析
// 解析 <bean> 元素中的 lookup-method 属性
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
// 对 <Bean> 元素的 replaced-method 属性解析
// 解析 <bean> 元素中的 replaced-method 属性
parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
// 解析 <Bean> 元素的构造方法属性
// 解析 <bean> 元素的构造方法
parseConstructorArgElements(ele, bd);
// 解析 <Bean> 元素所有的 <property> 属性
// 解析 <bean> 元素中的所有 <property> 元素
parsePropertyElements(ele, bd);
// 解析 <Bean> 元素的 qualifier 属性
// 解析 <bean> 元素的 qualifier 属性
parseQualifierElements(ele, bd);
//为当前解析的 Bean 设置所需的资源和依赖对象
// 为当前BeanDefinition对象 设置所需的资源和依赖对象
bd.setResource(this.readerContext.getResource());
bd.setSource(extractSource(ele));
@ -645,15 +662,17 @@ spring-context https://github.com/AmyliaY/spring-context-reading
finally {
this.parseState.pop();
}
// 解析 <Bean> 元素出错时，返回 null
// 解析 <bean> 元素出错时，返回 null
return null;
}
}
```
## 8、对 bean 的部分子元素进行解析的具体实现
对 bean 的部分子元素进行解析的具体实现。
```java
// 解析 <Bean> 元素中所有的 <property> 子元素
public void parsePropertyElements(Element beanEle, BeanDefinition bd) {
// 获取对应 bean 元素中所有的 <property> 子元素，逐一解析
/**
* 解析 <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);
@ -662,10 +681,12 @@ spring-context https://github.com/AmyliaY/spring-context-reading
parsePropertyElement((Element) node, bd);
}
}
}
}
// 详细解析 <property> 元素
public void parsePropertyElement(Element ele, BeanDefinition bd) {
/**
* 详细解析 <property> 元素
*/
public void parsePropertyElement(Element ele, BeanDefinition bd) {
// 获取 <property> 元素的名字
String propertyName = ele.getAttribute(NAME_ATTRIBUTE);
if (!StringUtils.hasLength(propertyName)) {
@ -680,23 +701,26 @@ spring-context https://github.com/AmyliaY/spring-context-reading
error("Multiple 'property' definitions for property '" + propertyName + "'", ele);
return;
}
// 解析获取 property 的值，返回的对象对应 对 bean 定义的 property 属性设置的
// 解析结果，这个解析结果会封装到 PropertyValue 对象中，然后设置到 BeanDefinitionHolder 中去
// 解析获取 propertyName 对应的 value值，propertyName 及其 value值会被封装到
// PropertyValue 对象中，然后 set 到 BeanDefinition对象中去
Object val = parsePropertyValue(ele, bd, propertyName);
// 根据 property 的名字和值创建 property 实例
// 根据 property 的 名字propertyName 和 值val 创建 PropertyValue实例
PropertyValue pv = new PropertyValue(propertyName, val);
// 解析 <property> 元素中的属性
// 解析 <meta> 元素
parseMetaElements(ele, pv);
pv.setSource(extractSource(ele));
// 为当前的 BeanDefinition对象设置 propertyValues 属性值
bd.getPropertyValues().addPropertyValue(pv);
}
finally {
this.parseState.pop();
}
}
}
// 解析获取 property 值
public Object parsePropertyValue(Element ele, BeanDefinition bd, String propertyName) {
/**
* 解析获取 <property> 元素的属性值 value
*/
public Object parsePropertyValue(Element ele, BeanDefinition bd, String propertyName) {
String elementName = (propertyName != null) ?
"<property> element for property '" + propertyName + "'" :
"<constructor-arg> element";
@ -760,14 +784,16 @@ spring-context https://github.com/AmyliaY/spring-context-reading
error(elementName + " must specify a ref or value", ele);
return null;
}
}
}
// 解析 <property> 元素中 ref,value 或者集合等子元素
public Object parsePropertySubElement(Element ele, BeanDefinition bd) {
/**
* 解析 <property> 元素中 ref,value 或者集合等子元素
*/
public Object parsePropertySubElement(Element ele, BeanDefinition bd) {
return parsePropertySubElement(ele, bd, null);
}
}
public Object parsePropertySubElement(Element ele, BeanDefinition bd, String defaultValueType) {
public Object parsePropertySubElement(Element ele, BeanDefinition bd, String defaultValueType) {
// 如果 <property> 没有使用 Spring 默认的命名空间，则使用用户自定义的规则解析
// 内嵌元素
if (!isDefaultNamespace(ele)) {
@ -853,10 +879,12 @@ spring-context https://github.com/AmyliaY/spring-context-reading
error("Unknown property sub-element: [" + ele.getNodeName() + "]", ele);
return null;
}
}
}
// 解析 <list> 集合子元素
public List parseListElement(Element collectionEle, BeanDefinition bd) {
/**
* 解析 <list> 集合子元素
*/
public List parseListElement(Element collectionEle, BeanDefinition bd) {
// 获取 <list> 元素中的 value-type 属性，即获取集合元素的数据类型
String defaultElementType = collectionEle.getAttribute(VALUE_TYPE_ATTRIBUTE);
// 获取 <list> 集合元素中的所有子节点
@ -870,10 +898,12 @@ spring-context https://github.com/AmyliaY/spring-context-reading
// 具体的 <list> 元素解析
parseCollectionElements(nl, target, bd, defaultElementType);
return target;
}
}
// 具体解析 <list> 集合元素，<array>、<list> 和 <set> 都使用该方法解析
protected void parseCollectionElements(NodeList elementNodes, Collection<Object> target,
/**
* 具体解析 <list> 集合元素，<array>、<list> 和 <set> 都使用该方法解析
*/
protected void parseCollectionElements(NodeList elementNodes, Collection<Object> target,
BeanDefinition bd, String defaultElementType) {
// 遍历集合所有节点
@ -885,6 +915,6 @@ spring-context https://github.com/AmyliaY/spring-context-reading
target.add(parsePropertySubElement((Element) node, bd, defaultElementType));
}
}
}
}
```
经过这样逐层地解析，我们在配置文件中定义的 Bean 就被整个解析成了可以被 IoC 容器装载和使用的 BeanDefinition，这种数据结构可以让 IoC 容器执行索引、查询等操作。经过上述解析得到的 BeanDefinition，接下来我们就可以将它注册到 IoC 容器中咯。
经过这样逐层地解析，我们在配置文件中定义的 bean 就被整个解析成了 IoC 容器能够装载和使用的 BeanDefinition对象，这种数据结构可以让 IoC 容器执行索引、查询等操作。经过上述解析，接下来我们就可以将得到的 BeanDefinition对象 注册到 IoC 容器中咯。

Write Preview
Loading…
Cancel
Save