Spring源码笔记之SpringIOC--(1)从XML文件到Bean的描述对象BeanDefinition

本文主要是介绍Spring源码笔记之SpringIOC--(1)从XML文件到Bean的描述对象BeanDefinition,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

从XML文件到Bean的描述对象BeanDefinition

最开始学习spring的入门实践是,编写一个xml文件,然后利用spring读取xml文件中配置的bean。
编写一个xml配置文件default.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"><bean name="myBean" class="org.numb.springframework.ioc.bean.MyBean"/>
</beans>

编写代码加载这个bean,并获取bean的实例

public void test() {BeanFactory beanFactory = new XmlBeanFactory(new ClassPathResource("default.xml"));MyBean myBean = (MyBean) beanFactory.getBean("myBean");
}

至此就实现了springIOC加载一个bean的功能。其实在Spring代码中提供了现有的测试用例,可以从测试用例入手了解源码。注意XmlBeanFactory自spring 3.x后逐步废弃,使用XmlBeanDefinitionReader替代。查看其测试类XmlBeanDefinitionReaderTests

withClassPathResource()测试方法

class XmlBeanDefinitionReaderTests {private final SimpleBeanDefinitionRegistry registry = new SimpleBeanDefinitionRegistry();private final XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(registry);@Testvoid withClassPathResource() {// 读取test.xml的资源文件Resource resource = new ClassPathResource("test.xml", getClass());// 加载资源reader.loadBeanDefinitions(resource);// 断言检查assertThat(registry.getBeanDefinition("rod").getBeanClassName()).isEqualTo(TestBean.class.getName());}
}

上述测试用例中,spring使用ClassPathResource读取bean定义test.xml文件,然后使用XmlBeanDefinitionReader加载资源,加载过程中会解析test.xml,单步调试一下loadBeanDefinitions方法的调用过程

public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {// 为了适配字符集与编码,统一交由EncodedResource来读取资源return loadBeanDefinitions(new EncodedResource(resource));
}

首先将Resource->EncodedResource来加载,EncodedResource内部主要适配了编码和字符集,这步不用太关心。后面使用EncodedResource加载,这里借助NamedThreadLocal获取当前待加载的资源currentResources,然后判断资源是否能add到currentResources的set中,如果能add说明Resource未被加载,等加载完成后再remove,避免重复加载相同的Resource。

获取待加载的资源currentResources
加入待加载资源集
注册beans
加载完成移出待加载资源集
XmlBeanDefinitionReader
loadBeanDefinitions()
resourcesCurrentlyBeingLoaded.get()
currentResources.add()
doLoadBeanDefinitions()
currentResources.remove()

重点在于doLoadBeanDefinitions()方法

解析资源对象
注册BeanDefinition
创建BeanDefinitionDocumentReader
创建XmlReaderContext
传入Document
传入XmlReaderContext
doLoadBeanDefinitions()
doLoadDocument()
registerBeanDefinitions()
createBeanDefinitionDocumentReader()
createReaderContext()
Document
BeanDefinitionDocumentReader
XmlReaderContext
registerBeanDefinitions()

BeanDefinitionDocumentReader接口根据document读取Bean的定义,并注册进XmlReaderContext中,XmlReaderContext内包含了xml加载的ResourceXmlBeanDefinitionReader等必要对象的封装。具体bean的加载实现在DefaultBeanDefinitionDocumentReader中的doRegisterBeanDefinitions()。此处doRegisterBeanDefinitions()会被递归调用,BeanDefinitionParserDelegate是类内的对象,所以为了保证递归调用时类内能够使用正确的Delegate,此处createDelegate()会模拟堆栈调用过程,将parent delegate传入生成当前的delegate。

根据BeanDefinitionParserDelegate parent
创建当前的Delegate
判断是否是默认xml命名空间
跳过不接受的profile定义的bean
预处理
解析bean定义,注册入XmlReaderContext中
后处理
doRegisterBeanDefinitions()
createDelegate()
isDefaultNamespace()
preProcessXml()
parseBeanDefinitions()
postProcessXml()
BeanDefinitionParserDelegate
acceptsProfiles()

parseBeanDefinitions()方法是具体将xml定义解析的实现

处理XML的Element
解析import
解析alias
解析bean
解析beans
递归调用
解析bean的定义
命名空间处理器装饰bean
注册bean定义到XmlReaderContext.BeanDefinitionRegistry
发送注册事件
parseBeanDefinitions()
parseDefaultElement()
importBeanDefinitionResource()
processAliasRegistration()
processBeanDefinition()
doRegisterBeanDefinitions()
delegate.parseBeanDefinitionElement()
decorateBeanDefinitionIfRequired()
BeanDefinitionReaderUtils.registerBeanDefinition()
getReaderContext().fireComponentRegistered()

到此为止,spring的XmlBeanDefinitionReader将xml文件使用Resource读取,并解析为Bean的定义为BeanDefinition,然后注册入XmlReaderContext.BeanDefinitionRegistry中,中间类的调用关系如下。

doLoadDocument()
传入
createBeanDefinitionDocumentReader()
createReaderContext()
传入
传入
createDelegate()
生成
传入
processBeanDefinition()
«interface»
Resource
ClassPathResource
基于类路径的资源加载
EncodedResource
+Resource resource;
+String encoding;
+Charset charset;
Document
XML文件描述
XmlBeanDefinitionReader
+BeanDefinitionRegistry registry
+loadBeanDefinitions(resource : Resource) : int
BeanDefinitionRegistry
注册BeanDefinition的接口
+registerBeanDefinition
SimpleBeanDefinitionRegistry
BeanDefinitionRegistry的简单实现
BeanDefinitionDocumentReader
基于Document解析Bean定义
DefaultBeanDefinitionDocumentReader
+registerBeanDefinitions(Document, XmlReaderContext)
+doRegisterBeanDefinitions(Element)
XmlReaderContext
上线文封装类
+XmlBeanDefinitionReader reader;
BeanDefinitionParserDelegate
Xml的Bean解析代理类
+parseBeanDefinitionElement(Element, BeanDefinitionHolder) : BeanDefinitionHolder
+decorateBeanDefinitionIfRequired(Element, BeanDefinitionHolder) : BeanDefinitionHolder
BeanDefinitionHolder
BeanDefinition的holder
BeanDefinitionReaderUtils
工具类
+createBeanDefinition() : AbstractBeanDefinition
+registerBeanDefinition(BeanDefinitionHolder, BeanDefinitionRegistry)

去除各个子类实现类,以及xxxUtilxxxHolderxxxConetxt等工具类,简单罗列一下顶层接口的交互过程

传入
解析bean定义
注册bean
«interface»
BeanDefinitionRegistry
注册bean定义BeanDefinition的接口
«interface»
BeanDefinitionReader
读取bean定义BeanDefinition的接口
«interface»
Resource
spring中资源描述符接口,用于加载资源文件
«interface»
BeanDefinition
用户描述Bean定义的接口

spring定义了几个bean操作的顶层接口BeanDefinitionRegistryBeanDefinitionReaderBeanDefinitionReaderResource,上述过程完成了XML资源文件到Bean的描述对象BeanDefinition的注册过程,但是实际使用IOC过程中,并不是直接使用BeanDefinition,而是直接获取bean实例,可以查看测试用例XmlBeanDefinitionReaderTestsdoTestValidation()方法

private void doTestValidation(String resourceName) {DefaultListableBeanFactory factory = new DefaultListableBeanFactory();Resource resource = new ClassPathResource(resourceName, getClass());new XmlBeanDefinitionReader(factory).loadBeanDefinitions(resource);assertThat((TestBean) factory.getBean("testBean")).isNotNull();
}

对比此处与上面的不同之处在于,此处XmlBeanDefinitionReader的入参由SimpleBeanDefinitionRegistry变为DefaultListableBeanFactoryDefaultListableBeanFactory中提供方法factory.getBean("testBean")直接获取名为testBean的bean对象,而不是获取BeanDefinition

这篇关于Spring源码笔记之SpringIOC--(1)从XML文件到Bean的描述对象BeanDefinition的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/719378

相关文章

SpringBoot中四种AOP实战应用场景及代码实现

《SpringBoot中四种AOP实战应用场景及代码实现》面向切面编程(AOP)是Spring框架的核心功能之一,它通过预编译和运行期动态代理实现程序功能的统一维护,在SpringBoot应用中,AO... 目录引言场景一:日志记录与性能监控业务需求实现方案使用示例扩展:MDC实现请求跟踪场景二:权限控制与

Android实现定时任务的几种方式汇总(附源码)

《Android实现定时任务的几种方式汇总(附源码)》在Android应用中,定时任务(ScheduledTask)的需求几乎无处不在:从定时刷新数据、定时备份、定时推送通知,到夜间静默下载、循环执行... 目录一、项目介绍1. 背景与意义二、相关基础知识与系统约束三、方案一:Handler.postDel

Java NoClassDefFoundError运行时错误分析解决

《JavaNoClassDefFoundError运行时错误分析解决》在Java开发中,NoClassDefFoundError是一种常见的运行时错误,它通常表明Java虚拟机在尝试加载一个类时未能... 目录前言一、问题分析二、报错原因三、解决思路检查类路径配置检查依赖库检查类文件调试类加载器问题四、常见

Java注解之超越Javadoc的元数据利器详解

《Java注解之超越Javadoc的元数据利器详解》本文将深入探讨Java注解的定义、类型、内置注解、自定义注解、保留策略、实际应用场景及最佳实践,无论是初学者还是资深开发者,都能通过本文了解如何利用... 目录什么是注解?注解的类型内置注编程解自定义注解注解的保留策略实际用例最佳实践总结在 Java 编程

Java 实用工具类Spring 的 AnnotationUtils详解

《Java实用工具类Spring的AnnotationUtils详解》Spring框架提供了一个强大的注解工具类org.springframework.core.annotation.Annot... 目录前言一、AnnotationUtils 的常用方法二、常见应用场景三、与 JDK 原生注解 API 的

Java controller接口出入参时间序列化转换操作方法(两种)

《Javacontroller接口出入参时间序列化转换操作方法(两种)》:本文主要介绍Javacontroller接口出入参时间序列化转换操作方法,本文给大家列举两种简单方法,感兴趣的朋友一起看... 目录方式一、使用注解方式二、统一配置场景:在controller编写的接口,在前后端交互过程中一般都会涉及

Java中的StringBuilder之如何高效构建字符串

《Java中的StringBuilder之如何高效构建字符串》本文将深入浅出地介绍StringBuilder的使用方法、性能优势以及相关字符串处理技术,结合代码示例帮助读者更好地理解和应用,希望对大家... 目录关键点什么是 StringBuilder?为什么需要 StringBuilder?如何使用 St

使用Java将各种数据写入Excel表格的操作示例

《使用Java将各种数据写入Excel表格的操作示例》在数据处理与管理领域,Excel凭借其强大的功能和广泛的应用,成为了数据存储与展示的重要工具,在Java开发过程中,常常需要将不同类型的数据,本文... 目录前言安装免费Java库1. 写入文本、或数值到 Excel单元格2. 写入数组到 Excel表格

Java并发编程之如何优雅关闭钩子Shutdown Hook

《Java并发编程之如何优雅关闭钩子ShutdownHook》这篇文章主要为大家详细介绍了Java如何实现优雅关闭钩子ShutdownHook,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起... 目录关闭钩子简介关闭钩子应用场景数据库连接实战演示使用关闭钩子的注意事项开源框架中的关闭钩子机制1.

Maven中引入 springboot 相关依赖的方式(最新推荐)

《Maven中引入springboot相关依赖的方式(最新推荐)》:本文主要介绍Maven中引入springboot相关依赖的方式(最新推荐),本文给大家介绍的非常详细,对大家的学习或工作具有... 目录Maven中引入 springboot 相关依赖的方式1. 不使用版本管理(不推荐)2、使用版本管理(推