ApplicationContextAware接口的作用

Posted 2020-11-21 Archibald Witwicky

 

1/==============

在Web应用中，Spring容器通常采用声明式方式配置产生：开发者只要在web.xml中配置一个Listener，该Listener将会负责初始化Spring容器，MVC框架可以直接调用Spring容器中的Bean，无需访问Spring容器本身。在这种情况下，容器中的Bean处于容器管理下，无需主动访问容器，只需接受容器的依赖注入即可。

但在某些特殊的情况下，Bean需要实现某个功能，但该功能必须借助于Spring容器才能实现，此时就必须让该Bean先获取Spring容器，然后借助于Spring容器实现该功能。为了让Bean获取它所在的Spring容器，可以让该Bean实现ApplicationContextAware接口。

下面示例为实现ApplicationContextAware的工具类，可以通过其它类引用它以操作spring容器及其中的Bean实例。

 

public class SpringContextHolder implements ApplicationContextAware {
    private static ApplicationContext applicationContext = null;
 
    /**
     * 获取静态变量中的ApplicationContext.
     */
    public static ApplicationContext getApplicationContext() {
        assertContextInjected();
        return applicationContext;
    }
 
    /**
     * 从静态变量applicationContext中得到Bean, 自动转型为所赋值对象的类型.
     */
    @SuppressWarnings("unchecked")
    public static <T> T getBean(String name) {
        assertContextInjected();
        return (T) applicationContext.getBean(name);
    }
 
    /**
     * 从静态变量applicationContext中得到Bean, 自动转型为所赋值对象的类型.
     */
    public static <T> T getBean(Class<T> requiredType) {
        assertContextInjected();
        return applicationContext.getBean(requiredType);
    }
 
    /**
     * 清除SpringContextHolder中的ApplicationContext为Null.
     */
    public static void clearHolder() {
        applicationContext = null;
    }
 
    /**
     * 实现ApplicationContextAware接口, 注入Context到静态变量中.
     */
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) {
        SpringContextHolder.applicationContext = applicationContext;
    }
 
    /**
     * 检查ApplicationContext不为空.
     */
    private static void assertContextInjected() {
        Validate.validState(applicationContext != null,
                "applicaitonContext属性未注入, 请在applicationContext.xml中定义SpringContextHolder.");
    }
 
}
　　 

Spring容器会检测容器中的所有Bean，如果发现某个Bean实现了ApplicationContextAware接口，Spring容器会在创建该Bean之后，自动调用该Bean的setApplicationContextAware()方法，调用该方法时，会将容器本身作为参数传给该方法——该方法中的实现部分将Spring传入的参数（容器本身）赋给该类对象的applicationContext实例变量，因此接下来可以通过该applicationContext实例变量来访问容器本身。

 

例如：

在CacheUtil中通过spring容器创建CacheManager实例

public class CacheUtils {
 
    private static CacheManager cacheManager = ((CacheManager) SpringContextHolder.getBean("cacheManager"));
 
}

 

2/==========================

一、这个接口有什么用？

当一个类实现了这个接口（ApplicationContextAware）之后，这个类就可以方便获得ApplicationContext中的所有bean。换句话说，就是这个类可以直接获取spring配置文件中，所有有引用到的bean对象。

二、怎么用？

举个例子吧：

例如我有一个方法类AppUtil，这个方法类中需要使用到的ApplicationContext中的某个bean（companyService）。

1、因为spring要建立属于自己的容器，就必须要加载自己的配置文件。

     这个时候，需要注册ContextLoaderListener或者这个类的子类。

在web.xml加上以下的信息：

<listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
 </listener>
当然，这样子的话只会读取默认路径下的application.xml配置文件的。如果需要读取特定路径下的配置文件。需要在web.xml中

添加如下信息。可以参考我的示例，指定配置文件，如下：

<context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:conf/app-context.xml</param-value>
 </context-param>
 

注意：<param-name>contextConfigLocation</param-name>是不能改变的。

 

2、方法类AppUtil的处理

方法类AppUtil实现ApplicationContextAware接口：

public class AppUtil
  implements ApplicationContextAware
为方法类AppUtil增加一个静态的成员ApplicationContext类型的对象。以后方法类AppUtil获取ApplicationContext，就是通过读取这个

成员变量的。具体如下所示：

private static ApplicationContext appContext;
 

实现ApplicationContextAware接口的默认方法：

 public void setApplicationContext(ApplicationContext paramApplicationContext)
    throws BeansException
  {
    appContext = paramApplicationContext;
  }
 

3、在spring的配置文件中，注册方法类AppUtil

严格上来说，方法类AppUtil是一个bean,而且从步骤2中我们不难发现，之所以方法类AppUtil能够灵活自如地获取ApplicationContext

就是因为spring能够为我们自动地执行了setApplicationContext。但是，spring不会无缘无故地为某个类执行它的方法的，所以，就很有必要

通过注册方法类AppUtil的方式告知spring有这样子一个类的存在。

(加载Spring配置文件时，如果Spring配置文件中所定义的Bean类实现了ApplicationContextAware 接口，那么在加载Spring配置文件时，会自动调用ApplicationContextAware 接口中的

public void setApplicationContext(ApplicationContext context) throws BeansException

方法，获得ApplicationContext对象,ApplicationContext对象是由spring注入的。前提必须在Spring配置文件中指定该类)

其实，方法很简单，就是将方法类AppUtil作为一个普通的bean在spring的配置文件中进行注册：

<bean id="appUtil" class="com.htsoft.core.util.AppUtil"/>
4、使用静态的成员ApplicationContext类型的对象，appContext，来调用其他bean。在方法类AppUtil中增加如下方法：

public static Object getBean(String paramString)
  {
    return appContext.getBean(paramString);
  }
那么，在

方法类AppUtil中就能够灵活地调用其他任何一个bean了，例如：

CompanyService localCompanyService = (CompanyService)getBean("companyService");
注：配置文件中关于companyService的内容：

<bean id="companyService" class="com.kaiwii.service.system.impl.CompanyServiceImpl">
        <constructor-arg index="0" ref="companyDao"/>      
</bean>