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实现RSA+AES自动接口解密的实战指南

《SpringBoot实现RSA+AES自动接口解密的实战指南》在当今数据泄露频发的网络环境中,接口安全已成为开发者不可忽视的核心议题,RSA+AES混合加密方案因其安全性高、性能优越而被广泛采用,本... 目录一、项目依赖与环境准备1.1 Maven依赖配置1.2 密钥生成与配置二、加密工具类实现2.1

在Java中实现线程之间的数据共享的几种方式总结

《在Java中实现线程之间的数据共享的几种方式总结》在Java中实现线程间数据共享是并发编程的核心需求,但需要谨慎处理同步问题以避免竞态条件,本文通过代码示例给大家介绍了几种主要实现方式及其最佳实践,... 目录1. 共享变量与同步机制2. 轻量级通信机制3. 线程安全容器4. 线程局部变量(ThreadL

分布式锁在Spring Boot应用中的实现过程

《分布式锁在SpringBoot应用中的实现过程》文章介绍在SpringBoot中通过自定义Lock注解、LockAspect切面和RedisLockUtils工具类实现分布式锁,确保多实例并发操作... 目录Lock注解LockASPect切面RedisLockUtils工具类总结在现代微服务架构中,分布

Java使用Thumbnailator库实现图片处理与压缩功能

《Java使用Thumbnailator库实现图片处理与压缩功能》Thumbnailator是高性能Java图像处理库,支持缩放、旋转、水印添加、裁剪及格式转换,提供易用API和性能优化,适合Web应... 目录1. 图片处理库Thumbnailator介绍2. 基本和指定大小图片缩放功能2.1 图片缩放的

Spring Boot集成/输出/日志级别控制/持久化开发实践

《SpringBoot集成/输出/日志级别控制/持久化开发实践》SpringBoot默认集成Logback,支持灵活日志级别配置(INFO/DEBUG等),输出包含时间戳、级别、类名等信息,并可通过... 目录一、日志概述1.1、Spring Boot日志简介1.2、日志框架与默认配置1.3、日志的核心作用

破茧 JDBC:MyBatis 在 Spring Boot 中的轻量实践指南

《破茧JDBC:MyBatis在SpringBoot中的轻量实践指南》MyBatis是持久层框架,简化JDBC开发,通过接口+XML/注解实现数据访问,动态代理生成实现类,支持增删改查及参数... 目录一、什么是 MyBATis二、 MyBatis 入门2.1、创建项目2.2、配置数据库连接字符串2.3、入

Springboot项目启动失败提示找不到dao类的解决

《Springboot项目启动失败提示找不到dao类的解决》SpringBoot启动失败,因ProductServiceImpl未正确注入ProductDao,原因:Dao未注册为Bean,解决:在启... 目录错误描述原因解决方法总结***************************APPLICA编

深度解析Spring Security 中的 SecurityFilterChain核心功能

《深度解析SpringSecurity中的SecurityFilterChain核心功能》SecurityFilterChain通过组件化配置、类型安全路径匹配、多链协同三大特性,重构了Spri... 目录Spring Security 中的SecurityFilterChain深度解析一、Security

SpringBoot多环境配置数据读取方式

《SpringBoot多环境配置数据读取方式》SpringBoot通过环境隔离机制,支持properties/yaml/yml多格式配置,结合@Value、Environment和@Configura... 目录一、多环境配置的核心思路二、3种配置文件格式详解2.1 properties格式(传统格式)1.

Apache Ignite 与 Spring Boot 集成详细指南

《ApacheIgnite与SpringBoot集成详细指南》ApacheIgnite官方指南详解如何通过SpringBootStarter扩展实现自动配置,支持厚/轻客户端模式,简化Ign... 目录 一、背景:为什么需要这个集成? 二、两种集成方式(对应两种客户端模型) 三、方式一:自动配置 Thick