Spring Bean生命周期之Bean元信息的配置与解析阶段详解

目录
  • BeanDefinitionReader体系
    • BeanDefinitionReader接口定义
  • 元信息配置与解析方式
  • XmlBeanDefinitionReader元信息解析源码分析
  • AnnotatedBeanDefinitionReader元信息解析源码分析
  • 总结

写在前面

注：本文章使用的 SpringBoot 版本为 2.2.4.RELEASE，其 Spring 版本为 5.2.3.RELEASE

虽然Bean的创建可以采用BeanDefinition API 也可以直接采用注解方式，但从学习角度出发这里主要以API形式创建Bean。下面以一段Bean创建的示例来引出讨论的议题。

public class XmlBeanMetaDataConfigDemo {
    public static void main(String[] args) {
        DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
        XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
        int beanDefinitions = beanDefinitionReader.loadBeanDefinitions("META-INF/spring.xml");
        System.out.println("加载的BeanDefinition个数为:" + beanDefinitions);
		//User就是普通的POJO类 这里不再给出User定义
        User user = beanFactory.getBean("user", User.class);
        System.out.println(user);
    }
}

<?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
        https://www.springframework.org/schema/beans/spring-beans.xsd">
    <bean id="user" class="com.wojiushiwo.dto.User">
        <property name="name" value="wojiushiwo"/>
        <property name="age" value="18"/>
    </bean>
</beans>

上面代码 是使用BeanDefinitionReader去加载XML文件中的Bean定义

BeanDefinitionReader体系

先来看一下BeanDefinitionReader的接口定义以及继承关系

通过上面的类图我们发现BeanDefinitionReader有三个实现类,可以看出针对BeanDefiniiton的不同载体 均提供了解析手段，有XML形式的、有Properties形式的等等。

BeanDefinitionReader接口定义

public interface BeanDefinitionReader {
  //返回注册了当前BeanDefinition的 BeanFactory
	BeanDefinitionRegistry getRegistry();
	@Nullable
	ResourceLoader getResourceLoader();
	@Nullable
	ClassLoader getBeanClassLoader();
	//BeanName 生成器，默认是DefaultBeanNameGenerator
	BeanNameGenerator getBeanNameGenerator();

  //从指定资源中加载BeanDefinition，并返回加载到的BeanDefinition的个数
	int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException;
	int loadBeanDefinitions(Resource... resources) throws BeanDefinitionStoreException;
	//从指定资源路径中中加载BeanDefinition，并返回加载到的BeanDefinition的个数
	int loadBeanDefinitions(String location) throws BeanDefinitionStoreException;
	int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException;
}

由于Bean元信息的配置与解析是息息相关的，下面的一些例子也是将它们揉在一起讨论的。

元信息配置与解析方式

1、API方式

这种方式直接采用BeanDefinitionAPI 来构成Bean元信息，并将其注入到IoC容器中，这里主要使用到BeanDefinitionBuilder或GenericBeanDefinition两种方式来创建Bean元信息

关于BeanDefinition这个议题的讨论会放在其他篇章中，这里不再赘述了。

public class ApiBeanMetaDataConfigDemo {
    public static void main(String[] args) {
        //创建注解相关的上下文
        AnnotationConfigApplicationContext context=new AnnotationConfigApplicationContext();
	    //创建GenericBeanDefinition
        GenericBeanDefinition beanDefinition=new GenericBeanDefinition();
        //设置BeanClass
        beanDefinition.setBeanClass(User.class);
        //设置属性
        MutablePropertyValues propertyValues=new MutablePropertyValues();
        propertyValues.addPropertyValue("name","我就是我");
        propertyValues.addPropertyValue("age",18);
        beanDefinition.setPropertyValues(propertyValues);
		//注册BeanDefinition
        context.registerBeanDefinition("user",beanDefinition);
		//刷新IoC容器
        context.refresh();
		//获取Bean
        User user = context.getBean("user", User.class);
        System.out.println(user);
		//关闭上下文
        context.close();
    }
}

2、面向XML配置

从XML配置资源处 加载BeanDefinition

<?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
        https://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="user" class="com.wojiushiwo.dto.User">
        <property name="name" value="wojiushiwo"/>
        <property name="age" value="18"/>
    </bean>
