SpringContextHolder获取bean

原创已于 2022-08-24 11:06:23 修改 · 2.6k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#Spring #工具 #自动注入

于 2019-01-13 23:35:30 首次发布

spring 专栏收录该内容

1 篇文章

订阅专栏

本文介绍如何在工具类中通过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>