SpringBoot ApplicationContextAware拓展接口使用詳解

更新時間：2023年04月03日 09:56:27 作者：ForestSpringH

當(dāng)一個類實(shí)現(xiàn)了這個接口（ApplicationContextAware）之后，這個類就可以方便獲得ApplicationContext中的所有bean。換句話說，就是這個類可以直接獲取spring配置文件中，所有有引用到的bean對象

近日沉醉于熟悉公司新項目的過程，不斷地接觸新的應(yīng)用場景與實(shí)現(xiàn)技術(shù)，對于我是一種學(xué)不來的進(jìn)步，實(shí)踐是檢驗真理的唯一標(biāo)準(zhǔn)。我們今天就淺淺的談一談springboot提供的16個拓展接口之一的ApplicationContextAware接口的應(yīng)用場景與實(shí)際作用！

ApplicationContextAware接口：

public interface ApplicationContextAware extends Aware {
    void setApplicationContext(ApplicationContext applicationContext) throws BeansException;
}

首先Aware接口就知道這是springboot擴(kuò)展給用戶使用的，這里提供了方法setApplicationContext，參數(shù)就是傳遞spring容器上下文對象進(jìn)來，我們可以接收這個上下文對象，我們要想知道獲取spring容器上下文ApplicationContext具體有什么作用，這才是擴(kuò)展接口的目的所在，獲取上下文根據(jù)上下文的特性做一些事情。

我們來看ApplicationContext對象的方法：

來看看AbstractApplicationContext實(shí)現(xiàn)類的方法：

    public Object getBean(String name) throws BeansException {this.assertBeanFactoryActive();return this.getBeanFactory().getBean(name);}
    public <T> T getBean(String name, Class<T> requiredType) throws BeansException {this.assertBeanFactoryActive();return this.getBeanFactory().getBean(name, requiredType);}
    public Object getBean(String name, Object... args) throws BeansException {this.assertBeanFactoryActive();return this.getBeanFactory().getBean(name, args);}
    public <T> T getBean(Class<T> requiredType) throws BeansException {this.assertBeanFactoryActive();return this.getBeanFactory().getBean(requiredType);}
    public <T> T getBean(Class<T> requiredType, Object... args) throws BeansException {this.assertBeanFactoryActive();return this.getBeanFactory().getBean(requiredType, args);}
    public <T> ObjectProvider<T> getBeanProvider(Class<T> requiredType) {this.assertBeanFactoryActive();return this.getBeanFactory().getBeanProvider(requiredType);}
    public <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType) {this.assertBeanFactoryActive();return this.getBeanFactory().getBeanProvider(requiredType);}
    public boolean containsBean(String name) {return this.getBeanFactory().containsBean(name);}
    public boolean isSingleton(String name) throws NoSuchBeanDefinitionException {this.assertBeanFactoryActive();return this.getBeanFactory().isSingleton(name);}
    public boolean isPrototype(String name) throws NoSuchBeanDefinitionException {this.assertBeanFactoryActive();return this.getBeanFactory().isPrototype(name);}

這里我們可以發(fā)現(xiàn) getBean()方法很眼熟，因為在最最開始學(xué)習(xí)spring時沒有用spring的腳手架創(chuàng)建項目，我們獲取bean的方法通常是classPathContextLoader掃描bean的xml文件解析組成ApplicationCOntext對象，再調(diào)用它的getBean方法獲取實(shí)例bean。

由此可以發(fā)現(xiàn)我們主要的應(yīng)用途徑就是使用這個getBean的方法，那么動態(tài)的注入bean我們通過很多方法就能實(shí)現(xiàn)，所以這里不難想到，靜態(tài)方法中無法使用注入的bean的問題。

其次我們來復(fù)現(xiàn)這個問題，大家來看如下的代碼：

