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保证HashMap线程安全的几种方式

《JAVA保证HashMap线程安全的几种方式》HashMap是线程不安全的,这意味着如果多个线程并发地访问和修改同一个HashMap实例,可能会导致数据不一致和其他线程安全问题,本文主要介绍了JAV... 目录1. 使用 Collections.synchronizedMap2. 使用 Concurren

Java Response返回值的最佳处理方案

《JavaResponse返回值的最佳处理方案》在开发Web应用程序时,我们经常需要通过HTTP请求从服务器获取响应数据,这些数据可以是JSON、XML、甚至是文件,本篇文章将详细解析Java中处理... 目录摘要概述核心问题:关键技术点:源码解析示例 1:使用HttpURLConnection获取Resp

Python利用ElementTree实现快速解析XML文件

《Python利用ElementTree实现快速解析XML文件》ElementTree是Python标准库的一部分,而且是Python标准库中用于解析和操作XML数据的模块,下面小编就来和大家详细讲讲... 目录一、XML文件解析到底有多重要二、ElementTree快速入门1. 加载XML的两种方式2.

Java的栈与队列实现代码解析

《Java的栈与队列实现代码解析》栈是常见的线性数据结构,栈的特点是以先进后出的形式,后进先出,先进后出,分为栈底和栈顶,栈应用于内存的分配,表达式求值,存储临时的数据和方法的调用等,本文给大家介绍J... 目录栈的概念(Stack)栈的实现代码队列(Queue)模拟实现队列(双链表实现)循环队列(循环数组

Java中Switch Case多个条件处理方法举例

《Java中SwitchCase多个条件处理方法举例》Java中switch语句用于根据变量值执行不同代码块,适用于多个条件的处理,:本文主要介绍Java中SwitchCase多个条件处理的相... 目录前言基本语法处理多个条件示例1:合并相同代码的多个case示例2:通过字符串合并多个case进阶用法使用

Java中的Lambda表达式及其应用小结

《Java中的Lambda表达式及其应用小结》Java中的Lambda表达式是一项极具创新性的特性,它使得Java代码更加简洁和高效,尤其是在集合操作和并行处理方面,:本文主要介绍Java中的La... 目录前言1. 什么是Lambda表达式?2. Lambda表达式的基本语法例子1:最简单的Lambda表

Java中Scanner的用法示例小结

《Java中Scanner的用法示例小结》有时候我们在编写代码的时候可能会使用输入和输出,那Java也有自己的输入和输出,今天我们来探究一下,对JavaScanner用法相关知识感兴趣的朋友一起看看吧... 目录前言一 输出二 输入Scanner的使用多组输入三 综合练习:猜数字游戏猜数字前言有时候我们在

Spring Security+JWT如何实现前后端分离权限控制

《SpringSecurity+JWT如何实现前后端分离权限控制》本篇将手把手教你用SpringSecurity+JWT搭建一套完整的登录认证与权限控制体系,具有很好的参考价值,希望对大家... 目录Spring Security+JWT实现前后端分离权限控制实战一、为什么要用 JWT?二、JWT 基本结构

java解析jwt中的payload的用法

《java解析jwt中的payload的用法》:本文主要介绍java解析jwt中的payload的用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Java解析jwt中的payload1. 使用 jjwt 库步骤 1:添加依赖步骤 2:解析 JWT2. 使用 N

springboot项目如何开启https服务

《springboot项目如何开启https服务》:本文主要介绍springboot项目如何开启https服务方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录springboot项目开启https服务1. 生成SSL证书密钥库使用keytool生成自签名证书将