前言

有些情況下，當(dāng)Bean需要實(shí)現(xiàn)某個(gè)功能時(shí)，需要借助于 Spring容器對(duì)象屬性 才能實(shí)現(xiàn)。此時(shí)就需要讓該Bean先獲取Spring容器對(duì)象屬性，然后借助于Spring容器對(duì)象屬性實(shí)現(xiàn)該功能。

• 為了讓Bean獲取它所在的Spring容器對(duì)象屬性，可以讓該Bean實(shí)現(xiàn) 如ApplicationContextAware接口。
• 通過(guò)實(shí)現(xiàn)ApplicationContextAware接口并重寫(xiě)set方法，Spring容器會(huì)自動(dòng)把上下文環(huán)境對(duì)象調(diào)用ApplicationContextAware接口中的setApplicationContext方法，然后就可以通過(guò)ApplicationContext對(duì)象得到Spring容器中的Bean。
• 可以將Aware理解為屬性注入，不過(guò)不同地方在于，只有實(shí)現(xiàn)了這個(gè)接口的bean，當(dāng)spring容器初始化的時(shí)候才會(huì)自動(dòng)的將ApplicationContext注入進(jìn)來(lái)。

Aware

Aware接口是一個(gè)空接口，可以理解為是一個(gè)標(biāo)記接口，方便在一個(gè)統(tǒng)一的方法(AbstractAutowireCapableBeanFactory.invokeAwareMethods)中進(jìn)行判斷處理賦值，在子接口寫(xiě)出各自的set方法。

**Aware接口方法的主要作用是讓 Bean 能夠獲取 Spring 容器的相關(guān)資源和信息，以便在后續(xù)的初始化和業(yè)務(wù)邏輯中使用。**可以理解為之前的屬性賦值是將我們自定義屬性的值進(jìn)行賦值，而使用Aware可以讓我們拿到Spring容器內(nèi)部的容器對(duì)象。

/*
 * A marker superinterface
 * 在該接口的注釋中也解釋了該接口是一個(gè)標(biāo)記接口
 */
public interface Aware {
}

常見(jiàn)的 Aware 接口及功能

BeanNameAware接口

• 當(dāng)一個(gè) Bean 實(shí)現(xiàn)了BeanNameAware接口時(shí)，它可以獲取自己在 Spring 容器中的 Bean 名稱(chēng)。這個(gè)接口中只有一個(gè)方法setBeanName(String name)，Spring 容器在創(chuàng)建 Bean 的過(guò)程中會(huì)調(diào)用這個(gè)方法，并將 Bean 的名稱(chēng)作為參數(shù)傳遞進(jìn)去。

ApplicationContextAware接口

• 實(shí)現(xiàn)這個(gè)接口的 Bean 可以獲取 Spring 的應(yīng)用上下文（ApplicationContext）對(duì)象。ApplicationContext是 Spring 容器的核心接口，它提供了對(duì)容器中所有 Bean 的訪問(wèn)權(quán)限，還包括獲取資源、發(fā)布事件等多種功能。

BeanFactoryAware接口

• 與ApplicationContextAware類(lèi)似，實(shí)現(xiàn)BeanFactoryAware接口的 Bean 可以獲取 Bean 工廠（BeanFactory）對(duì)象。BeanFactory是 Spring 容器中用于創(chuàng)建和管理 Bean 的基礎(chǔ)接口，相對(duì)ApplicationContext來(lái)說(shuō)更加輕量級(jí)。

ApplicationEventPublisherAware接口

• 如果Bean需要發(fā)布應(yīng)用事件，可以實(shí)現(xiàn)此接口。

ResourceLoaderAware接口

• 如果Bean需要加載資源文件（如XML文件、屬性文件等），可以實(shí)現(xiàn)此接口。

EnvironmentAware接口

• 如果Bean需要訪問(wèn)環(huán)境特定的信息（如配置文件位置、激活的配置文件等），可以實(shí)現(xiàn)此接口。

