Spring源码-xxxAware实现类和BeanPostProcessor接口调用过程

xxxAware实现类作用

以ApplicationContextAware接口为例
ApplicationContextAware的作用是可以方便获取Spring容器ApplicationContext,从而可以获取容器内的Bean


package org.springframework.context;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.Aware;

/**
public interface ApplicationContextAware extends Aware {

	/**
设置该对象运行的ApplicationContext。通常,这个调用将用于初始化对象。
<p>在填充普通bean属性之后调用,但在初始回调之前调用,
例如{@link org.springframework.beans.factory.InitializingBeanafterPropertiesSet()}
或自定义初始化方法。
在{@link ResourceLoaderAwaresetResourceLoader}, 
{@link ApplicationEventPublisherAwaresetApplicationEventPublisher}
和{@link MessageSourceAware}之后调用,如果适用的话。
@param applicationContext这个对象要使用的applicationContext对象
@在context初始化错误的情况下抛出
ApplicationContextException 
@如果被应用程序context方法抛出则抛出BeansException @参见org.springframework.beans.factory.BeanInitializationException
	 */
	void setApplicationContext(ApplicationContext applicationContext) throws BeansException;

}

下面这个例子就是ApplicationContextUtil 实现了ApplicationContextAware 这个接口,重写了setApplicationContext(ApplicationContext applicationContext)方法,在调用到这个方法的时候给类里的applicationContext 属性赋值,后续别的方法在拿到这个applicationContext进行操作,比如根据getBean方法获取Bean对象以及调用beanFactory.registerBeanDefinition(beanName, definition);方法进行添加BeanDefinition即bean的元数据信息。

public class ApplicationContextUtil implements ApplicationContextAware {
 
  private static ApplicationContext applicationContext = null;
 
  @Override
  public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
    if (this.applicationContext == null) {
      this.applicationContext = applicationContext;
    }
  }
  
  //获取applicationContext
  public static ApplicationContext getApplicationContext() {
    return applicationContext;
  }
 
  //通过name获取 Bean.
  public static Object getBean(String name) {
    return getApplicationContext().getBean(name);
  }
 
  //通过class获取Bean.
  public static <T> T getBean(Class<T> clazz) {
    return getApplicationContext().getBean(clazz);
  }
  
  /**
     * 同步方法注册bean到ApplicationContext中
     *
     * @param beanName
     * @param clazz
     * @param original bean的属性值
     */
  public static synchronized void setBean(String beanName, Class<?> clazz, Map<String,Object> original) {
    checkApplicationContext();
    DefaultListableBeanFactory beanFactory = (DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory();
    if(beanFactory.containsBean(beanName)){
      return;
    }
    //BeanDefinition beanDefinition = new RootBeanDefinition(clazz);
    GenericBeanDefinition definition = new GenericBeanDefinition();
    //类class
    definition.setBeanClass(clazz);
    //属性赋值
    definition.setPropertyValues(new MutablePropertyValues(original));
    //注册到spring上下文
    beanFactory.registerBeanDefinition(beanName, definition);
  }
  
}

上述是相关使用,为什么实现这个接口就会调用这个set方法,接下来根据spring源码,讲解xxxAware接口的前世今生。
不重要的步骤给出调用链路

AnnotationConfigApplicationContext## AnnotationConfigApplicationContext(String... basePackages) 构造函数
AbstractApplicationContext##refresh()容器刷新
AbstractApplicationContext##prepareBeanFactory(ConfigurableListableBeanFactory beanFactory)beanFactory的准备工作,对各种属性进行填充

prepareBeanFactory准备工作

protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) {
        // 添加beanPostProcessor,ApplicationContextAwareProcessor此类用来完成某些Aware对象的注入
		beanFactory.addBeanPostProcessor(new ApplicationContextAwareProcessor(this));
		// 设置要忽略自动装配的接口,很多同学理解不了为什么此处要对这些接口进行忽略,原因非常简单,这些接口的实现是由容器通过set方法进行注入的,
		// 所以在使用autowire进行注入的时候需要将这些接口进行忽略
		beanFactory.ignoreDependencyInterface(EnvironmentAware.class);
		beanFactory.ignoreDependencyInterface(EmbeddedValueResolverAware.class);
		beanFactory.ignoreDependencyInterface(ResourceLoaderAware.class);
		beanFactory.ignoreDependencyInterface(ApplicationEventPublisherAware.class);
		beanFactory.ignoreDependencyInterface(MessageSourceAware.class);
		beanFactory.ignoreDependencyInterface(ApplicationContextAware.class);
	}

看下ApplicationContextAwareProcessor这个类:

