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

相关文章

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流(parallelStream)的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS

Java中Redisson 的原理深度解析

《Java中Redisson的原理深度解析》Redisson是一个高性能的Redis客户端,它通过将Redis数据结构映射为Java对象和分布式对象,实现了在Java应用中方便地使用Redis,本文... 目录前言一、核心设计理念二、核心架构与通信层1. 基于 Netty 的异步非阻塞通信2. 编解码器三、

MyBatis常用XML语法详解

《MyBatis常用XML语法详解》文章介绍了MyBatis常用XML语法,包括结果映射、查询语句、插入语句、更新语句、删除语句、动态SQL标签以及ehcache.xml文件的使用,感兴趣的朋友跟随小... 目录1、定义结果映射2、查询语句3、插入语句4、更新语句5、删除语句6、动态 SQL 标签7、ehc

SpringBoot基于注解实现数据库字段回填的完整方案

《SpringBoot基于注解实现数据库字段回填的完整方案》这篇文章主要为大家详细介绍了SpringBoot如何基于注解实现数据库字段回填的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解... 目录数据库表pom.XMLRelationFieldRelationFieldMapping基础的一些代

一篇文章彻底搞懂macOS如何决定java环境

《一篇文章彻底搞懂macOS如何决定java环境》MacOS作为一个功能强大的操作系统,为开发者提供了丰富的开发工具和框架,下面:本文主要介绍macOS如何决定java环境的相关资料,文中通过代码... 目录方法一:使用 which命令方法二:使用 Java_home工具(Apple 官方推荐)那问题来了,

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述:HashMap的宏观结构二、核心数据结构解析1. 数组(桶数组)2. 链表节点(Node

Java AOP面向切面编程的概念和实现方式

《JavaAOP面向切面编程的概念和实现方式》AOP是面向切面编程,通过动态代理将横切关注点(如日志、事务)与核心业务逻辑分离,提升代码复用性和可维护性,本文给大家介绍JavaAOP面向切面编程的概... 目录一、AOP 是什么?二、AOP 的核心概念与实现方式核心概念实现方式三、Spring AOP 的关

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储:配置灵活性:编码示例引入依赖:配置ehcache.XML文件:配置

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程?1.2 为什么需要虚拟线程?二、虚拟线程与平台线程对比代码对比示例:三

Java中的.close()举例详解

《Java中的.close()举例详解》.close()方法只适用于通过window.open()打开的弹出窗口,对于浏览器的主窗口,如果没有得到用户允许是不能关闭的,:本文主要介绍Java中的.... 目录当你遇到以下三种情况时,一定要记得使用 .close():用法作用举例如何判断代码中的 input