MessageSourceAware接口

• 如果Bean需要進(jìn)行國(guó)際化處理，可以實(shí)現(xiàn)此接口以獲取消息源。

代碼示例

如：Bean 實(shí)現(xiàn)了 ApplicationContextAware 接口，此時(shí)Spring會(huì)通過(guò) setApplicationContext() 給Bean中的ApplicationContext屬性值賦值。

org.springframework.context.ApplicationContextAware

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

通過(guò)類(lèi)實(shí)現(xiàn)ApplicationContextAware接口，并重寫(xiě)接口中的setApplicationContext()方法，則可以獲取 Spring 的應(yīng)用上下文ApplicationContext對(duì)象

public class SpringContextUtil implements ApplicationContextAware {
    private ApplicationContext applicationContext;
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
    public ApplicationContext getApplicationContext() {
        return applicationContext;
    }
}

Aware 接口中set()的調(diào)用時(shí)機(jī)

在以上代碼中setApplicationContext()方法是spring容器進(jìn)行調(diào)用的，在invokeAwareMethods中統(tǒng)一調(diào)用。
當(dāng)子實(shí)現(xiàn)類(lèi)實(shí)現(xiàn)ApplicationContextAware接口后，當(dāng)前類(lèi)中重寫(xiě)setApplicationContext為接口中setApplicationContext方法。Spring會(huì)在執(zhí)行invokeAwareMethods()時(shí)由容器進(jìn)行賦值。

Spring源碼中的具體實(shí)現(xiàn)如下：
org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#invokeAwareMethods

private void invokeAwareMethods(String beanName, Object bean) {
    //如果 bean 是 Aware 實(shí)例
    if (bean instanceof Aware) {
        //如果bean是BeanNameAware實(shí)例
       if (bean instanceof BeanNameAware) {
           //調(diào)用 bean 的setBeanName方法
          ((BeanNameAware) bean).setBeanName(beanName);
       }
       //如果bean是 BeanClassLoaderAware 實(shí)例
       if (bean instanceof BeanClassLoaderAware) {
           //獲取此工廠的類(lèi)加載器以加載Bean類(lèi)(即使無(wú)法使用系統(tǒng)classLoader,也只能為null)
          ClassLoader bcl = getBeanClassLoader();
          if (bcl != null) {
              //調(diào)用 bean 的 setBeanClassLoader 方法
             ((BeanClassLoaderAware) bean).setBeanClassLoader(bcl);
          }
       }
       //檢查bean是否實(shí)現(xiàn)了BeanFactoryAware，如果是，則調(diào)用其setBeanFactory方法設(shè)置工廠實(shí)例。
       if (bean instanceof BeanFactoryAware) {
          ((BeanFactoryAware) bean).setBeanFactory(AbstractAutowireCapableBeanFactory.this);
       }
    }
}

什么時(shí)候調(diào)用invokeAwareMethods方法

invokeAwareMethods()通常是在Spring容器初始化一個(gè)bean的過(guò)程中被調(diào)用的。

• 具體來(lái)說(shuō)，在bean被創(chuàng)建并配置完成后，但還未完全初始化之前（即在init-method或InitializingBean的afterPropertiesSet()方法調(diào)用之前），Spring框架會(huì)檢查該bean是否實(shí)現(xiàn)了某些特定的接口，如BeanNameAware、BeanFactoryAware等，并相應(yīng)地調(diào)用這些接口的方法來(lái)設(shè)置必要的屬性。
• 這個(gè)過(guò)程是Spring框架內(nèi)部的一部分，用來(lái)確保bean能夠獲得一些關(guān)于自身或者Spring應(yīng)用上下文的信息。
• 例如，讓bean知道自己的名字、所屬的BeanFactory或者是類(lèi)加載器等。這樣可以在bean的生命周期早期給予bean更多的上下文信息。

到此這篇關(guān)于一文看懂 Spring Aware 接口的文章就介紹到這了,更多相關(guān)Spring Aware 接口內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論