SpringContextHolder获取bean

本文介绍如何在工具类中通过SpringContextHolder获取Bean实例,解决工具类方法因static修饰无法使用@Autowired的问题。提供了SpringContextHolder的实现代码,包括注入ApplicationContext、获取Bean实例和发布事件等功能。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

前景,工具类的某个方法想要获取bean的实例,但是工具类的方法是static的,不能使用@Autowired 注入。想了一下,可以通过SpringContextHolder在工具类中使用

//示例调用代码代码
private static EmailService emailService = SpringContextHolder.getBean(EmailService.class);

1.SpringContextHolder的类,需要coding

package com.jamelLi.distributed.session.util;

import org.springframework.beans.factory.DisposableBean;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Service;

/**
 * @ClassName SpringContextHolder
 * @Description: 以静态变量保存Spring ApplicationContext, 可在任何代码任何地方任何时候取出ApplicaitonContext
 * @Auther: Jamel.Li
 * @Date: 2019/1/11 21:15
 * @version: 1.0
 */
@Service
@Lazy(false)
public class SpringContextHolder implements ApplicationContextAware, DisposableBean {

    private static ApplicationContext applicationContext = null;

    /**
     * 实现ApplicationContextAware接口, 注入Context到静态变量中.
     */
    @Override
    public void setApplicationContext(ApplicationContext appContext) {
        applicationContext = appContext;
    }


    /**
     * 取得存储在静态变量中的ApplicationContext.
     */
    public static ApplicationContext getApplicationContext() {
        checkApplicationContext();
        return applicationContext;
    }

    /**
     * 从静态变量applicationContext中取得Bean, 自动转型为所赋值对象的类型.
     */
    public static <T> T getBean(String name) {
        checkApplicationContext();
        return (T) applicationContext.getBean(name);
    }


    /**
     * 从静态变量applicationContext中取得Bean, 自动转型为所赋值对象的类型.
     */
    public static <T> T getBean(Class<T> requiredType) {
        checkApplicationContext();
        return applicationContext.getBean(requiredType);
    }
    
    /**
     * 发布事件
     */
    public static ApplicationContext publishEvent(Object event) {
        applicationContext.publishEvent(event);
        return applicationContext;
    }
    /**
     * 清除SpringContextHolder中的ApplicationContext为Null.
     */
    public static void clearHolder() {
        applicationContext = null;
    }

    /**
     * 实现DisposableBean接口, 在Context关闭时清理静态变量.
     */
    @Override
    public void destroy(){
        SpringContextHolder.clearHolder();
    }

    /**
     * @Description check applicationContext 是否为null
     * @Author Jamel.Li
     * @Date 2019/1/13 14:29
     * @Param []
     * @return void
     */
    private static void checkApplicationContext() {
        if (applicationContext == null) {
            throw new IllegalStateException("applicaitonContext未注入,请在applicationContext.xml中定义SpringContextHolder");
        }
    }

}

2.在xml注入SpringContextHolder。

<!--使用xml 注入SpringContextHolder-->
<bean id="springContextHolder" class="com.jamelLi.distributed.session.util.SpringContextHolder" />  

ps:一般来说,项目的util包,是不会被spring扫描到的。如果SpringContextHolder注入失败,说明没有被spring 扫描,需要增加下面的配置

<!-- 使用Annotation自动注册Bean -->
 <context:component-scan base-package="com.jamelLi.distributed.session.util"></context:component-scan>
### 关于 SpringBoot 中 SpringContextHolder 的使用方法 `SpringContextHolder` 是一种常见的工具类设计模式,在实际开发中被用来获取 `ApplicationContext` 或者其他 Bean 对象。它通过静态变量保存上下文对象,从而可以在任何地方方便地访问 Spring 容器中的资源。 #### 1. **SpringContextHolder 的实现原理** `SpringContextHolder` 基本上是一个单例工具类,通常会继承自 `ApplicationListener<ContextRefreshedEvent>` 接口来监听 Spring 容器初始化完成事件,并将当前的 `ApplicationContext` 存入静态成员变量中[^5]。以下是其实现的核心逻辑: ```java public class SpringContextHolder implements ApplicationListener<ContextRefreshedEvent> { private static ApplicationContext applicationContext; @Override public void onApplicationEvent(ContextRefreshedEvent event) { this.applicationContext = event.getApplicationContext(); } public static Object getBean(String beanName) { return applicationContext.getBean(beanName); } } ``` 上述代码展示了如何利用 `onApplicationEvent` 方法捕获容器刷新事件并存储 `ApplicationContext` 到静态字段中。之后可以通过 `getBean` 方法动态获取任意 Bean 实例。 --- #### 2. **SpringContextHolder 的典型应用场景** - 动态加载服务层组件:当某些业务场景下无法直接注入 Service 类型的对象时(比如在非 Spring 管理的线程中),可以借助此工具类手动获取目标 Bean。 - 跨模块调用:如果项目拆分为多个子模块且存在相互依赖关系,则可能需要通过这种方式间接访问特定功能模块的服务接口。 注意:尽管这种方法灵活便捷,但在大规模分布式系统架构里应谨慎使用,因为它可能会破坏原有清晰的设计边界,增加耦合度[^6]。 --- #### 3. **常见问题分析与解决方案** ##### (1) **延迟加载引发 NullPointerException** 由于 Spring 应用程序启动过程中可能存在异步操作或者多线程竞争条件,导致尝试读取尚未完全注册好的 Bean 导致异常抛出。对此建议加入必要的同步机制以及空指针校验处理措施。 示例修正版如下所示: ```java public static <T> T getBean(Class<T> clazz){ Assert.notNull(applicationContext, "applicationContext属性未注入"); synchronized(SpringContextHolder.class){ if(null != applicationContext && applicationContext.containsBean(clazz.getSimpleName())){ return applicationContext.getBean(clazz); }else{ throw new IllegalStateException("未能找到指定类型的bean实例:" +clazz.getName()); } } } ``` ##### (2) **单元测试困难** 正如提到过的那样,一旦引入此类全局状态管理模式就会使得编写独立性强的 UT 变得复杂起来。因为每次运行都需要重新模拟整个 IOC 生命周期流程才能保证结果一致性[^7]。 推荐做法是在正式环境之外单独定义一套轻量级替代方案用于支持快速验证需求即可满足大部分情况下的要求。 --- ### 总结 综上所述,虽然采用 `SpringContextHolder` 方式能够极大简化部分特殊场合下的编码工作量,但也伴随着一定风险代价。因此开发者应当权衡利弊合理选用合适的技术手段解决问题。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值