</beans>

public class XmlBeanMetaDataConfigDemo {
    public static void main(String[] args) {
        DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
        XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
        //加载指定文件的BeanDefinition，并获取加载地BeanDefinition个数
        int beanDefinitions = beanDefinitionReader.loadBeanDefinitions("META-INF/spring.xml");
        System.out.println("加载的BeanDefinition个数为:" + beanDefinitions);
        User user = beanFactory.getBean("user", User.class);
        System.out.println(user);
    }
}

3、面向Properties配置

这种配置方式不太常用，配置资源时需要遵守规则，配置规则可参考PropertiesBeanDefinitionReader注释文档，其规则如下

Properties 属性名 使用场景
(class) Bean 类全称限定名
(abstract) 是否为抽象的 BeanDefinition
(parent) 指定 parent BeanDefinition 名称
(lazy-init) 是否为延迟初始化
(ref) 引用其他 Bean 的名称
(scope) 设置 Bean 的 scope 属性
${n} n 表示第 n+1 个构造器参数 
## 指定BeanClass
user.(class)=com.wojiushiwo.dto.User
## 属性
user.name=我就是我
user.age=19

public class PropertiesBeanMetaDataConfigDemo {
    public static void main(String[] args) {
        DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
        PropertiesBeanDefinitionReader beanDefinitionReader = new PropertiesBeanDefinitionReader(beanFactory);
        ClassPathResource classPathResource=new ClassPathResource("META-INF/user.properties");
        EncodedResource resource=new EncodedResource(classPathResource,"UTF-8");
        int beanDefinitions = beanDefinitionReader.loadBeanDefinitions(resource);
        System.out.println("加载的BeanDefinition个数为:" + beanDefinitions);
        User user = beanFactory.getBean("user", User.class);
        System.out.println(user);
    }
}

上面 Properties文件默认读写编码为ISO-8859-1 因此这种直接加载方式会出现中文乱码，可通过加载在加载资源时指定编码方式来解决

4、面向注解

比如@Autowired、@Bean、@Component、@Configuration等，这些在当下都比较常用不再赘述

XmlBeanDefinitionReader元信息解析 源码分析

下面就XmlBeanDefinitionReader调用链中比较重要的地方进行分析

protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
			throws BeanDefinitionStoreException {
		try {
		    //解析Xml文件生成Document，这里不再展开
			Document doc = doLoadDocument(inputSource, resource);
			// 解析Document 注册BeanDefinition
			int count = registerBeanDefinitions(doc, resource);
			//省略日志打印
			return count;
		}
		catch (BeanDefinitionStoreException ex) {
			//... 异常及日志
			}
	}

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
        //获取DefaultBeanDefinitionReader
		BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
		//获取IoC容器中 已经存在的BeanDefinition的个数
		int countBefore = getRegistry().getBeanDefinitionCount();
		//这里实际上执行解析Document文档树 注册BeanDefinition
		documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
		//返回此次加载的BeanDefinition个数
		return getRegistry().getBeanDefinitionCount() - countBefore;
	}

protected void doRegisterBeanDefinitions(Element root) {
		BeanDefinitionParserDelegate parent = this.delegate;
		this.delegate = createDelegate(getReaderContext(), root, parent);
		// namespace=http://www.springframework.org/schema/beans 表示为默认命名空间 则使用默认的解析方式去解析元素，否则将采用NamespaceHandler去解析
		if (this.delegate.isDefaultNamespace(root)) {
		    //获取profile属性，profile与Spring配置环境有关系
			String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
			//如果配置了profile
			if (StringUtils.hasText(profileSpec)) {
				String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
						profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
      //如果当前Environment环境与profile不匹配 则流程结束
				if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
					//省略日志
					return;
				}
			}
		}
	    //解析xml前置操作
		preProcessXml(root);
		//解析xml
		parseBeanDefinitions(root, this.delegate);
		//解析xml后置操作
		postProcessXml(root);
		this.delegate = parent;
	}

关于上面源码分析中profile以及NameSpace的理解 请看这里的XML

<beans
        xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd" profile="dev">
        <!-- 一些配置-->