/**
	 * 接口beanPostProcessor规定的方法,会在bean创建时,实例化后,初始化前,对bean对象应用
	 * @param bean the new bean instance
	 * @param beanName the name of the bean
	 * @return
	 * @throws BeansException
	 */
	@Override
	@Nullable
	public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
		if (!(bean instanceof EnvironmentAware || bean instanceof EmbeddedValueResolverAware ||
				bean instanceof ResourceLoaderAware || bean instanceof ApplicationEventPublisherAware ||
				bean instanceof MessageSourceAware || bean instanceof ApplicationContextAware)){
			return bean;
		}

		AccessControlContext acc = null;

		if (System.getSecurityManager() != null) {
			acc = this.applicationContext.getBeanFactory().getAccessControlContext();
		}

		if (acc != null) {
			AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
				// 检测bean上是否实现了某个aware接口,有的话进行相关的调用
				invokeAwareInterfaces(bean);
				return null;
			}, acc);
		}
		else {
			invokeAwareInterfaces(bean);
		}

		return bean;
	}
	
	

在这个类postProcessBeforeInitialization(Object bean, String beanName)这个方法内部会调用invokeAwareInterfaces(Object bean) 这个方法,判断bean的类型是属于哪一个xxxAware接口然后执行对应的setXXX()方法,至此和前边实现ApplicationContextAware接口重写setApplicationContext()方法串起来了,在哪里调用setApplicationContext方法完成。

/**
	 * 如果某个bean实现了某个aware接口,给指定的bean设置相应的属性值
	 *
	 * @param bean
	 */
	private void invokeAwareInterfaces(Object bean) {
		if (bean instanceof EnvironmentAware) {
			((EnvironmentAware) bean).setEnvironment(this.applicationContext.getEnvironment());
		}
		if (bean instanceof EmbeddedValueResolverAware) {
			((EmbeddedValueResolverAware) bean).setEmbeddedValueResolver(this.embeddedValueResolver);
		}
		if (bean instanceof ResourceLoaderAware) {
			((ResourceLoaderAware) bean).setResourceLoader(this.applicationContext);
		}
		if (bean instanceof ApplicationEventPublisherAware) {
			((ApplicationEventPublisherAware) bean).setApplicationEventPublisher(this.applicationContext);
		}
		if (bean instanceof MessageSourceAware) {
			((MessageSourceAware) bean).setMessageSource(this.applicationContext);
		}
		if (bean instanceof ApplicationContextAware) {
			((ApplicationContextAware) bean).setApplicationContext(this.applicationContext);
		}
	}

还有一个问题,ApplicationContextAwareProcessor这个类的postProcessBeforeInitialization(Object bean, String beanName) 方法什么时候在哪里进行调用呢?这个类实现了BeanPostProcessor这个接口

/**
 * bean的后置处理器接口,在依赖注入的初始化方法前后进行调用
 */
public interface BeanPostProcessor {

	/**
	 * 初始化方法调用前要进行的处理逻辑
	 */
	@Nullable
	default Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
		return bean;
	}

	/**
	 * 在初始化方法指定后要进行的处理逻辑
	 */
	@Nullable
	default Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
		return bean;
	}

}

接下来看实现了BeanPostProcessor 这个接口的实现类在哪里会被触发调用里面的postProcessBeforeInitialization方法!!!!
通过看调用链路,下面是整个过程是在完成实例化,属性填充,执行初始化的时候在initializeBean方法调用 applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName);
在这里插入图片描述
applyBeanPostProcessorsBeforeInitialization细节,对实现BeanPostProcessor 的类进行调用postProcessBeforeInitialization这个方法,这里会调用到ApplicationContextAwareProcessor的postProcessBeforeInitialization方法来对invokeAwareInterfaces实现Aware接口的类进行set操作

	public Object applyBeanPostProcessorsBeforeInitialization(Object existingBean, String beanName)
			throws BeansException {

		//初始化返回结果为existingBean
		Object result = existingBean;
		//遍历 该工厂创建的bean的BeanPostProcessors列表
		for (BeanPostProcessor processor : getBeanPostProcessors()) {
			// postProcessBeforeInitialization:在任何Bean初始化回调之前(如初始化Bean的afterPropertiesSet或自定义的init方法)
			// 将此BeanPostProcessor 应用到给定的新Bean实例。Bean已经填充了属性值。返回的Bean实例可能时原始Bean的包装器。
			// 默认实现按原样返回给定的 Bean
			Object current = processor.postProcessBeforeInitialization(result, beanName);
			// 如果 current为null
			if (current == null) {
				//直接返回result,中断其后续的BeanPostProcessor处理
				return result;
			}
			//让result引用processor的返回结果,使其经过所有BeanPostProcess对象的后置处理的层层包装
			result = current;
		}
		//返回经过所有BeanPostProcess对象的后置处理的层层包装后的result
		return result;
	}

同时,在完成实例化,属性填充,执行初始化的时候在initializeBean方法调用 applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName);将BeanPostProcessors应用到给定的现有Bean实例,调用它们的postProcessAfterInitialization方法。

