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

相关文章

Spring Boot + MyBatis Plus 高效开发实战从入门到进阶优化(推荐)

《SpringBoot+MyBatisPlus高效开发实战从入门到进阶优化(推荐)》本文将详细介绍SpringBoot+MyBatisPlus的完整开发流程,并深入剖析分页查询、批量操作、动... 目录Spring Boot + MyBATis Plus 高效开发实战:从入门到进阶优化1. MyBatis

SpringCloud动态配置注解@RefreshScope与@Component的深度解析

《SpringCloud动态配置注解@RefreshScope与@Component的深度解析》在现代微服务架构中,动态配置管理是一个关键需求,本文将为大家介绍SpringCloud中相关的注解@Re... 目录引言1. @RefreshScope 的作用与原理1.1 什么是 @RefreshScope1.

Java并发编程必备之Synchronized关键字深入解析

《Java并发编程必备之Synchronized关键字深入解析》本文我们深入探索了Java中的Synchronized关键字,包括其互斥性和可重入性的特性,文章详细介绍了Synchronized的三种... 目录一、前言二、Synchronized关键字2.1 Synchronized的特性1. 互斥2.

Spring Boot 配置文件之类型、加载顺序与最佳实践记录

《SpringBoot配置文件之类型、加载顺序与最佳实践记录》SpringBoot的配置文件是灵活且强大的工具,通过合理的配置管理,可以让应用开发和部署更加高效,无论是简单的属性配置,还是复杂... 目录Spring Boot 配置文件详解一、Spring Boot 配置文件类型1.1 applicatio

Java中StopWatch的使用示例详解

《Java中StopWatch的使用示例详解》stopWatch是org.springframework.util包下的一个工具类,使用它可直观的输出代码执行耗时,以及执行时间百分比,这篇文章主要介绍... 目录stopWatch 是org.springframework.util 包下的一个工具类,使用它

Java进行文件格式校验的方案详解

《Java进行文件格式校验的方案详解》这篇文章主要为大家详细介绍了Java中进行文件格式校验的相关方案,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、背景异常现象原因排查用户的无心之过二、解决方案Magandroidic Number判断主流检测库对比Tika的使用区分zip

Java实现时间与字符串互相转换详解

《Java实现时间与字符串互相转换详解》这篇文章主要为大家详细介绍了Java中实现时间与字符串互相转换的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、日期格式化为字符串(一)使用预定义格式(二)自定义格式二、字符串解析为日期(一)解析ISO格式字符串(二)解析自定义

Java使用Curator进行ZooKeeper操作的详细教程

《Java使用Curator进行ZooKeeper操作的详细教程》ApacheCurator是一个基于ZooKeeper的Java客户端库,它极大地简化了使用ZooKeeper的开发工作,在分布式系统... 目录1、简述2、核心功能2.1 CuratorFramework2.2 Recipes3、示例实践3

Springboot处理跨域的实现方式(附Demo)

《Springboot处理跨域的实现方式(附Demo)》:本文主要介绍Springboot处理跨域的实现方式(附Demo),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不... 目录Springboot处理跨域的方式1. 基本知识2. @CrossOrigin3. 全局跨域设置4.

springboot security使用jwt认证方式

《springbootsecurity使用jwt认证方式》:本文主要介绍springbootsecurity使用jwt认证方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录前言代码示例依赖定义mapper定义用户信息的实体beansecurity相关的类提供登录接口测试提供一