问题背景
在我们的web程序中,用spring来管理各个实例(bean), 有时在程序中为了使用已被实例化的bean, 通常会用到这样的代码:
1、BeanFactory是什么?
BeanFactory作为基础的IoC容器,管理了spring所有的Bean,提供了最基本的容器功能,但是BeanFactory是一个接口。
2、ApplicationContext是什么?
ApplicationContext 是一个高级形态的 IoC 容器,它在 BeanFactory 基础上附加了好多其他功能, 提供了更多面向框架的功能,因此我们一般使用 ApplicationContext 进行开发
ApplicationContext appContext = new ClassPathXmlApplicationContext("applicationContext-common.xml");
AbcService abcService = (AbcService)appContext.getBean("abcService");
但是这样就会存在一个问题:因为它会重新装载applicationContext-common.xml
并实例化上下文bean,如果有些线程配置类也是在这个配置文件中,那么会造成做相同工作的的线程会被启两次。一次是web容器初始化时启动,另一次是上述代码显示的实例化了一次。当于重新初始化一遍!!!!这样就产生了冗余。
解决方法
不用类似new ClassPathXmlApplicationContext()的方式,从已有的spring上下文取得已实例化的bean。通过ApplicationContextAware接口进行实现。
当一个类实现了这个接口(ApplicationContextAware)之后,这个类就可以方便获得ApplicationContext中的所有bean。换句话说,就是这个类可以直接获取spring配置文件中,所有有引用到的bean对象。
二、怎么使用这个接口?
1、自定义的类,实现ApplicationContextAware接口,例如ApplicationContextUtil实现接口,代码如下:
package com.upincar.contract.util;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
public class ApplicationContextUtil implements ApplicationContextAware{
private static ApplicationContext applicationContext;
/**
* 实现ApplicationContextAware接口的回调方法,设置上下文环境
*
* @param applicationContext spring上下文对象
* @throws BeansException 抛出spring异常
*/
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
ApplicationContextUtil.applicationContext = applicationContext;
}
/**
* @return ApplicationContext
*/
public static ApplicationContext getApplicationContext() {
return applicationContext;
}
/**
* 获取对象
*
* @param name spring配置文件中配置的bean名或注解的名称
* @return 一个以所给名字注册的bean的实例
* @throws BeansException 抛出spring异常
*/
@SuppressWarnings("unchecked")
public static <T> T getBean(String name) throws BeansException {
return (T) applicationContext.getBean(name);
}
/**
* 获取类型为requiredType的对象
*
* @param clazz 需要获取的bean的类型
* @return 该类型的一个在ioc容器中的bean
* @throws BeansException 抛出spring异常
*/
public static <T> T getBean(Class<T> clazz) throws BeansException {
return applicationContext.getBean(clazz);
}
/**
* 如果ioc容器中包含一个与所给名称匹配的bean定义,则返回true否则返回false
*
* @param name ioc容器中注册的bean名称
* @return 存在返回true否则返回false
*/
public static boolean containsBean(String name) {
return applicationContext.containsBean(name);
}
}
2、在spring的配置文件中,注册方法类ApplicationContextUtil
注:方法类ApplicationContextUtil是一个bean,之所以方法类ApplicationContextUtil能够灵活自如地获取ApplicationContext就是因为spring能够为我们自动地执行了setApplicationContext。
但是spring不会无缘无故地为某个类执行它的方法的,所以就很有必要通过注册方法类ApplicationContextUtil的方式告知spring有这样子一个类的存在;
将方法类ApplicationContextUtil作为一个普通的bean在spring的配置文件中进行注册,在xml文件中配置如下:
<!-- 注入ApplicationContextAware接口实现类,spring上下文环境 -->
<bean id="applicationContextUtil" class="com.upincar.contract.util.ApplicationContextUtil"/>
3、ApplicationContextUtil类的使用
从ApplicationContextAware获取ApplicationContext上下文的情况,仅仅适用于当前运行的代码和已启动的Spring代码处于同一个Spring上下文,否则获取到的ApplicationContext是空的。
比如我要为当前系统加入一个定时任务,定时刷新Memcache缓存。这个定时任务框架是公司的框架,下面是我的ApplicationContextAware 接口实现类:
定时任务类如下,定时任务初始化的时候,首先会调用作业类的public static Object getObject()
方法返回作业类的实例。
@Component
public class RemoteCacheJob extends AbstractSaturnJavaJob {
@Autowired
private AdsRemoteCacheJob adsRemoteCacheJob;
@Autowired
private ILogService logService;
// 实例化的过程:系统会首先调用作业类的public static Object getObject()方法,
// 如果返回为null,则调用作业类的无参构造方法来实例化;否则直接使用getObject()方法返回的对象作为作业类实例。
public static Object getObject() {
return ApplicationContextUtil.getBean(RemoteCacheJob .class);
}
@Override
public void handleJavaJob(String jobName, Integer shardItem, String shardParam, SaturnJobExecutionContext shardingContext)
throws InterruptedException {
System.out.println("处理定时任务");
}
}
启动项目,Spring容器进行初始化,可以看到已经初始化了ApplicationContext :
然后运行定时任务插件,首先去获取ApplicationContext,但是此时的applicationContext是空的:
很显然,定时任务是没办法获取到项目所在Spring容器启动之后的ApplicationContext。
ApplicationContextAware接口在springboot中的使用
由于springboot默认扫描规则是:自动扫描启动器类的同包或者其子包的下的注解。
所以在springboot项目中不需要在xml中配置,只需要在ApplicationContextUtil类中使用@Component注解,把ApplicationContextUtil注册为spring的组件,就可以在项目中使用ApplicationContextUtil获取spring容器中的某个Bean了。