@Override
	public Object applyBeanPostProcessorsAfterInitialization(Object existingBean, String beanName)
			throws BeansException {

		//初始化结果对象为result,默认引用existingBean
		Object result = existingBean;
		//遍历该工厂创建的bean的BeanPostProcessors列表
		for (BeanPostProcessor processor : getBeanPostProcessors()) {
			//回调BeanPostProcessor#postProcessAfterInitialization来对现有的bean实例进行包装
			Object current = processor.postProcessAfterInitialization(result, beanName);
			//一般processor对不感兴趣的bean会回调直接返回result,使其能继续回调后续的BeanPostProcessor;
			// 但有些processor会返回null来中断其后续的BeanPostProcessor
			// 如果current为null
			if (current == null) {
				//直接返回result,中断其后续的BeanPostProcessor处理
				return result;
			}
			//让result引用processor的返回结果,使其经过所有BeanPostProcess对象的后置处理的层层包装
			result = current;
		}
		//返回经过所有BeanPostProcess对象的后置处理的层层包装后的result
		return result;
	}

至此,BeanPostProcessor接口的调用以及实现xxxAware的类的调用使用处理过程讲解结束

    初始化方法调用前要进行的处理逻辑
    default Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
		return bean;
	}
	在初始化方法指定后要进行的处理逻辑
	default Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
		return bean;
	}
  • 8
    点赞
  • 30
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: BeanPostProcessorSpring框架中的一个接口,它允许开发人员在bean实例化和依赖注入之后对bean进行自定义处理。BeanPostProcessor接口有两个方法:postProcessBeforeInitialization和postProcessAfterInitialization。这两个方法分别在bean实例化之后和依赖注入之后被调用BeanPostProcessor源码解析可以从以下几个方面入手: 1. BeanPostProcessor实现 Spring框架中有很多实现BeanPostProcessor接口,比如AutowiredAnnotationBeanPostProcessor、CommonAnnotationBeanPostProcessor等。这些都是用来处理bean的,可以通过查看它们的源码来了解BeanPostProcessor的具体实现。 2. postProcessBeforeInitialization方法 postProcessBeforeInitialization方法在bean实例化之后、依赖注入之前被调用。这个方法可以用来修改bean的属性或者执行一些初始化操作。在源码中可以看到,postProcessBeforeInitialization方法的实现似于以下代码: public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { // 执行一些初始化操作 return bean; } 3. postProcessAfterInitialization方法 postProcessAfterInitialization方法在bean实例化和依赖注入之后被调用。这个方法可以用来对bean进行一些后处理操作。在源码中可以看到,postProcessAfterInitialization方法的实现似于以下代码: public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { // 对bean进行一些后处理操作 return bean; } 4. BeanPostProcessor的执行顺序 在Spring框架中,BeanPostProcessor的执行顺序是固定的。首先会执行所有实现了PriorityOrdered接口BeanPostProcessorpostProcessBeforeInitialization方法,然后执行所有实现了Ordered接口BeanPostProcessorpostProcessBeforeInitialization方法,最后执行所有其他的BeanPostProcessorpostProcessBeforeInitialization方法。在执行postProcessAfterInitialization方法时,执行顺序与执行postProcessBeforeInitialization方法时相同。 总之,BeanPostProcessorSpring框架中非常重要的一个接口,它允许开发人员对bean进行自定义处理。通过对BeanPostProcessor源码的分析,我们可以更好地理解它的实现原理和使用方法。 ### 回答2: BeanPostProcessorSpring框架的一个非常重要的组件。它可以在Bean的创建周期中对Bean进行一些处理,它提供了在初始化Bean之前和之后执行自定义逻辑的机会。本文将深入剖析BeanPostProcessor源码实现及其作用。 1. BeanPostProcessor接口BeanPostProcessor是一个接口,定义了两个方法: (1)postProcessBeforeInitialization(Object bean, String beanName): 在初始化之前对Bean做一些操作。 (2)postProcessAfterInitialization(Object bean, String beanName): 在初始化之后对Bean做一些操作。 2. BeanPostProcessor源码实现: 它是一个接口BeanPostProcessor是一个在SpringBean加载过程中非常重要的组件,它主要负责Bean的实例化、属性赋值和初始化过程中提供额外的自定义处理逻辑。 BeanPostProcessor接口的定义如下: public interface BeanPostProcessor { Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException; Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException; } 在Spring IoC容器中,BeanPostProcessor的主要作用是在Bean实例化、属性赋值和初始化过程中提供额外的自定义处理逻辑。在创建Bean实例之后,Spring容器会遍历所有注册的BeanPostProcessor调用它们的postProcessBeforeInitialization和postProcessAfterInitialization方法。 3. BeanPostProcessor的应用: (1)扩展Bean生命周期: 可以通过实现BeanPostProcessor接口来自定义对一个或者所有的Bean的初始化过程,可以在初始化之前或之后执行额外的逻辑。 (2)实现依赖注入: 可以通过实现BeanPostProcessor接口,来实现依赖注入。例如可以通过注解的方式,来实现自动为所有Bean中标注了特定注解的属性注入值。 (3)实现AOP: 可以通过Spring的AOP机制来实现AOP,而BeanPostProcessor实现AOP的重要底层组件之一。 总之,BeanPostProcessorSpring框架中非常重要的一个组件,它提供了对Bean创建周期中的两个关键事件——初始化之前和初始化之后进行处理的机会。使用BeanPostProcessor可以实现很多功能,如扩展Bean的生命周期、实现依赖注入、实现AOP等,对于自定义框架和组件开发来说,非常有用。 ### 回答3: BeanPostProcessorSpring 框架中的一个扩展点,它允许我们在一个 bean 被实例化时或者在 bean 的初始化过程中修改 bean 的一些属性或者执行一些操作。本文将在源码层面上对 BeanPostProcessor 进行详细解析。 首先,我们需要了解 BeanPostProcessor 接口的定义: ```java public interface BeanPostProcessor { /** * 在 bean 的初始化之前执行,返回一个代理对象用来替换原始的 bean 对象。 * 在 Spring 内部,Spring 会在这个方法被调用时对当前 bean 对象进行代理, * 然后交给后续的 bean 处理流程处理。 * * @param bean 待初始化的 bean 对象 * @param beanName 当前 bean 对象的名称 * @return 可以替代原始 bean 对象的代理对象 * @throws BeansException 如果出现任何异常,将导致 bean 的初始化过程被中断。 */ @Nullable default Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { return bean; } /** * 在 bean 的初始化之后执行。这个方法在最终返回 bean 对象之前调用, * 因此在这里面进行的任何操作都可以生效,包括修改 bean 对象的属性值等等。 * * @param bean 待初始化的 bean 对象 * @param beanName 当前 bean 对象的名称 * @return 可以替代原始 bean 对象的代理对象 * @throws BeansException 如果出现任何异常,将导致 bean 的初始化过程被中断。 */ @Nullable default Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { return bean; } } ``` 可以看到,BeanPostProcessor 接口中只定义了两个方法,分别在 bean 实例化前后执行。这两个方法都有一个相同的传参,即需要处理的 bean 和这个 bean 的名称。 然后我们看看 Spring 框架是如何调用 BeanPostProcessor实现的。在 AbstractAutowireCapableBeanFactory 中,有一个名为 applyBeanPostProcessorsAfterInitialization 的方法: ```java protected Object applyBeanPostProcessorsAfterInitialization(Object existingBean, String beanName) throws BeansException { Object result = existingBean; // 遍历所有的 BeanPostProcessor 实现,依次执行 postProcessAfterInitialization 方法 for (BeanPostProcessor processor : getBeanPostProcessors()) { Object current = processor.postProcessAfterInitialization(result, beanName); if (current == null) { return result; } result = current; } return result; } ``` 在这个方法中,Spring 会遍历所有的 BeanPostProcessor 实现,依次调用 postProcessAfterInitialization 方法,返回代理对象。如果最终的代理对象返回 null,那么就会返回原始 bean 对象。这样保证了 BeanPostProcessor 的后续执行不会受到任何异常的干扰。 在 AbstractAutowireCapableBeanFactory 中还有一个方法 applyBeanPostProcessorsBeforeInitialization,其代码结构与 applyBeanPostProcessorsAfterInitialization 似,不再赘述。 除了上述方法,AbstractAutowireCapableBeanFactory 还有一个名为 getBeanPostProcessors 的方法。这个方法返回 Spring 容器内所有的 BeanPostProcessor 实现,它们会依次被调用。 ```java protected List<BeanPostProcessor> getBeanPostProcessors() { List<BeanPostProcessor> processors = new ArrayList<>(); // 往集合里添加 BeanPostProcessor 实现 processors.addAll(beanFactory.getBeansOfType(BeanPostProcessor.class, true, false).values()); // 往集合里添加 SmartInstantiationAwareBeanPostProcessor 实现 processors.addAll(beanFactory.getBeansOfType(SmartInstantiationAwareBeanPostProcessor.class, true, false).values()); return processors; } ``` 可以看到,getBeanPostProcessors 方法主要作用是将 Spring 容器内所有的 BeanPostProcessor 实现添加到一个 List 集合里,并返回这个集合。 至此,我们从源码层面上对 BeanPostProcessor 接口进行了详细的解析。相信读完这篇文档,你对 BeanPostProcessor 接口的作用以及 Spring 框架是如何使用它进行初始化 bean 过程中的各种扩展操作有了更深层次的理解。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值