</beans>

可以看出 xmlns所指代的就是namespace，而profile也可以配置在beans标签上，其中

http://www.springframework.org/schema/beans

表示默认命名空间。因为Spring允许自定义标签，所以通过是否为默认命名空间作为判断依据来选择使用不同的解析方式去解析标签

protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
		//如果是默认命名空间
		if (delegate.isDefaultNamespace(root)) {
			NodeList nl = root.getChildNodes();
			for (int i = 0; i < nl.getLength(); i++) {
				Node node = nl.item(i);
				if (node instanceof Element) {
					Element ele = (Element) node;
					if (delegate.isDefaultNamespace(ele)) {
						parseDefaultElement(ele, delegate);
					}
					else {
					    // 使用NamespaceHandler去解析标签，比如ContextNamespaceHandler去解析<context:xx>的标签等
						delegate.parseCustomElement(ele);
					}
				}
			}
		}
		else {
		  // 使用NamespaceHandler去解析标签，比如ContextNamespaceHandler去解析<context:xx>的标签等
			delegate.parseCustomElement(root);
		}
	}

上面的代码逻辑，根据是否为默认命名空间从而选择不同的解析方式，自定义标签或非默认命名空间指令 需要继承NamespaceHandler去实现自己的标签解析方式

非默认命名空间指令举例

<context:component-scan base-package="com.wojiushiwo"/><aop:xx></aop><context:component-scan base-package="com.wojiushiwo"/>
<aop:xx></aop>

这里直接看针对默认命名空间的解析代码

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
        //如果是import指令
		if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
			importBeanDefinitionResource(ele);
		}
		//如果是alias指令
		else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
			processAliasRegistration(ele);
		}
		//如果是bean指令
		else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
			processBeanDefinition(ele, delegate);
		}
		else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
			// recurse
			doRegisterBeanDefinitions(ele);
		}
	}

针对bean指令

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
		BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
		if (bdHolder != null) {
			bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
			try {
//使用BeanRegistry对BeanDefinition进行注册		BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
			}
			catch (BeanDefinitionStoreException ex) {
				getReaderContext().error("Failed to register bean definition with name '" +
						bdHolder.getBeanName() + "'", ele, ex);
			}
			// Send registration event.
			getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
		}
	}

我们再来梳理下主要流程：

1、解析Xml文件 生成Document

2、针对Document命名空间进行标签解析

  • 默认命名空间 标签解析
  • 非默认命名空间或自定义标签 自行实现NamespaceHandler去解析(Spring 内置了一些NamespaceHandler解析自定义标签)

3、使用BeanRegistry对BeanDefinition进行注册

AnnotatedBeanDefinitionReader元信息解析 源码分析

AnnotatedBeanDefinitionReader从名称上看它似乎与BeanDefinitionReader有千丝万缕的关系，实质上二者没有关系。
AnnotatedBeanDefinitionReader主要是 对注解Bean进行解析的。

先举例说明下

@Configuration
public class BeanInitializationDemo {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
        // 注册 Configuration Class（配置类）
      applicationContext.register(BeanInitializationDemo.class);
        // 启动 Spring 应用上下文
        applicationContext.refresh();
        applicationContext.close();
    }
}

借助上面的例子我们看一下其调用流程

以上面的例子来看，AnnotationBeanDefinitionReader的创建是在AnnotationConfigApplicationContext构造函数中进行的。

public class AnnotationConfigApplicationContext extends GenericApplicationContext implements AnnotationConfigRegistry {
	private final AnnotatedBeanDefinitionReader reader;
	private final ClassPathBeanDefinitionScanner scanner;
	public AnnotationConfigApplicationContext() {
	  //创建AnnotatedBeanDefinitionReader
		this.reader = new AnnotatedBeanDefinitionReader(this);
		this.scanner = new ClassPathBeanDefinitionScanner(this);
	}
}

