一文看懂 Spring Aware 接口

前言

有些情况下，当Bean需要实现某个功能时，需要借助于 Spring容器对象属性 才能实现。此时就需要让该Bean先获取Spring容器对象属性，然后借助于Spring容器对象属性实现该功能。

• 为了让Bean获取它所在的Spring容器对象属性，可以让该Bean实现 如ApplicationContextAware接口。
• 通过实现ApplicationContextAware接口并重写set方法，Spring容器会自动把上下文环境对象调用ApplicationContextAware接口中的setApplicationContext方法，然后就可以通过ApplicationContext对象得到Spring容器中的Bean。
• 可以将Aware理解为属性注入，不过不同地方在于，只有实现了这个接口的bean，当spring容器初始化的时候才会自动的将ApplicationContext注入进来。

Aware

Aware接口是一个空接口，可以理解为是一个标记接口，方便在一个统一的方法(AbstractAutowireCapableBeanFactory.invokeAwareMethods)中进行判断处理赋值，在子接口写出各自的set方法。

**Aware接口方法的主要作用是让 Bean 能够获取 Spring 容器的相关资源和信息，以便在后续的初始化和业务逻辑中使用。**可以理解为之前的属性赋值是将我们自定义属性的值进行赋值，而使用Aware可以让我们拿到Spring容器内部的容器对象。

/*
 * A marker superinterface
 * 在该接口的注释中也解释了该接口是一个标记接口
 */
public interface Aware {

}

常见的 Aware 接口及功能

BeanNameAware接口

• 当一个 Bean 实现了BeanNameAware接口时，它可以获取自己在 Spring 容器中的 Bean 名称。这个接口中只有一个方法setBeanName(String name)，Spring 容器在创建 Bean 的过程中会调用这个方法，并将 Bean 的名称作为参数传递进去。

ApplicationContextAware接口

• 实现这个接口的 Bean 可以获取 Spring 的应用上下文（ApplicationContext）对象。ApplicationContext是 Spring 容器的核心接口，它提供了对容器中所有 Bean 的访问权限，还包括获取资源、发布事件等多种功能。

BeanFactoryAware接口

• 与ApplicationContextAware类似，实现BeanFactoryAware接口的 Bean 可以获取 Bean 工厂（BeanFactory）对象。BeanFactory是 Spring 容器中用于创建和管理 Bean 的基础接口，相对ApplicationContext来说更加轻量级。

ApplicationEventPublisherAware接口

• 如果Bean需要发布应用事件，可以实现此接口。

ResourceLoaderAware接口

• 如果Bean需要加载资源文件（如XML文件、属性文件等），可以实现此接口。

EnvironmentAware接口

• 如果Bean需要访问环境特定的信息（如配置文件位置、激活的配置文件等），可以实现此接口。

MessageSourceAware接口

• 如果Bean需要进行国际化处理，可以实现此接口以获取消息源。

代码示例

如：Bean 实现了 ApplicationContextAware 接口，此时Spring会通过 setApplicationContext() 给Bean中的ApplicationContext属性值赋值。

org.springframework.context.ApplicationContextAware

public interface ApplicationContextAware extends Aware {
    void setApplicationContext(ApplicationContext applicationContext) throws BeansException;
}

通过类实现ApplicationContextAware接口，并重写接口中的setApplicationContext()方法，则可以获取 Spring 的应用上下文ApplicationContext对象

public class SpringContextUtil implements ApplicationContextAware {

    private ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }

    public ApplicationContext getApplicationContext() {
        return applicationContext;
    }
}

Aware 接口中set()的调用时机

• 在以上代码中setApplicationContext()方法是spring容器进行调用的，在invokeAwareMethods中统一调用。
• 当子实现类实现ApplicationContextAware接口后，当前类中重写setApplicationContext为接口中setApplicationContext方法。Spring会在执行invokeAwareMethods()时由容器进行赋值。

Spring源码中的具体实现如下：
org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#invokeAwareMethods

private void invokeAwareMethods(String beanName, Object bean) {
    //如果 bean 是 Aware 实例
    if (bean instanceof Aware) {
        //如果bean是BeanNameAware实例
       if (bean instanceof BeanNameAware) {
           //调用 bean 的setBeanName方法
          ((BeanNameAware) bean).setBeanName(beanName);
       }
       //如果bean是 BeanClassLoaderAware 实例
       if (bean instanceof BeanClassLoaderAware) {
           //获取此工厂的类加载器以加载Bean类(即使无法使用系统classLoader,也只能为null)
          ClassLoader bcl = getBeanClassLoader();
          if (bcl != null) {
              //调用 bean 的 setBeanClassLoader 方法
             ((BeanClassLoaderAware) bean).setBeanClassLoader(bcl);
          }
       }
       //检查bean是否实现了BeanFactoryAware，如果是，则调用其setBeanFactory方法设置工厂实例。
       if (bean instanceof BeanFactoryAware) {
          ((BeanFactoryAware) bean).setBeanFactory(AbstractAutowireCapableBeanFactory.this);
       }
    }
}

什么时候调用invokeAwareMethods方法

invokeAwareMethods()通常是在Spring容器初始化一个bean的过程中被调用的。

• 具体来说，在bean被创建并配置完成后，但还未完全初始化之前（即在init-method或InitializingBean的afterPropertiesSet()方法调用之前），Spring框架会检查该bean是否实现了某些特定的接口，如BeanNameAware、BeanFactoryAware等，并相应地调用这些接口的方法来设置必要的属性。
• 这个过程是Spring框架内部的一部分，用来确保bean能够获得一些关于自身或者Spring应用上下文的信息。
• 例如，让bean知道自己的名字、所属的BeanFactory或者是类加载器等。这样可以在bean的生命周期早期给予bean更多的上下文信息。