Springboot 如何獲取上下文對象

Posted on by

Springboot上下文對象獲取

package it.benjamin.aspirinweb.mem; 
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component; 
 
/**
 * 獲取Springboot上下文，通過上下文可以拿到配置文件中的配置參數
 */
@Component
public class AppContextTool implements ApplicationContextAware {
    private static ApplicationContext context;
 
    public String getConfig(String key) {
        return context.getEnvironment().getProperty(key);
    }
 
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.context = applicationContext;
    } 
}

或者更簡單的寫法：

定義一個AppUtil.java類：

public class AppUtil {
    public static ConfigurableApplicationContext CONTEXT;
}

在啟動類中進行賦值

public static void main(String[] args) {
        AppUtil.CONTEXT = SpringApplication.run(RedisFlinkApplication.class, args);
}

spring boot獲取上下文 隨時取出被spring管理的bean對象

方法一：

實現ApplicationContextAware，重寫setApplicationContext方法。這個方式下，工具類也被註冊成瞭Bean，既然這樣，那就必須確保該類能被Spring自動掃描到。

@Component
public class SpringContextUtils implements ApplicationContextAware { 
    private static ApplicationContext applicationContext;
 
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringContextUtils.applicationContext = applicationContext;
    }
 
    public static <T> T getBean(Class<T> cls) {
        if (applicationContext == null) {
            throw new RuntimeException("applicationContext註入失敗");
        }
        return applicationContext.getBean(cls);
    }
 
    public static Object getBean(String name) {
        if (applicationContext == null) {
            throw new RuntimeException("applicationContext註入失敗");
        }
        return applicationContext.getBean(name);
    }
 
    public static <T> T getBean(String name, Class<T> cls) {
        if (applicationContext == null) {
            throw new RuntimeException("applicationContext註入失敗");
        }
        return applicationContext.getBean(name, cls);
    }
 
    public static HttpServletRequest getRequest() {
        ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder
            .getRequestAttributes();
        return requestAttributes == null ? null : requestAttributes.getRequest();
    }
}

方式二：

我想要的工具類，往往會部署在公共jar中，一般情況下不能被SpringBoot程序掃描到。所有就有手動註入上下文的方式。

@Slf4j
public class SpringUtils { 
    private SpringUtils() {
    } 
    private static ApplicationContext context = null;
 
    /**
     * 初始化Spring上下文
     *
     * @param ctx 上下文對象
     */
    public static void initContext(ApplicationContext ctx) {
        if(ctx == null) {
            log.warn("ApplicationContext is null.");
            return;
        }
        context = ctx;
    } 
 
    /**
     * 根據類型獲取Bean
     *
     * @param cls Bean類
     * @param <T> Bean類型
     * @return Bean對象
     */
    public static <T> T getBean(Class<T> cls) {
        return context == null ? null : context.getBean(cls);
    }
 
    /**
     * 根據名稱獲取Bean
     *
     * @param name Bean名稱
     * @return Bean對象
     */
    public static Object getBean(String name) {
        return context == null ? null : context.getBean(name);
    }
 
    /**
     * 根據Bean名稱和類獲取Bean對象
     *
     * @param name Bean名稱
     * @param cls Bean類
     * @param <T> Bean類型
     * @return Bean對象
     */
    public static <T> T getBean(String name, Class<T> cls) {
        return context == null ? null : context.getBean(name, cls);
    }
}

此種方式不用實現ApplicationContextAware接口，但是需要手動設置上下文。所以在程序入口處，需要調用initContext方法，完成上下文的初始化。

    public static void main(String[] args) {
        ApplicationContext context = SpringApplication.run(YCloudsServiceBApplication.class, args);
        SpringUtils.initContext(context);
    }

GitHub地址：https://github.com/ye17186/spring-boot-learn

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：