public class JsonGetter {
@Resource
private UuidGetter uuidGetter;
public static string Test(){
       return uuidGetter.getUuid();
}
public static JsONobject set0bjectToJsonObject(object data){
       return JsoNobject.parseObject(String.valueof(JsONObject.toJSON(data)));
}
public static JsONObject setStringTO3son0bject(String data) { return JsONObject.parseObject(data);
}

我們發(fā)現(xiàn)在靜態(tài)的Test方法中調(diào)用注入的bean直接報錯，這里解釋一下：歸功于類的加載機(jī)制與加載順序，靜態(tài)屬性與靜態(tài)代碼塊最先加載（static靜態(tài)優(yōu)先），這里加載靜態(tài)方法是沒有bean實(shí)例給你用的，自然會報錯。

如何解決？我們可以采取Spring獲取bean對象時調(diào)用getBean方法的思路，在容器加載時將spring容器的上下文進(jìn)行靜態(tài)存儲：

@Component
@Lazy(value = false)
public class SpringContextHolder implements ApplicationContextAware, DisposableBean {
    /**
     * 將上下文靜態(tài)設(shè)置，在初始化組件時就進(jìn)行靜態(tài)上下文的覆蓋（這個覆蓋是將遠(yuǎn)spring容器的上下文對象引用加到我們預(yù)定設(shè)置）
     */
    private static ApplicationContext applicationContext = null;
    public static ApplicationContext getApplicationContext() {
        assertContextInjected();
        return applicationContext;
    }
    @SuppressWarnings("unchecked")
    public static <T> T getBean(String name) {
        assertContextInjected();
        return (T) applicationContext.getBean(name);
    }
    public static  <T> T getBean(Class<T> beanType) {
        assertContextInjected();
        return applicationContext.getBean(beanType);
    }
    @Override
    public void setApplicationContext(@NotNull ApplicationContext applicationContext) throws BeansException {
        SpringContextHolder.applicationContext = applicationContext;
    }
    @Override
    public void destroy() {
        applicationContext = null;
    }
    private static void assertContextInjected() {
        Assert.notNull(applicationContext,
                "applicationContext屬性未注入, 請在applicationContext.xml中定義SpringContextHolder.");
    }
    public static void pushEvent(ApplicationEvent event){
        assertContextInjected();
        applicationContext.publishEvent(event);
    }
}

這里只需要關(guān)注的是靜態(tài)成員變量ApplicationContext的定義、賦值與驗證：

    /**
     * 將上下文靜態(tài)設(shè)置，在初始化組件時就進(jìn)行靜態(tài)上下文的覆蓋（這個覆蓋是將遠(yuǎn)spring容器的上下文對象引用加到我們預(yù)定設(shè)置）
     */
    private static ApplicationContext applicationContext = null;

重寫擴(kuò)展接口的方法，實(shí)現(xiàn)靜態(tài)上下文的覆蓋：

    @Override
    public void setApplicationContext(@NotNull ApplicationContext applicationContext) throws BeansException {
        SpringContextHolder.applicationContext = applicationContext;
    }

將獲取它的方法公有修飾，便于共享：

    public static ApplicationContext getApplicationContext() {
        assertContextInjected();
        return applicationContext;
    }

寫到這里還是不明白，這么定義一個組件，將spring上下文對象靜態(tài)覆蓋到底有何作用？

不要慌，我們來看看這個類的這個方法：

public class AppContext {
    static transient ThreadLocal<Map<String, String>> contextMap = new ThreadLocal<>();
    ......省略n行業(yè)務(wù)代碼
    public static void fillLoginContext() {
        DingAppInfo appInfo = SpringContextHolder.getBean(DingAppInfoService.class).findAppInfo(APP_CODE);
        setDingVerifyInfo(appInfo);
        CloudChatAppInfo cloudChatAppInfo = SpringContextHolder.getBean(CloudChatAppInfoService.class).findAppInfo(APP_CODE);
        setCloudChatInfo(cloudChatAppInfo);
    }
    public static void clear() {
        contextMap.remove(); //本地線程的remove方法極其重要，注意每次給它使用之后一定要調(diào)用remove清理，防止內(nèi)存泄露。
    }
}

我們發(fā)現(xiàn)上例代碼中進(jìn)行了查庫的操作：

DingAppInfo appInfo = SpringContextHolder.getBean(DingAppInfoService.class).findAppInfo(APP_CODE);

這里是不是就解決了最初我們的問題？

實(shí)現(xiàn)了擴(kuò)展applicationContextAware接口，解決靜態(tài)方法無法獲取bean實(shí)例調(diào)用其方法的問題？

到此這篇關(guān)于SpringBoot ApplicationContextAware拓展接口使用詳解的文章就介紹到這了,更多相關(guān)SpringBoot ApplicationContextAware內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: