SpringContextHolder工具类自由获取Bean

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

所属分类 JAVA

相关标签 SpringBean获取

工具类实现

实现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实例变量来访问容器本身。

代码示例

/*
 * Spring的ApplicationContext的持有者,可以用静态方法的方式获取spring容器中的bean
 * 以静态变量保存Spring ApplicationContext, 可在任何代码任何地方任何时候中取出ApplicaitonContext
 */
//如果使用注解的方式,需要而配置@Lazy(false)表示不延迟加载(系统启动即刻加载)
@Component
@Lazy(false)
public class SpringContextHolder implements ApplicationContextAware {
    
    private static ApplicationContext applicationContext;
    
    //实现ApplicationContextAware接口的context注入函数, 将其存入静态变量
    public void setApplicationContext(ApplicationContext applicationContext) {
        SpringContextHolder.applicationContext = applicationContext;
    }
    
    //取得存储在静态变量中的ApplicationContext
    public static ApplicationContext getApplicationContext() {
        checkApplicationContext();
        return applicationContext;
    }
    
    //从静态变量ApplicationContext中取得Bean, 自动转型为所赋值对象的类型
    @SuppressWarnings("unchecked")
    public static <T> T getBean(String name) {
        checkApplicationContext();
        return (T) applicationContext.getBean(name);
    }
    
    //从静态变量ApplicationContext中取得Bean, 自动转型为所赋值对象的类型
    //如果有多个Bean符合Class, 取出第一个
    public static <T> T getBean(Class<T> requiredType) {
        checkApplicationContext();
        return applicationContext.getBean(requiredType); 
    }
    
    //清除applicationContext静态变量
    public static void cleanApplicationContext() {
        applicationContext = null;
    }
    
    //检查是否存在
    private static void checkApplicationContext() {
        if (applicationContext == null) {
            throw new IllegalStateException("applicaitonContext未注入,请在applicationContext.xml中定义SpringContextHolder或配置@Lazy(false)");
        }
    }
}

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

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

实际调用示例

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

报错处理

启动项目后报错 "applicaitonContext属性为null,请检查是否注入了SpringContextHolder!"

SpringContextHolder这个bean没有在实际调用类加载前进行加载,导致没有加载完成。

所以我们需要在配置文件中首先加载SpringContextHolder。

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

米虫

做一个有理想的米虫,伪全栈程序猿,乐观主义者,坚信一切都是最好的安排!

本站由个人原创、收集或整理,如涉及侵权请联系删除

本站内容支持转发,希望贵方携带转载信息和原文链接

本站具有时效性,不提供有效、可用和准确等相关保证

本站不提供免费技术支持,暂不推荐您使用案例商业化

发表观点

提示

昵称

邮箱

QQ

网址

当前还没有观点发布,欢迎您留下足迹!

同类其他

JAVA

listener、filter、servlet的加载次序

在web.xml中经常会看到listener,filter,servlet的相关标签配置,它们分别是监听器、过滤器、容器,都是在项目启动的时候就可以进行初始化的加载动作

JAVA中创建线程的三种方式的使用与区别

JAVA中通过继承Thread类、实现Runnable接口以及实现Callable接口配合Future接口实现创建多线程,三种方式各有优缺点,而第三种则具备更多的增强能力

SpringBoot配置文件生效优先级

SpringBoot 可以通过 spring.profiles.active 属性指定生效不同配置文件来满足多环境要求,多环境更为复杂的场景,就需要理解配置文件生效优先级,考虑直接引入外部配置项和配置文件

自定义filter过滤器拦截未登录(非法)请求

在JAVA的WEB工程中我们可以将JSP页面文件放在WEB-INFO中限制用户进行URL直接访问,但静态资源如js、css文件却是需要被外部直接访问的,直接对外暴露又不太安全,可以通过自定义过滤器处理

Maven的pom配置文件的scope属性

scope属性主要用于控制依赖范围,主要分为编译、打包、运行、测试、依赖传递等各个常见,scope不同于optional提供了更多可选择的配置参数用于应对不同的依赖场景。

JAVA语言中的反射机制的作用原理及使用

JAVA反射机制是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法;对于任意一个对象,都能够调用它的任意一个方法和属性;动态获取的信息以及动态调用对象的方法的功能。

选择个人头像

昵称

邮箱

QQ

网址

评论提示

  • 头像:系统为您提供了12个头像自由选择,初次打开随机为你选择一个
  • 邮箱:可选提交邮箱,该信息不会外泄,或将上线管理员回复邮件通知
  • 网址:可选提交网址,评论区该地址将以外链的形式展示在您的昵称上
  • 记忆:浏览器将记忆您已选择或填写过得信息,下次评论无需重复输入
  • 审核:提供一个和谐友善的评论环境,本站所有评论需要经过人工审核