1. 介绍与使用

SpringContextHolder工具类的方法 getBean 可以获取 bean 的实例。但是工具类的方法是不是 static 的，等同于 @Autowired 注入。

解决问题：

类中方法是 static，方法中使用的对象也必须是 static，但正常情况下 @Autowired 无法注入静态的 bean,于是发现项目中用到了springContextHolder，通过使用；

  1. UserService userService = SpringContextHolder.getBean(UserService.class);   // 获取bean

2. 异常　　

使用 SpringContextHolder 来获取一个bean报异常：

  1. Java.lang.IllegalStateException: applicaitonContext属性未注入, 请在applicationContext.xml中定义SpringContextHolder.
  2.     at org.apache.commons.lang3.Validate.validState(Validate.java:826)
  3.     at com.jituan.common.util.SpringContextHolder.assertContextInjected(SpringContextHolder.java:79)
  4.     at com.jituan.common.util.SpringContextHolder.getBean(SpringContextHolder.java:41)
  5.     at com.jituan.common.message.util.sms.SmsUtil.querySmsTemplate(SmsUtil.java:206)
  6.     at com.jituan.common.message.util.sms.SmsUtil.send(SmsUtil.java:76)
  7.     at com.jituan.common.message.processer.SmsProcesser.send(SmsProcesser.java:37)
  8.     at com.jituan.batch.msghandler.MessageHandler.smsSend(MessageHandler.java:106)
  9.     at com.jituan.batch.msghandler.MessageHandler$SmsTread.run(MessageHandler.java:185)

配置 spring-mvc.xml

  1. <!-- 设全局变量以便可以获得对应的注入bean -->
  2. <bean id="springContextHolder" class="com.jituan.common.util.SpringContextHolder" />

编写 SpringContextHolder 代码：

  1. import lombok.extern.slf4j.Slf4j;
  2. import org.springframework.beans.factory.DisposableBean;
  3. import org.springframework.context.ApplicationContext;
  4. import org.springframework.context.ApplicationContextAware;
  5. import org.springframework.stereotype.Component;
  7. /**
  8.  * @description:spring context 上下文
  9.  * @author: zhangx
  10.  * @Date: 2018/1/30 16:40
  11.  */
  12. @Component
  13. @Slf4j
  14. public class SpringContextHolder implements ApplicationContextAware, DisposableBean {
  16.     private static ApplicationContext applicationContext = null;
  18.     /**
  19.      * 取得存储在静态变量中的ApplicationContext.
  20.      */
  21.     public static ApplicationContext getApplicationContext() {
  22.         assertContextInjected();
  23.         return applicationContext;
  24.     }
  26.     /**
  27.      * 从静态变量applicationContext中取得Bean, 自动转型为所赋值对象的类型.
  28.      */
  29.     public static <T> T getBean(String name) {
  30.         assertContextInjected();
  31.         return (T) applicationContext.getBean(name);
  32.     }
  34.     /**
  35.      * 从静态变量applicationContext中取得Bean, 自动转型为所赋值对象的类型.
  36.      */
  37.     public static <T> T getBean(Class<T> requiredType) {
  38.         assertContextInjected();
  39.         return applicationContext.getBean(requiredType);
  40.     }
  42.     /**
  43.      * 清除SpringContextHolder中的ApplicationContext为Null.
  44.      */
  45.     public static void clearHolder() {
  46.         log.debug("清除SpringContextHolder中的ApplicationContext:" + applicationContext);
  47.         applicationContext = null;
  48.     }
  50.     /**
  51.      * 实现ApplicationContextAware接口, 注入Context到静态变量中.
  52.      */
  53.     @Override
  54.     public void setApplicationContext(ApplicationContext applicationContext) {
  55.         log.debug("注入ApplicationContext到SpringContextHolder:{}", applicationContext);
  57.         if (SpringContextHolder.applicationContext != null) {
  58.             log.warn("SpringContextHolder中的ApplicationContext被覆盖, 原有ApplicationContext为:"
  59.                     + SpringContextHolder.applicationContext);
  60.         }
  62.         SpringContextHolder.applicationContext = applicationContext;
  63.     }
  65.     /**
  66.      * 实现DisposableBean接口, 在Context关闭时清理静态变量.
  67.      */
  68.     @Override
  69.     public void destroy() throws Exception {
  70.         SpringContextHolder.clearHolder();
  71.     }
  73.     /**
  74.      * 检查ApplicationContext不为空.
  75.      */
  76.     private static void assertContextInjected() {
  77.         if (applicationContext == null) {
  78.             throw new IllegalArgumentException(
  79.                     "applicationContext属性未注入, 请在applicationContext.xml中定义SpringContextHolder.");
  80.         }
  81.     }
  82. }