InitializingBean源码分析

master
xuchengsheng 2023-09-22 11:43:09 +08:00
parent abb21ac844
commit 0ac9e40845
7 changed files with 562 additions and 0 deletions

View File

@ -14,3 +14,5 @@
+ [关于MergedBeanDefinitionPostProcessor源码分析](spring-interface-mergedBeanDefinitionPostProcessor/README.md)
+ [关于SmartInstantiationAwareBeanPostProcessor源码分析](spring-interface-smartInstantiationAwareBeanPostProcessor/README.md)
+ [关于InitializingBean源码分析](spring-interface-initializingBean/README.md)

View File

@ -37,6 +37,7 @@
<module>spring-interface-destructionAwareBeanPostProcessor</module>
<module>spring-interface-mergedBeanDefinitionPostProcessor</module>
<module>spring-interface-smartInstantiationAwareBeanPostProcessor</module>
<module>spring-interface-initializingBean</module>
</modules>
<dependencies>

View File

@ -0,0 +1,484 @@
## InitializingBean
- [InitializingBean](#initializingbean)
- [一、接口描述](#一接口描述)
- [二、接口源码](#二接口源码)
- [三、主要功能](#三主要功能)
- [四、最佳实践](#四最佳实践)
- [五、时序图](#五时序图)
- [六、源码分析](#六源码分析)
- [七、注意事项](#七注意事项)
- [八、总结](#八总结)
- [8.1、最佳实践总结](#81最佳实践总结)
- [8.2、源码分析总结](#82源码分析总结)
### 一、接口描述
`InitializingBean` 接口,主要用于在 bean 的所有属性被初始化后,但在 bean 被实际使用之前,执行某些初始化逻辑或设置。
### 二、接口源码
`InitializingBean` 接口,实现此接口的 beans 会在所有属性都设置完毕后,由 `BeanFactory` 调用其 `afterPropertiesSet()` 方法。
```java
/**
* 接口定义,用于需要在其所有属性被 BeanFactory 设置后执行操作的 beans。
* 例如,可以执行自定义初始化或检查所有必需属性是否已设置。
*
* 实现此接口的 beans 会在所有属性都设置完毕后,由 BeanFactory 调用其 `afterPropertiesSet()` 方法。
*
* @author Rod Johnson
* @author Juergen Hoeller
* @see DisposableBean // 当 bean 不再需要时,用于回调的接口
* @see org.springframework.beans.factory.config.BeanDefinition#getPropertyValues()
* @see org.springframework.beans.factory.support.AbstractBeanDefinition#getInitMethodName()
*/
public interface InitializingBean {
/**
* 当 BeanFactory 设置了 bean 的所有属性后调用此方法。
* 也即满足了 BeanFactoryAware, ApplicationContextAware 等条件后。
*
* 此方法让 bean 实例可以在所有属性都设置后进行最终的配置验证和初始化。
* 如果出现配置错误(如未设置必需的属性)或因其他原因初始化失败,此方法可能会抛出异常。
*
* @throws Exception 配置错误或其他任何初始化失败原因导致的异常
*/
void afterPropertiesSet() throws Exception;
}
```
### 三、主要功能
**初始化回调**`InitializingBean` 接口为 Spring 容器提供了一个机制,以确保在 bean 的所有属性都被设置后,但在 bean 被其他组件使用之前,可以执行某些初始化逻辑或操作。
**属性验证**:在 `afterPropertiesSet` 方法中,开发者可以验证 bean 的属性是否都已正确设置,特别是一些必要的属性。
**自定义初始化逻辑**:如果 bean 需要进行特定的初始化操作,如开启资源、连接数据库、启动某些线程或其他任何初始化活动,那么这些操作可以在 `afterPropertiesSet` 方法中进行。
**生命周期管理**`InitializingBean` 是 Spring 生命周期中的一个关键点,它在属性注入 (`Property Injection`) 之后和使用 bean 之前被调用。这提供了一个干净的生命周期钩子,可以用来确保 bean 在被使用之前是完全准备好的。
### 四、最佳实践
首先来看看启动类入口,上下文环境使用`AnnotationConfigApplicationContext`此类是使用Java注解来配置Spring容器的方式构造参数我们给定了一个`MyConfiguration`组件类。
```java
public class InitializingBeanApplication {
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfiguration.class);
}
}
```
这里使用`@Bean`注解定义了一个Bean是为了确保 `MyInitializingBean` 被 Spring 容器执行
```java
@Configuration
public class MyConfiguration {
@Bean
public static MyInitializingBean myInitializingBean(){
return new MyInitializingBean();
}
}
```
`afterPropertiesSet()` 方法中,模拟了数据加载的过程。
```java
public class MyInitializingBean implements InitializingBean {
private List<String> data;
public List<String> getData() {
return data;
}
@Override
public void afterPropertiesSet() {
// 在此方法中,我们模拟数据加载
data = new ArrayList<>();
data.add("数据1");
data.add("数据2");
data.add("数据3");
System.out.println("MyInitializingBean 初始化完毕,数据已加载!");
}
}
```
运行结果发现,我们会在控制台上看到 "`MyInitializingBean 初始化完毕,数据已加载!`" 这样的输出,表示数据已经被加载到 `data` 列表中。
```java
MyInitializingBean 初始化完毕,数据已加载!
```
### 五、时序图
~~~mermaid
sequenceDiagram
Title: InitializingBean时序图
participant InitializingBeanApplication
participant AnnotationConfigApplicationContext
participant AbstractApplicationContext
participant DefaultListableBeanFactory
participant AbstractBeanFactory
participant DefaultSingletonBeanRegistry
participant AbstractAutowireCapableBeanFactory
participant MyInitializingBean
InitializingBeanApplication->>AnnotationConfigApplicationContext:AnnotationConfigApplicationContext(componentClasses)<br>创建上下文
AnnotationConfigApplicationContext->>AbstractApplicationContext:refresh()<br>刷新上下文
AbstractApplicationContext->>AbstractApplicationContext:finishBeanFactoryInitialization(beanFactory)<br>初始化Bean工厂
AbstractApplicationContext->>DefaultListableBeanFactory:preInstantiateSingletons()<br>实例化单例
DefaultListableBeanFactory->>AbstractBeanFactory:getBean(name)<br>获取Bean
AbstractBeanFactory->>AbstractBeanFactory:doGetBean(name,requiredType,args,typeCheckOnly)<br>执行获取Bean
AbstractBeanFactory->>DefaultSingletonBeanRegistry:getSingleton(beanName,singletonFactory)<br>获取单例Bean
DefaultSingletonBeanRegistry-->>AbstractBeanFactory:getObject()<br>获取Bean实例
AbstractBeanFactory->>AbstractAutowireCapableBeanFactory:createBean(beanName,mbd,args)<br>创建Bean
AbstractAutowireCapableBeanFactory->>AbstractAutowireCapableBeanFactory:doCreateBean(beanName,mbd,args)<br>执行Bean创建
AbstractAutowireCapableBeanFactory->>AbstractAutowireCapableBeanFactory:initializeBean(beanName,bean,mbd)<br>负责bean的初始化
AbstractAutowireCapableBeanFactory->>AbstractAutowireCapableBeanFactory:invokeInitMethods(beanName,bean,mbd)<br>调用bean的初始化方法
AbstractAutowireCapableBeanFactory->>MyInitializingBean:afterPropertiesSet()<br>执行InitializingBean接口的方法
AbstractAutowireCapableBeanFactory-->>AbstractBeanFactory:返回Bean对象
AbstractBeanFactory-->>DefaultListableBeanFactory:返回Bean对象
AnnotationConfigApplicationContext-->>InitializingBeanApplication:初始化完成
~~~
### 六、源码分析
```java
public class InitializingBeanApplication {
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfiguration.class);
}
}
```
首先我们来看看源码中的,构造函数中,执行了三个步骤,我们重点关注`refresh()`方法
```java
public AnnotationConfigApplicationContext(Class<?>... componentClasses) {
this();
register(componentClasses);
refresh();
}
```
`org.springframework.context.support.AbstractApplicationContext#refresh`方法中我们重点关注一下`finishBeanFactoryInitialization(beanFactory)`这方法,其他方法不是本次源码阅读的重点暂时忽略,在`finishBeanFactoryInitialization(beanFactory)`方法会对实例化所有剩余非懒加载的单列Bean对象。
```java
@Override
public void refresh() throws BeansException, IllegalStateException {
// ... [代码部分省略以简化]
// Instantiate all remaining (non-lazy-init) singletons.
finishBeanFactoryInitialization(beanFactory);
// ... [代码部分省略以简化]
}
```
在`org.springframework.beans.factory.support.DefaultListableBeanFactory#preInstantiateSingletons`方法中主要的核心目的是预先实例化所有非懒加载的单例bean。在Spring的上下文初始化完成后该方法会被触发以确保所有单例bean都被正确地创建并初始化。其中`getBean(beanName)`是此方法的核心操作。对于容器中定义的每一个单例bean它都会调用`getBean`方法这将触发bean的实例化、初始化及其依赖的注入。如果bean之前没有被创建过那么这个调用会导致其被实例化和初始化。
```java
public void preInstantiateSingletons() throws BeansException {
// ... [代码部分省略以简化]
// 循环遍历所有bean的名称
for (String beanName : beanNames) {
// 获取合并后的bean定义这包括了从父容器继承的属性
RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
// 检查bean是否不是抽象的、是否是单例的以及是否不是懒加载的
if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
// 判断当前bean是否是一个FactoryBean
if (isFactoryBean(beanName)) {
// 获取FactoryBean实例
Object bean = getBean(FACTORY_BEAN_PREFIX + beanName);
// 如果bean确实是FactoryBean的实例
if (bean instanceof FactoryBean) {
FactoryBean<?> factory = (FactoryBean<?>) bean;
boolean isEagerInit;
// 判断当前环境是否有安全管理器并且工厂bean是否是SmartFactoryBean的实例
if (System.getSecurityManager() != null && factory instanceof SmartFactoryBean) {
// 使用AccessController确保在受限制的环境中安全地调用isEagerInit方法
isEagerInit = AccessController.doPrivileged(
(PrivilegedAction<Boolean>) ((SmartFactoryBean<?>) factory)::isEagerInit,
getAccessControlContext());
}
else {
// 检查FactoryBean是否是SmartFactoryBean并且是否需要立即初始化
isEagerInit = (factory instanceof SmartFactoryBean &&
((SmartFactoryBean<?>) factory).isEagerInit());
}
// 如果工厂bean需要立即初始化则获取bean实例这将触发bean的创建
if (isEagerInit) {
getBean(beanName);
}
}
}
// 如果不是FactoryBean则直接获取bean实例这将触发bean的创建
else {
getBean(beanName);
}
}
}
// ... [代码部分省略以简化]
}
```
在`org.springframework.beans.factory.support.AbstractBeanFactory#getBean()`方法中,又调用了`doGetBean`方法来实际执行创建Bean的过程传递给它bean的名称和一些其他默认的参数值。此处`doGetBean`负责大部分工作如查找bean定义、创建bean如果尚未创建、处理依赖关系等。
```java
@Override
public Object getBean(String name) throws BeansException {
return doGetBean(name, null, null, false);
}
```
在`org.springframework.beans.factory.support.AbstractBeanFactory#doGetBean`方法中首先检查所请求的bean是否是一个单例并且已经创建。如果尚未创建它将创建一个新的实例。在这个过程中它处理可能的异常情况如循环引用并确保返回的bean是正确的类型。这是Spring容器bean生命周期管理的核心部分。
```java
protected <T> T doGetBean(
String name, @Nullable Class<T> requiredType, @Nullable Object[] args, boolean typeCheckOnly)
throws BeansException {
// ... [代码部分省略以简化]
// 开始创建bean实例
if (mbd.isSingleton()) {
// 如果bean是单例的我们会尝试从单例缓存中获取它
// 如果不存在则使用lambda创建一个新的实例
sharedInstance = getSingleton(beanName, () -> {
try {
// 尝试创建bean实例
return createBean(beanName, mbd, args);
}
catch (BeansException ex) {
// 如果在创建bean过程中出现异常从单例缓存中移除它
// 这样做是为了防止循环引用的情况
destroySingleton(beanName);
throw ex;
}
});
// 对于某些bean例如FactoryBeans可能需要进一步处理以获取真正的bean实例
beanInstance = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}
// ... [代码部分省略以简化]
// 确保返回的bean实例与请求的类型匹配
return adaptBeanInstance(name, beanInstance, requiredType);
}
```
在`org.springframework.beans.factory.support.DefaultSingletonBeanRegistry#getSingleton()`方法中主要负责从单例缓存中获取一个已存在的bean实例或者使用提供的`ObjectFactory`创建一个新的实例。这是确保bean在Spring容器中作为单例存在的关键部分。
```java
public Object getSingleton(String beanName, ObjectFactory<?> singletonFactory) {
// 断言bean名称不能为空
Assert.notNull(beanName, "Bean name must not be null");
// 同步访问单例对象缓存,确保线程安全
synchronized (this.singletonObjects) {
// 从缓存中获取单例对象
Object singletonObject = this.singletonObjects.get(beanName);
// 如果缓存中没有找到
if (singletonObject == null) {
// ... [代码部分省略以简化]
// 在创建单例之前执行某些操作,如记录创建状态
beforeSingletonCreation(beanName);
boolean newSingleton = false;
boolean recordSuppressedExceptions = (this.suppressedExceptions == null);
if (recordSuppressedExceptions) {
this.suppressedExceptions = new LinkedHashSet<>();
}
try {
// 使用工厂创建新的单例实例
singletonObject = singletonFactory.getObject();
newSingleton = true;
}
catch (IllegalStateException ex) {
// ... [代码部分省略以简化]
}
catch (BeanCreationException ex) {
// ... [代码部分省略以简化]
}
finally {
// ... [代码部分省略以简化]
}
// 如果成功创建了新的单例,将其加入缓存
if (newSingleton) {
addSingleton(beanName, singletonObject);
}
}
// 返回单例对象
return singletonObject;
}
}
```
在`org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#createBean()`方法中,主要的逻辑是调用 `doCreateBean`,这是真正进行 bean 实例化、属性填充和初始化的地方。这个方法会返回新创建的 bean 实例。
```java
@Override
protected Object createBean(String beanName, RootBeanDefinition mbd, @Nullable Object[] args)
throws BeanCreationException {
// ... [代码部分省略以简化]
try {
// 正常的bean实例化、属性注入和初始化。
// 这里是真正进行bean创建的部分。
Object beanInstance = doCreateBean(beanName, mbdToUse, args);
// 记录bean成功创建的日志
if (logger.isTraceEnabled()) {
logger.trace("Finished creating instance of bean '" + beanName + "'");
}
return beanInstance;
}
catch (BeanCreationException | ImplicitlyAppearedSingletonException ex) {
// ... [代码部分省略以简化]
}
catch (Throwable ex) {
// ... [代码部分省略以简化]
}
}
```
在`org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#doCreateBean`方法中,`initializeBean`方法是bean初始化确保bean是完全配置和准备好的。
```java
protected Object doCreateBean(String beanName, RootBeanDefinition mbd, @Nullable Object[] args)
throws BeanCreationException {
// 声明一个对象后续可能用于存放初始化后的bean或它的代理对象
Object exposedObject = bean;
try {
// bean初始化
exposedObject = initializeBean(beanName, exposedObject, mbd);
}
catch (Throwable ex) {
// ... [代码部分省略以简化]
}
// 返回创建和初始化后的bean
return exposedObject;
}
```
在`org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#initializeBean`方法中,调用 bean 的初始化方法,`afterPropertiesSet`
```java
protected Object initializeBean(String beanName, Object bean, @Nullable RootBeanDefinition mbd) {
try {
invokeInitMethods(beanName, wrappedBean, mbd);
}
catch (Throwable ex) {
// ... [代码部分省略以简化]
}
return wrappedBean;
}
```
在`org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#invokeInitMethods`方法中,首先检查 bean 是否实现了 `InitializingBean` 接口。如果是,则进一步检查 `afterPropertiesSet` 方法是否被外部管理。如果不是,则调用该方法。这是 Spring bean 生命周期中的一个关键步骤,确保在 bean 被应用程序其他部分使用之前,它已经正确初始化。
```java
protected void invokeInitMethods(String beanName, Object bean, @Nullable RootBeanDefinition mbd)
throws Throwable {
boolean isInitializingBean = (bean instanceof InitializingBean);
if (isInitializingBean && (mbd == null || !mbd.isExternallyManagedInitMethod("afterPropertiesSet"))) {
if (logger.isTraceEnabled()) {
logger.trace("Invoking afterPropertiesSet() on bean with name '" + beanName + "'");
}
if (System.getSecurityManager() != null) {
// ... [代码部分省略以简化]
}
else {
((InitializingBean) bean).afterPropertiesSet();
}
}
// ... [代码部分省略以简化]
}
```
最后执行到我们自定义的逻辑中,模拟了数据加载的过程。
```java
public class MyInitializingBean implements InitializingBean {
private List<String> data;
public List<String> getData() {
return data;
}
@Override
public void afterPropertiesSet() {
// 在此方法中,我们模拟数据加载
data = new ArrayList<>();
data.add("数据1");
data.add("数据2");
data.add("数据3");
System.out.println("MyInitializingBean 初始化完毕,数据已加载!");
}
}
```
### 七、注意事项
**使用 @PostConstruct**: 尽管 `InitializingBean` 提供了一个初始化 bean 的方式,但现代的 Spring 开发者更倾向于使用 `@PostConstruct` 注解,因为它是 JSR-250 的一部分,不依赖于 Spring 特定的接口。
**避免业务逻辑**: 在 `afterPropertiesSet` 方法中,应该只包含与初始化相关的逻辑。避免将核心的业务逻辑放在这里。
**处理异常**: `afterPropertiesSet` 方法允许抛出异常。确保你处理了可能出现的所有异常,特别是可能阻止 bean 正确初始化的那些。
**明确的初始化顺序**: 请记住,`afterPropertiesSet` 是在所有属性都设置之后调用的,但在任何自定义的 init 方法和 `@PostConstruct` 方法之前。
**不要过于依赖**: 尽量避免让太多的 beans 实现 `InitializingBean`,因为这可能会使代码难以阅读和管理。如果可能,考虑使用其他的初始化方法。如 `@PostConstruct` 注解。
### 八、总结
#### 8.1、最佳实践总结
**启动类**: 在 `InitializingBeanApplication` 类中,我们使用 `AnnotationConfigApplicationContext` 为上下文环境。这种上下文环境使用 Java 注解来配置 Spring 容器,而不是传统的 XML。通过传递 `MyConfiguration` 类作为构造参数,我们告诉 Spring 在哪里找到 bean 的定义。
**配置类**: `MyConfiguration` 类使用 `@Configuration` 注解,标识它为一个 Spring 配置类。在该类中,我们定义了一个名为 `myInitializingBean` 的 bean它返回一个新的 `MyInitializingBean` 实例。这样,我们确保 `MyInitializingBean` 类将由 Spring 容器管理,并且其生命周期方法(如 `afterPropertiesSet()`)会被调用。
**初始化逻辑**: `MyInitializingBean` 类实现了 `InitializingBean` 接口,并重写了其 `afterPropertiesSet()` 方法。在这个方法中,我们模拟了数据加载的过程,简单地向 `data` 列表中添加了三条字符串数据。当 Spring 容器初始化这个 bean 时,它会自动调用 `afterPropertiesSet()` 方法,从而执行这个初始化逻辑。
**运行结果**: 当我们运行应用程序时,由于 `MyInitializingBean` 已经被 Spring 容器管理并初始化,`afterPropertiesSet()` 方法被调用,因此我们会在控制台上看到 "`MyInitializingBean 初始化完毕,数据已加载!`" 的输出。
#### 8.2、源码分析总结
**启动上下文**:使用 `AnnotationConfigApplicationContext` 以 Java 注解方式启动 Spring 上下文,传入 `MyConfiguration` 配置类为参数,此时 Spring 容器启动并初始化。
**构造函数中的重点**`AnnotationConfigApplicationContext` 的构造函数执行了 `register``refresh` 方法,其中 `refresh` 是我们关注的核心。
**刷新上下文**:在 `refresh` 方法中Spring 上下文开始其核心的刷新过程,重点是 `finishBeanFactoryInitialization`,它确保实例化所有剩余的非懒加载的单例 Bean。
**预实例化单例 Beans**:方法 `preInstantiateSingletons` 负责预先实例化所有非懒加载的单例 bean。这意味着在 Spring 上下文初始化完成后,所有的单例 beans 都会被实例化,初始化,并注入所需的依赖。
**获取 Bean**:核心方法 `getBean``doGetBean` 负责从容器中检索 bean。如果 bean 尚未创建,这些方法还会负责 bean 的创建、属性注入和初始化。
**单例注册**`getSingleton` 方法在 `DefaultSingletonBeanRegistry` 中确保 bean 作为单例存在。如果 bean 未在缓存中找到,它会使用提供的 `ObjectFactory` 创建一个新的实例。
**创建 Bean**`createBean` 和 `doCreateBean` 方法负责实际的 bean 创建过程,其中包括实例化、属性注入和初始化。
**初始化 Bean**:方法 `initializeBean` 负责 bean 的初始化,调用其初始化方法。这包括 `InitializingBean` 接口的 `afterPropertiesSet` 方法。
**初始化方法调用**`invokeInitMethods` 方法会检查 bean 是否实现了 `InitializingBean` 接口。如果实现了,并且 `afterPropertiesSet` 方法不是外部管理的,那么它会被调用。
**自定义初始化逻辑**:我们自定义的 `MyInitializingBean` 类实现了 `InitializingBean` 接口,并重写了 `afterPropertiesSet` 方法来模拟数据加载的过程。

View File

@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>spring-reading</artifactId>
<groupId>com.xcs.spring</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>spring-interface-initializingBean</artifactId>
</project>

View File

@ -0,0 +1,15 @@
package com.xcs.spring;
import com.xcs.spring.config.MyConfiguration;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
/**
* @author xcs
* @date 20230916 1609
**/
public class InitializingBeanApplication {
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfiguration.class);
}
}

View File

@ -0,0 +1,17 @@
package com.xcs.spring.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* @author xcs
* @date 20230919 1635
**/
@Configuration
public class MyConfiguration {
@Bean
public static MyInitializingBean myInitializingBean(){
return new MyInitializingBean();
}
}

View File

@ -0,0 +1,29 @@
package com.xcs.spring.config;
import org.springframework.beans.factory.InitializingBean;
import java.util.ArrayList;
import java.util.List;
/**
* @author xcs
* @date 20230919 1642
**/
public class MyInitializingBean implements InitializingBean {
private List<String> data;
public List<String> getData() {
return data;
}
@Override
public void afterPropertiesSet() {
// 在此方法中,我们模拟数据加载
data = new ArrayList<>();
data.add("数据1");
data.add("数据2");
data.add("数据3");
System.out.println("MyInitializingBean 初始化完毕,数据已加载!");
}
}