public static void registerBeanDefinition(
			BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
			throws BeanDefinitionStoreException {
		// 获取BeanName
		String beanName = definitionHolder.getBeanName();
		//注册bd到IoC容器
		registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
		// 如果bean存在别名，则将beanName与alias的关系也存起来
		String[] aliases = definitionHolder.getAliases();
		if (aliases != null) {
			for (String alias : aliases) {
				registry.registerAlias(beanName, alias);
			}
		}
	}

透过上面XmlBeanDefinitionReader和AnnotationBeanDefinitionReader对BeanDefinition的解析来看，最终BeanDefinition的注册都指向了BeanDefinitionReaderUtils.registerBeanDefinition。我们先来大概看一下代码实现

public static void registerBeanDefinition(
			BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
			throws BeanDefinitionStoreException {
		// 获取BeanName
		String beanName = definitionHolder.getBeanName();
		//注册bd到IoC容器
		registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
		// 如果bean存在别名，则将beanName与alias的关系也存起来
		String[] aliases = definitionHolder.getAliases();
		if (aliases != null) {
			for (String alias : aliases) {
				registry.registerAlias(beanName, alias);
			}
		}
	}

总结

本篇文章就到这里了，希望能够给你带来帮助，也希望您能够多多关注我们的更多内容!

赞 (0)

相关推荐

  • Spring Bean生命周期之属性赋值阶段详解

    目录 前言 属性自动装配 属性赋值前回调 属性的真正赋值 总结 前言 上节在谈论Bean的实例化过程时,在说明实例化后阶段时只是粗略地看了一下populateBean,并未展开分析.本节接着populateBean开始分析对象赋值阶段的事情. populateBean其实主要做了以下几件事: Bean实例化后回调,来决定是否进行属性赋值 (上节分析过了) 对属性进行自动装配 InstantiationAwareBeanPostProcessor属性赋值前回调 属性的真正赋值 protected

  • Spring Bean生命周期之Bean的注册详解

    Spring Bean生命周期之Bean的注册详解

    目录 前言 BeanFactory的继承体系 Bean的注册 alias别名的注册 总结 前言 上篇文章介绍了Bean元信息的配置与解析过程,限于篇幅Bean注册过程就没展开. 这里主要围绕BeanDefinitionReaderUtils#registerBeanDefinition展开分析下Bean注册过程 public static void registerBeanDefinition( BeanDefinitionHolder definitionHolder, BeanDefinit

  • Spring中如何使用@Value注解实现给Bean属性赋值

    Spring中如何使用@Value注解实现给Bean属性赋值

    目录 属性赋值 @Value注解的定义: 测试 1.在添加了Spring依赖的Maven项目中创建 2.在resources目录下创建一个配置文件person.properties 3.创建配置类 4.创建测试类进行测试 5.测试结果: 如何给Bean的属性赋值(注入) 1.通过构造方法设置值. 2.设置注入(通过set方法) 属性赋值 只用Spring注解开发的时候,可以使用@Value搭配@PropertySource注解进行给Bean的属性进行赋值. @Value @Value注解的定义:

  • Spring Bean生命周期之Bean的实例化详解

    目录 前言 实例化前阶段 实例化阶段 实例化后阶段 总结 前言 上一节说到了BeanDefinition的合并过程,这节该说Bean的实例化过程了.根据AbstractAutowireCapableBeanFactory#createBean源码逻辑 可将实例化过程分为实例化前阶段.实例化过程.实例化后阶段. 实例化前阶段 protected Object createBean(String beanName, RootBeanDefinition mbd, @Nullable Object[]

  • Spring Bean生命周期之BeanDefinition的合并过程详解

    目录 前言 BeanDefinition的合并源码分析 总结 写在前面 注:本文章使用的 SpringBoot 版本为 2.2.4.RELEASE,其 Spring 版本为 5.2.3.RELEASE 前言 书接上文,BeanDefinition注册到IoC容器后,紧接着就是要使用Bean了,要使用必须先要获取Bean,这里我们就以DefaultListableBeanFactory#getBean方法来引出本次讨论的内容:BeanDefinition的合并 通过前面的章节我们了解到了BeanD

  • Spring Bean生命周期之Bean元信息的配置与解析阶段详解

    Spring Bean生命周期之Bean元信息的配置与解析阶段详解

    目录 BeanDefinitionReader体系 BeanDefinitionReader接口定义 元信息配置与解析方式 XmlBeanDefinitionReader元信息解析源码分析 AnnotatedBeanDefinitionReader元信息解析源码分析 总结 写在前面 注:本文章使用的 SpringBoot 版本为 2.2.4.RELEASE,其 Spring 版本为 5.2.3.RELEASE 虽然Bean的创建可以采用BeanDefinition API 也可以直接采用注解方式

  • 深入了解Spring的Bean生命周期

    深入了解Spring的Bean生命周期

    目录 源码下载 什么是 Spring Bean 的生命周期 Bean的生命周期 Spring角度查看bean的定义与注册 SpringBoot角度查看bean定义和注册 实例化,依赖注入,初始化 Bean的生命周期的扩展点 Bean级别 容器级别 常用接口 InstantiationAwareBeanPostProcessor BeanNameAware BeanFactoryAware ApplicationContextAware BeanPostProcessor Initializing

  • 全面详解Spring Bean生命周期教程示例

    目录 Spring 中 Bean 的生命周期 Bean 的实例化 构造方法注入 工厂方法注入 Bean 的属性赋值 setter注入 构造方法注入 Bean 的初始化 初始化方法 InitializingBean 接口 Bean 的销毁 销毁方法 DisposableBean 接口 总结 Spring 中 Bean 的生命周期 是当今最流行的 Java 开发框架之一,其强大的 Bean容器机制是其中的核心之一.Bean 是指在 Spring 容器中被管理的对象,它们可以被注入到其他对象中,也可以

  • Spring配置使用之Bean生命周期详解

    基本概念 Spring 中的 Bean 的生命周期,指的是 Bean 从创建到销毁的过程. 下面来探究下几个有关 Bean 生命周期配置的属性. lazy-init lazy-init 表示延迟加载 Bean,默认在 Spring IoC 容器初始化时会实例化所有在配置文件定义的 Bean,若启用了 lazy-init 则在调用 Bean 时才会去创建 Bean. 定义 Bean: public class Animals { public Animals(){ System.out.print

  • Spring Bean生命周期详细分析

    Spring Bean生命周期详细分析

    目录 前言 一.Bean的介绍 什么是Bean Bean的生命周期 Bean的作用域 二.详细过程 1. Bean的实例化 2. InstantiationAwareBeanPostProcessor 3. 设置属性(依赖注入) 4. 注入Aware接口 5. BeanPostProcessor的postProcessBeforeInitialzation方法 6. InitializingBean与init-method 7. BeanPostProcess的postProcessAfterI

  • 浅谈Spring bean 生命周期验证

    浅谈Spring bean 生命周期验证

    一.从源码注释看bean生命周期 从JDK源码上看,BeanFactory实现类需要支持Bean的完整生命周期,完整的初始化方法及其标准顺序(格式:接口 方法)为: 1.BeanNameAware setBeanName 设置bean名称 2.BeanClassLoaderAware setBeanClassLoader 设置bean类加载器 3.BeanFactoryAware setBeanFactory 设置bean工厂 4.EnvironmentAware setEnvironment

  • 谈谈我对Spring Bean 生命周期的理解

    前言 Spring的ioc容器功能非常强大,负责Spring的Bean的创建和管理等功能.而Spring 的bean是整个Spring应用中很重要的一部分,了解Spring Bean的生命周期对我们了解整个spring框架会有很大的帮助. BeanFactory和ApplicationContext是Spring两种很重要的容器,前者提供了最基本的依赖注入的支持,而后者在继承前者的基础进行了功能的拓展,例如增加了事件传播,资源访问和国际化的消息访问等功能.本文主要介绍了ApplicationCo

  • Spring Bean生命周期源码原理图解

    概述 spring流行了很长时间了,是一个用java编写的轻量级框架,受到了很多公司及程序员的欢迎,Bean生命周期是一个对象从实例化开始到销毁的全过程,了解生命周期是很有必要的. 重要性 spring的生命周期是比较复杂的,只有了解其过程及原理才能更好的扩展程序. 源码剖析生命周期过程bean的实例化 属性填充及Aware接口检测设置依赖 如果容器自定义了BeanpostProcessor的实现类,则执行处理器相应的前置处理 bean实现了初始化接口InitlializingBean,则会执行

随机推荐