ApplicationContextAware 的 setApplicationContext() 方法执行逻辑全解析

男儿欲遂平生志,五经勤向窗前读。这篇文章主要讲述ApplicationContextAware 的 setApplicationContext() 方法执行逻辑全解析相关的知识,希望能为你提供帮助。
基本结论


实现了ApplicationContextAware接口的类会被调用 setApplicationContext() 方法,从而获取到 Spring容器的上下文。

【ApplicationContextAware 的 setApplicationContext() 方法执行逻辑全解析】org.springframework.context.ApplicationContextAware#setApplicationContext
接口定义:
public interface ApplicationContextAware extends Aware
  void setApplicationContext(ApplicationContext applicationContext)throws BeansException;

Spring Bean 初始化流程:
1、  Spring 先检查注解注入的bean,并将它们实例化
2、  然后spring初始化bean的顺序是按照xml中配置的顺序依次执行构造
3、  如果某个类实现了ApplicationContextAware接口,会在类初始化完成后调用setApplicationContext()方法:
4、  如果某个类实现了InitializingBean接口,会在类初始化完成后,并在setApplicationContext()方法执行完毕后,调用afterPropertiesSet()方法进行操作
setApplicationContext方法调用过程1.当我们启动spring容器的时候,我们执行到refresh()方法。



2.进入prepareBeanFactory(beanFactory);



在BeanFactory里面加入了一个 ApplicationContextAwareProcessor。
3、refresh()方法继续往下执行,执行到实例化bean的方法
// Instantiate all remaining (non-lazy-init) singletons.
finishBeanFactoryInitialization(beanFactory);
代码执行到这个方法。
protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory)
...
// Stop using the temporary ClassLoader for type matching.
beanFactory.setTempClassLoader(null);
// Allow for caching all bean definition metadata, not expecting further changes.
beanFactory.freezeConfiguration();
// Instantiate all remaining (non-lazy-init) singletons.
beanFactory.preInstantiateSingletons();

执行到beanFactory.preInstantiateSingletons(); 方法。
再执行到:
protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final Object[] args)
...
// Initialize the bean instance.
Object exposedObject = bean;
try
populateBean(beanName, mbd, instanceWrapper);
if (exposedObject != null)
exposedObject = initializeBean(beanName, exposedObject, mbd);


...
return exposedObject;

这里注意看一下
if (exposedObject != null)
exposedObject = initializeBean(beanName, exposedObject, mbd);

4.initializeBean  这个代码,点进去。



6. applyBeanPostProcessor 这个方法就是调用 ApplicationContextAwareProcessor的地方,我们进去看看。



我们可以看到,确实在 BeanPostProcessors 容器中有一个 ApplicationContextAwareProcessor类。
7. 那么我们进到ApplicationContextAwareProcessor这个类的 postProcessBeforeInitialization方法中。




根据这个源码,我们知道了,确实调用到了setApplicationContext方法。
小结:1、所有实例化的类都会走到ApplicationContextAwareProcessor这个类的postProcessBeforeInitialization方法中。
2、只有当当前正在实例化的类是Aware类型时,且是ApplicationContextAware类型时才会调用到setApplicationContext(this.applicationContext)方法把spring上下文设置进去。也就是实现了ApplicationContextAware接口。
5 种方式获取ApplicationContextApplicationContext对象是Spring开源框架的上下文对象实例,在项目运行时自动装载Handler内的所有信息到内存。传统的获取方式有很多种,不过随着Spring版本的不断迭代,官方也慢慢的不建议使用部分方式。下面我简单介绍几种常用的方式!
直接注入@Resource
private ApplicationContext ctx;
实现ApplicationContextAware接口创建一个实体类并实现ApplicationContextAware接口,重写接口内的setApplicationContext方法来完成获取ApplicationContext实例的方法,代码如下所示:
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;
@Component
public class ApplicationContextProvider
    implements ApplicationContextAware

    /**
    * 上下文对象实例
    */
    private ApplicationContext applicationContext;
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException
        this.applicationContext = applicationContext;
   
    /**
    * 获取applicationContext
    * @return
    */
    public ApplicationContext getApplicationContext()
        return applicationContext;
   
    /**
    * 通过name获取 Bean.
    * @param name
    * @return
    */
    public Object getBean(String name)
        return getApplicationContext().getBean(name);
   
    /**
    * 通过class获取Bean.
    * @param clazz
    * @param < T>
    * @return
    */
    public < T> T getBean(Class< T> clazz)
        return getApplicationContext().getBean(clazz);
   
    /**
    * 通过name,以及Clazz返回指定的Bean
    * @param name
    * @param clazz
    * @param < T>
    * @return
    */
    public < T> T getBean(String name,Class< T> clazz)
        return getApplicationContext().getBean(name, clazz);
   

我们拿到ApplicationContext对象实例后就可以手动获取Bean的注入实例对象,在ApplicationContextProvider类内我简单的实现了几个方法来获取指定的Bean实例,当然你可以添加更多的方法来完成更多的业务逻辑。
如果你是想在非Spring管理的实体内使用ApplicationContext还不想采用注入ApplicationContextProvider来完成实例化,这时我们可以修改ApplicationContext实例对象为静态实例,方法改为静态方法,这样在外部同样是可以获取到指定Bean的实例。
这里要注意ApplicationContextProvider类上的@Component注解是不可以去掉的,去掉后Spring就不会自动调用setApplicationContext方法来为我们设置上下文实例。
在自定义AutoConfiguration中获取有时候我们需要实现自定义的Spring starter,并在自定义的AutoConfiguration中使用ApplicationContext,Spring在初始化AutoConfiguration时会自动传入ApplicationContext,这时我们就可以使用下面的方式来获取ApplicationContext:
@Configuration
@EnableFeignClients("com.yidian.data.interfaces.client")
public class FeignAutoConfiguration
    FeignAutoConfiguration(ApplicationContext context)
        // 在初始化AutoConfiguration时会自动传入ApplicationContext
        doSomething(context);
   

启动时获取ApplicationContext在启动Spring Boot项目时,需要调用SpringApplication.run()方法,而run()方法的返回值就是ApplicationContext,我们可以把run()方法返回的ApplicationContext对象保存下来,方便随时使用:
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class WebApplication
    private static ApplicationContext applicationContext;
    public static void main(String[] args)
        applicationContext = SpringApplication.run(WebApplication.class, args);
        SpringBeanUtil.setApplicationContext(applicationContext);
   

通过WebApplicationContextUtils获取Spring提供了一个工具类用于获取ApplicationContext对象:
WebApplicationContextUtils.getRequiredWebApplicationContext(ServletContext sc);
WebApplicationContextUtils.getWebApplicationContext(ServletContext sc);
————————————————
参考资料:?
??https://www.jianshu.com/p/ef7739a01cb0??
?



    推荐阅读