Spring实现ApplicationContextAware原理分析

Spring实现ApplicationContextAware、ResourceLoaderAware等原理分析

本文以SpringFramework5.0 为例，分析ApplicationContextAware、ResourceLoaderAware等接口自动注入ApplicationContext、ResourceLoader原理。本文先给出结论：ApplicationContextAwareProcessor类是实现注入ApplicationContext、ResourceLoader等的关键类
本文先提出一下问题:

• 问题1：ApplicationContext、ResourceLoader 注入时机，是在bean初始化之前，初始化之后?
• 问题2：如果一个class 类实现ApplicationContextAware、ResourceLoaderAware等接口，ApplicationContext、ResourceLoader注入的顺序是什么样子的?
  大家可以先尝试的问题上面的问题，我也会在原理分析的给出解答

原理分析

SpringFramework 在创建bean的时候，会提供各种Bean生命周期，比如@PreDestroy 销毁阶段,@PostConstruct 初始化阶段,ApplicationContextAware等Aware接口的注入就是利用了BeanPostProcessor来实现ApplicationContext的注入。关于bean生命周期可以参考

ApplicationContextAwareProcessor类

class ApplicationContextAwareProcessor implements BeanPostProcessor {

	private final ConfigurableApplicationContext applicationContext;

	private final StringValueResolver embeddedValueResolver;


	/**
	 * Create a new ApplicationContextAwareProcessor for the given context.
	 */
	public ApplicationContextAwareProcessor(ConfigurableApplicationContext applicationContext) {
		this.applicationContext = applicationContext;
		this.embeddedValueResolver = new EmbeddedValueResolver(applicationContext.getBeanFactory());
	}


	@Override
	@Nullable
	//解答问题1--初始化前阶段注入
	public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
	//判断是否实现相关Aware接口
		if (!(bean instanceof EnvironmentAware || bean instanceof EmbeddedValueResolverAware ||
				bean instanceof ResourceLoaderAware || bean instanceof ApplicationEventPublisherAware ||
				bean instanceof MessageSourceAware || bean instanceof ApplicationContextAware)){
			return bean;
		}

		AccessControlContext acc = null;
		//java 安全相关
		if (System.getSecurityManager() != null) {
			acc = this.applicationContext.getBeanFactory().getAccessControlContext();
		}
		//判断是有权限访问
		if (acc != null) {
			AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
				invokeAwareInterfaces(bean);
				return null;
			}, acc);
		}
		else {
			invokeAwareInterfaces(bean);
		}

		return bean;
	}
	//解答问题2：EnvironmentAware 》 EmbeddedValueResolverAware 》 ResourceLoaderAware 》 MessageSourceAware 》 ApplicationContextAware
	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 加入到IOC容器时机和调用时机

• 加入到IOC容器时机 org.springframework.context.support.AbstractApplicationContext#prepareBeanFactory

	protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) {
		// Tell the internal bean factory to use the context's class loader etc.
		beanFactory.setBeanClassLoader(getClassLoader());
		beanFactory.setBeanExpressionResolver(new StandardBeanExpressionResolver(beanFactory.getBeanClassLoader()));
		beanFactory.addPropertyEditorRegistrar(new ResourceEditorRegistrar(this, getEnvironment()));

		// Configure the bean factory with context callbacks.
		添加ApplicationContextAwareProcessor到ioc容器中
		beanFactory.addBeanPostProcessor(new ApplicationContextAwareProcessor(this));
		
		beanFactory.ignoreDependencyInterface(EnvironmentAware.class);
		beanFactory.ignoreDependencyInterface(EmbeddedValueResolverAware.class);
		beanFactory.ignoreDependencyInterface(ResourceLoaderAware.class);
		beanFactory.ignoreDependencyInterface(ApplicationEventPublisherAware.class);
		beanFactory.ignoreDependencyInterface(MessageSourceAware.class);
		beanFactory.ignoreDependencyInterface(ApplicationContextAware.class);

		.......
	}

• 调用时机
  org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#createBean(java.lang.String, org.springframework.beans.factory.support.RootBeanDefinition, java.lang.Object[])方法里面的
  Object bean = resolveBeforeInstantiation(beanName, mbdToUse);

	protected Object resolveBeforeInstantiation(String beanName, RootBeanDefinition mbd) {
		Object bean = null;
		if (!Boolean.FALSE.equals(mbd.beforeInstantiationResolved)) {
			// Make sure bean class is actually resolved at this point.
			if (!mbd.isSynthetic() && hasInstantiationAwareBeanPostProcessors()) {
				Class<?> targetType = determineTargetType(beanName, mbd);
				if (targetType != null) {
					bean = applyBeanPostProcessorsBeforeInstantiation(targetType, beanName);
					if (bean != null) {
						bean = applyBeanPostProcessorsAfterInitialization(bean, beanName);
					}
				}
			}
			mbd.beforeInstantiationResolved = (bean != null);
		}
		return bean;
	}