建立SpringContextHolder工具类自由获取Bean

在工程中会存在一些未被纳入Spring框架管理的类,想调用Spring容器中的bean时可以通过SpringContextHolder工具类的getBean方法来获取指定的bean,比如过滤器、拦截器、自动任务等

建立SpringContextHolder工具类自由获取Bean

所属分类: JAVA
专题标签: Spring Bean 接口实现

工具类实现

实现ApplicationContextAware接口,以静态变量保存Spring ApplicationContext。
可在任何代码任何地方任何时候中取出ApplicaitonContext。
如此就不能说说org.springframework.context.ApplicationContextAware这个接口。

ApplicationContextAware接口

当一个类实现了这个接口(ApplicationContextAware)之后,这个类就可以方便获得ApplicationContext中的所有bean。
换句话说,就是这个类可以直接获取spring配置文件中,所有有引用到的bean对象。
除了以上SpringContextHolder类之外,还有不需要多次加载spring配置文件就可以取得bean的类。
Spring容器会检测容器中的所有Bean,如果发现某个Bean实现了ApplicationContextAware接口,Spring容器会在创建该Bean之后,自动调用该Bean的setApplicationContextAware()方法,调用该方法时,会将容器本身作为参数传给该方法。
该方法中的实现部分将Spring传入的参数(容器本身)赋给该类对象的applicationContext实例变量,因此接下来可以通过该applicationContext实例变量来访问容器本身。

代码示例

  1. /*
  2. * Spring的ApplicationContext的持有者,可以用静态方法的方式获取spring容器中的bean
  3. * 以静态变量保存Spring ApplicationContext, 可在任何代码任何地方任何时候中取出ApplicaitonContext
  4. */
  5. //如果使用注解的方式,需要而配置@Lazy(false)表示不延迟加载(系统启动即刻加载)
  6. @Component
  7. @Lazy(false)
  8. public class SpringContextHolder implements ApplicationContextAware {
  9. private static ApplicationContext applicationContext;
  10. //实现ApplicationContextAware接口的context注入函数, 将其存入静态变量
  11. public void setApplicationContext(ApplicationContext applicationContext) {
  12. SpringContextHolder.applicationContext = applicationContext;
  13. }
  14. //取得存储在静态变量中的ApplicationContext
  15. public static ApplicationContext getApplicationContext() {
  16. checkApplicationContext();
  17. return applicationContext;
  18. }
  19. //从静态变量ApplicationContext中取得Bean, 自动转型为所赋值对象的类型
  20. @SuppressWarnings("unchecked")
  21. public static <T> T getBean(String name) {
  22. checkApplicationContext();
  23. return (T) applicationContext.getBean(name);
  24. }
  25. //从静态变量ApplicationContext中取得Bean, 自动转型为所赋值对象的类型
  26. //如果有多个Bean符合Class, 取出第一个
  27. public static <T> T getBean(Class<T> requiredType) {
  28. checkApplicationContext();
  29. return applicationContext.getBean(requiredType);
  30. }
  31. //清除applicationContext静态变量
  32. public static void cleanApplicationContext() {
  33. applicationContext = null;
  34. }
  35. //检查是否存在
  36. private static void checkApplicationContext() {
  37. if (applicationContext == null) {
  38. throw new IllegalStateException("applicaitonContext未注入,请在applicationContext.xml中定义SpringContextHolder或配置@Lazy(false)");
  39. }
  40. }
  41. }

XML配置形式

如果不是采用注解的方式配置Spring则需要在spring-context.xml,添加bean:

  1. <bean id="springContextHolder" class="com.mebugs.utils.SpringContextHolder" lazy-init="false"/>

实际调用示例

  1. private UserService userService= SpringContextHolder.getBean(UserService.class);

报错处理

启动项目后报错 “applicaitonContext属性为null,请检查是否注入了SpringContextHolder!” SpringContextHolder这个bean没有在实际调用类加载前进行加载,导致没有加载完成,所以我们需要在配置文件中首先加载SpringContextHolder。

  • XML配置方式:
    把bean配置放在配置文件的第一行,务必要配置不延迟加载
  • 注解配置方式:
    实际需要被调用的bean(如UserService),类上添加注解 @DependsOn(“springContextHolder”),用于确保加载此bean之前SpringContextHolder类已加载