架构のSpring扩展点（四）：Bean初始化时对象自动注入-Aware全解析

Spring 的扩展点 是Spring易扩展的一个重要体现，熟悉这些扩展点的定义方式，以及其调用时机，不仅成为工作中利器，也能深度理解Spring框架的切入点。

Aware扩展点 

Aware用途

 Aware类的接口提供了可以在Bean初始化的过程中自动获取信息的能力。

BeanFactoryAware用途

BeanFactoryAware接口继承了Aware子接口，用于在Bean实例化后,将BeanFactory实例注入到Bean中。通过实现该接口,Bean可以获取到BeanFactory实例,从而可以在运行时动态获取其他Bean的实例。

查看Sprng源码接口上的描述：

例如，bean可以通过工厂查找协作bean（依赖查找）。请注意，
多数bean将选择通过相应的bean属性或构造函数参数（依赖注入）接收对协作bean的引用。
/**
 * 
For example, beans can look up collaborating beans via the factory
 * (Dependency Lookup). Note that most beans will choose to receive references
 * to collaborating beans via corresponding bean properties or constructor
 * arguments (Dependency Injection).
 *
 */
public interface BeanFactoryAware extends Aware {

   提供给bean实例的获取自己所属工厂的回调。在正常bean属性填充之后调用，
   但在初始化回调（如InitializingBean#afterPropertiesSet()）或自定义init-method之前调用
  /**
   * Callback that supplies the owning factory to a bean instance.
   * 
Invoked after the population of normal bean properties
   * but before an initialization callback such as
   * {@link InitializingBean#afterPropertiesSet()} or a custom init-method.
   * @param beanFactory owning BeanFactory (never {@code null}).
   */
  void setBeanFactory(BeanFactory beanFactory) throws BeansException;

}

BeanFactory中规定的Bean生命周期方法

查看BeanFactory的DocApi，bean的全生命周期方法为14种如下。按照执行顺序进行排序

来源

org.springframework.beans它是由Spring本身提供的容器级别的接口。

Aware继承者们的setXXX方法

可以在bean实例化之后，还未初始化之前，拿到指定要获取的对象，在这个时候，可以对每个bean进行特殊化的定制。

这些接口提供获取不同对象的能力，具体的清单如下：

方法	注入对象	用途
BeanNameAware#setBeanName	Bean对象的名称	依据对象名称进行Bean准确获取
BeanClassLoaderAware#setBeanClassLoader	Bean的类加载器	依据类加载器进行相关操作
BeanFactoryAware#setBeanFactory	获取到BeanFactory对象	获取Spring容器中的Bean实例 手动注册BeanDefinition
EnvironmentAware#setEnvironment	Bean获取到Environment对象（配置属性和环境变量）	获取当前的环境配置，如开发环境、测试环境或生产环境 获取配置文件中的属性值
EmbeddedValueResolverAware#setEmbeddedValueResolver	获取值解析器	替换配置文件中的占位符
ResourceLoaderAware#setResourceLoader	获取资源加载器	加载配置文件 加载图片等静态资源
ApplicationEventPublisherAware#setApplicationEventPublisher	获取事件发布器	实现自定义事件 监听Spring容器事件
MessageSourceAware#setMessageSource	获取消息国际化对象	获取国际化信息
ApplicationContextAware#setApplicationContext	Spring上下文对象	在Web项目中获取ServletContext 获取国际化信息 获取Scheduler等定时任务

方法	注入对象	用途
ServletContextAware#setServletContext	获取到ServletConfig对象	获取Servlet的名称 获取Servlet的初始化参数

自定义实现方式

Aware所有继承接口只需要实现即可。

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanClassLoaderAware;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.BeanNameAware;
import org.springframework.context.*;
import org.springframework.context.annotation.ImportAware;
import org.springframework.context.weaving.LoadTimeWeaverAware;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ResourceLoader;
import org.springframework.core.metrics.ApplicationStartup;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.instrument.classloading.LoadTimeWeaver;
import org.springframework.stereotype.Component;
import org.springframework.util.StringValueResolver;

