ApplicationContextAware：Bean 的“上下文感知”超能力

在 Spring Boot 的世界中，我们依赖依赖注入（DI）来管理 Bean 之间的关系。然而，有时我们需要 Bean 直接访问 Spring 应用上下文（ApplicationContext）来执行一些特殊操作。这时，ApplicationContextAware 接口就派上了用场。本文将深入探讨 ApplicationContextAware 在 Spring Boot 中的应用，揭示其工作原理，并分享一些最佳实践。

一、ApplicationContextAware 的作用：赋予 Bean “上下文感知”的能力

ApplicationContextAware 是 Spring 框架中的一个接口，它允许 Bean 在初始化时获取到 Spring 应用上下文（ApplicationContext）。通过这个上下文，Bean 可以访问 Spring 容器的各种服务，例如：

获取其他 Bean 实例：当依赖注入无法满足需求时，手动获取需要的 Bean。
发布 Spring 应用事件：在 Bean中触发自定义事件，实现应用之间的解耦。
访问资源文件：获取配置文件、国际化资源等。
获取环境信息：读取系统属性、环境变量等。

二、ApplicationContextAware 的工作原理

2.1 接口定义：

package org.springframework.context;

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

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

2.2 Spring Boot 的处理:

当 Spring Boot 容器启动并实例化一个实现了 ApplicationContextAware 接口的 Bean 时，它会在 Bean 的属性注入完成之后，调用 setApplicationContext() 方法，并将 ApplicationContext 实例作为参数传入。这意味着，在 setApplicationContext() 方法中，你可以安全地访问 Bean 的属性。

三、ApplicationContextAware 在 Spring Boot 中的应用场景

3.1 手动获取 Bean（不推荐）：

场景：某些情况下，由于循环依赖或其他复杂因素，无法通过依赖注入获取到需要的 Bean。
示例：

@Component
public class MyBean implements ApplicationContextAware {

  private ApplicationContext applicationContext;

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

  public void doSomething() {
      // 避免直接使用getBean， 如果可以使用依赖注入最好
      AnotherBean anotherBean = applicationContext.getBean(AnotherBean.class);
      anotherBean.doWork();
    }
}

注意：尽可能避免使用 ApplicationContextAware 手动获取 Bean。依赖注入通常是更优雅、更解耦的解决方案。

3.2 发布 Spring 应用事件：

场景：需要在 Bean 中触发自定义事件，实现应用组件之间的解耦。
示例：

@Component
public class MyBean implements ApplicationContextAware {

   private ApplicationContext applicationContext;
   private ApplicationEventPublisher publisher;

   @Override
   public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
       this.applicationContext = applicationContext;
       this.publisher= applicationContext; //ApplicationContext 也实现了ApplicationEventPublisher
   }

   public void doSomething() {
       publisher.publishEvent(new MyCustomEvent("触发自定义事件！"));
   }
}

在 Spring Boot 中，也可以直接注入 ApplicationEventPublisher 来发布事件。

3.3 访问资源文件：

场景：需要在 Bean 中访问 classpath 下的资源文件，例如配置文件、国际化文件等。
示例：

@Component
public class MyBean implements ApplicationContextAware {
    private ApplicationContext applicationContext;

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

    public void doSomething() throws IOException {
        Resource resource = applicationContext.getResource("classpath:myconfig.properties");
         try(InputStream inputStream = resource.getInputStream()){
                // 读取文件流
         }
    }
 }

3.4 获取环境信息：

场景：需要在 Bean 中访问 Spring Boot 的 Environment 对象，获取配置信息、系统属性、环境变量等。
示例：

@Component
public class MyBean implements ApplicationContextAware {

    private ApplicationContext applicationContext;
    private Environment environment;

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

    public void doSomething() {
        String appName = environment.getProperty("spring.application.name");
        System.out.println("Application Name: " + appName);
    }
}

在 Spring Boot 中，也可以直接注入 Environment 对象

四、ApplicationContextAware 的最佳实践

优先依赖注入：尽可能使用依赖注入来获取需要的 Bean，避免滥用 ApplicationContextAware。
避免直接操作Bean 容器：尽量不要在 ApplicationContextAware 获取到的 ApplicationContext上进行复杂的 Bean 操作。
解耦：对于复杂的逻辑，尽量将 ApplicationContextAware的使用封装起来，避免代码过于耦合。
测试：在单元测试中，需要 Mock ApplicationContext，以保证测试的独立性。
注意生命周期：确保在使用 ApplicationContext 时，容器已经完全启动，并且 Bean 已经初始化完成。
注意线程安全：如果您的应用程序是多线程的，请确保对ApplicationContext的操作是线程安全的。