@Slf4j
@Component
public class AllExtendAware implements BeanNameAware, BeanClassLoaderAware, BeanFactoryAware, EnvironmentAware, EmbeddedValueResolverAware,
        ResourceLoaderAware, ApplicationEventPublisherAware, MessageSourceAware,ApplicationStartupAware, ApplicationContextAware, ImportAware,
        LoadTimeWeaverAware {

    @Override
    public void setBeanClassLoader(ClassLoader classLoader) {
        log.info(" ------> BeanClassLoaderAware::setBeanClassLoader invoked");
    }

    @Override
    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
        log.info(" ------> BeanFactoryAware::setBeanFactory invoked");
    }

    @Override
    public void setBeanName(String s) {
        log.info(" ------> BeanNameAware::setBeanName invoked");
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        log.info(" ------> ApplicationContextAware::setApplicationContext invoked");
    }

    @Override
    public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
        log.info(" ------> ApplicationEventPublisherAware::setApplicationEventPublisher invoked");
    }

    @Override
    public void setEmbeddedValueResolver(StringValueResolver resolver) {
        log.info(" ------> EmbeddedValueResolverAware::setEmbeddedValueResolver invoked");
    }

    @Override
    public void setEnvironment(Environment environment) {
        log.info(" ------> EnvironmentAware::setEnvironment invoked");
    }

    @Override
    public void setMessageSource(MessageSource messageSource) {
        log.info(" ------> MessageSourceAware::setMessageSource invoked");
    }

    @Override
    public void setResourceLoader(ResourceLoader resourceLoader) {
        log.info(" ------> ResourceLoaderAware::setResourceLoader invoked");
    }

    @Override
    public void setApplicationStartup(ApplicationStartup applicationStartup) {
        log.info(" ------> ApplicationStartup::setApplicationStartup invoked");
    }

    @Override
    public void setImportMetadata(AnnotationMetadata importMetadata) {
        log.info(" ------> ImportAware::setImportMetadata invoked");
    }

    @Override
    public void setLoadTimeWeaver(LoadTimeWeaver loadTimeWeaver) {
        log.info(" ------> LoadTimeWeaverAware::setLoadTimeWeaver invoked");
    }


}

实现代码

 ------> BeanNameAware::setBeanName invoked ------> BeanClassLoaderAware::setBeanClassLoader invoked ------> BeanFactoryAware::setBeanFactory invoked ------> EnvironmentAware::setEnvironment invoked ------> EmbeddedValueResolverAware::setEmbeddedValueResolver invoked ------> ResourceLoaderAware::setResourceLoader invoked ------> ApplicationEventPublisherAware::setApplicationEventPublisher invoked ------> MessageSourceAware::setMessageSource invoked ------> ApplicationStartup::setApplicationStartup invoked ------> ApplicationContextAware::setApplicationContext invoked

控制台输出顺序

工作原理

调用时机

Aware类接口是在bean创建时进行调用的。调用方式分为两种：

• 初始化Bean（initializeBean）的时候直接进行方法调用

• BeanPostProcessor->执行 postProcessBeforeInitialization(Object bean, String beanName)的时候调用

  直接调用

AbstractAutowireCapableBeanFactory#initializeBean直接调用

org.springframework.context.support.PostProcessorRegistrationDelegate#registerBeanPostProcessors()
  BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
    org.springframework.beans.factory.support.AbstractBeanFactory#getBean
      org.springframework.beans.factory.support.AbstractBeanFactory#doGetBean  
        org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#createBean
          org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#doCreateBean
             org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#initializeBean
                org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#invokeAwareMethods

直接调用调用链

间接调用

ApplicationContextAwareProcessor#postProcessBeforeInitialization间接调用

invokeAwareInterfaces方法

org.springframework.context.support.PostProcessorRegistrationDelegate#registerBeanPostProcessors()
  BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
    org.springframework.beans.factory.support.AbstractBeanFactory#getBean
      org.springframework.beans.factory.support.AbstractBeanFactory#doGetBean  
        org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#createBean
          org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#doCreateBean
             org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#initializeBean

间接接调用调用链

大齐架构

 近期文章精选：

架构のSpring扩展点（二）：Bean定义操作-BeanDefinitionRegistryPostProcessor

架构のSpring扩展点（一）：上下文创建前的动态处理-ApplicationContextInitializer

架构のSpring扩展点（三）：Bean生命周期操作-InstantiationAwareBeanPostProcessor

认知结构的提升，需要合适的思考方法-架构提升