淺析對Spring?aware接口理解
1. aware接口的作用
通過aware接口可以獲取Spring容器相關(guān)信息,但這樣會(huì)與Spring容器耦合。
2. 常用aware接口及作用
執(zhí)行順序從上到下。
類名 | 作用 |
---|---|
BeanNameAware | 獲得容器中bean名稱 |
BeanClassLoaderAware | 獲得類加載器 |
BeanFactoryAware | 獲得bean創(chuàng)建工廠 |
EnvironmentAware | 獲得環(huán)境變量 |
EmbeddedValueResolverAware | 獲取spring容器加載的properties文件屬性值 |
ResourceLoaderAware | 獲得資源加載器 |
ApplicationEventPublisherAware | 獲得應(yīng)用事件發(fā)布器 |
MessageSourceAware | 獲得文本信息 |
ApplicationContextAware | 獲得當(dāng)前應(yīng)用上下文 |
3. 使用樣例:ApplicationContextAware 在Bean中獲取上下文
/** * 獲取spring注入對象方法 */ @Component("springUtil") public final class SpringUtil implements ApplicationContextAware { /** * 應(yīng)用上下文 */ private static ApplicationContext applicationContext; /** * public方法可能被調(diào)用,導(dǎo)致線程不安全。這樣寫也是為了通過sonar檢測 * @param applicationContext 通過aware設(shè)置上下文 */ @Override public void setApplicationContext(@NonNull ApplicationContext applicationContext) { synchronized (SpringUtil.class) { if (null == SpringUtil.applicationContext) { SpringUtil.applicationContext = applicationContext; } } } /** * 獲取注入對象 * * @param name 對象名稱 * @return 指定注入對象 */ public static Object getBean(String name) { return getApplicationContext().getBean(name); } private static ApplicationContext getApplicationContext() { return applicationContext; } /** * 獲取注入對象 * * @param clazz 對象類型 * @param <T> 泛型 * @return 指定注入對象 */ public static <T> T getBean(Class<T> clazz) { return getApplicationContext().getBean(clazz); } /** * 獲取注入對象 * * @param name 對象名稱 * @param clazz 對象類型 * @param <T> 泛型 * @return 指定注入對象 */ public static <T> T getBean(String name, Class<T> clazz) { return getApplicationContext().getBean(name, clazz); } }
4. 自定義aware的方式
先定義一個(gè)繼承Aware的接口,然后注冊一個(gè)實(shí)現(xiàn)BeanPostProcessor接口的Bean,在postProcessBeforeInitialization中處理Aware接口的邏輯。
舉一個(gè)例子。獲取調(diào)用自定義Aware接口方法的時(shí)間。
4.1 定義繼承Aware的接口
public interface TimeAware extends Aware { void setTriggerTime(Date date); }
4.2 注冊實(shí)現(xiàn)BeanPostProcessor接口的Bean
@Component public class AwarePostProcessor implements BeanPostProcessor { private final ConfigurableApplicationContext applicationContext; /** * 可寫可不寫,這個(gè)構(gòu)造是為了獲取applicationContext */ public AwarePostProcessor(ConfigurableApplicationContext applicationContext) { this.applicationContext = applicationContext; } @Override public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { if (bean instanceof Aware) { if (bean instanceof TimeAware) { // 實(shí)現(xiàn)自定義Aware接口的邏輯,設(shè)置調(diào)用的時(shí)間 ((TimeAware)bean).setTriggerTime(new Date()); } } return bean; } }
4.3 實(shí)現(xiàn)TimeAware接口,并測試
@Import(AwarePostProcessor.class) public class Test implements TimeAware { Date date; @Override public void setTriggerTime(Date date) { this.date = date; } public static void main(String[] args) { ApplicationContext context = new AnnotationConfigApplicationContext(Test.class); Test bean = context.getBean(Test.class); System.out.println(bean.date); } }
結(jié)果:
5. 源碼處理方式
- Bean實(shí)例化->填充屬性->初始化,在初始化階段將實(shí)現(xiàn)aware接口的Bean的方法執(zhí)行。
1.先執(zhí)行實(shí)現(xiàn)了下面三個(gè)aware接口的方法
- BeanNameAware
- BeanClassLoaderAware
- BeanFactoryAware
2.調(diào)用初始化方法
3.執(zhí)行實(shí)現(xiàn)剩下aware接口的方法
5.1 初始化階段的源碼邏輯
AbstractAutowireCapableBeanFactory#initializeBean
protected Object initializeBean(String beanName, Object bean, @Nullable RootBeanDefinition mbd) { if (System.getSecurityManager() != null) { AccessController.doPrivileged((PrivilegedAction<Object>) () -> { invokeAwareMethods(beanName, bean); return null; }, getAccessControlContext()); } else { /** * 調(diào)用Bean實(shí)現(xiàn)的Aware接口的方法,主要包括下面三個(gè)接口 * BeanNameAware ----> setBeanName() * BeanClassLoaderAware ----> setBeanClassLoader() * BeanFactoryAware ----> setBeanFactory() */ invokeAwareMethods(beanName, bean); } Object wrappedBean = bean; if (mbd == null || !mbd.isSynthetic()) { /** 調(diào)用Bean對象的postProcessBeforeInitialization方法,此處會(huì)執(zhí)行標(biāo)注@PostConstruct注解的方法 */ // 此處會(huì)調(diào)用ApplicationContextAwareProcessor執(zhí)行其他的aware方法. wrappedBean = applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName); } try { /** * 執(zhí)行Bean的初始化方法: * * 1.先判斷Bean是否實(shí)現(xiàn)了InitializingBean接口,如果實(shí)現(xiàn)了InitializingBean接口,則調(diào)用Bean對象的afterPropertiesSet方法; * 2.然后判斷Bean是否有指定init-method方法,如果指定了init-method方法,則調(diào)用bean對象的init-method指定的方法. */ invokeInitMethods(beanName, wrappedBean, mbd); } catch (Throwable ex) { throw new BeanCreationException( (mbd != null ? mbd.getResourceDescription() : null), beanName, "Invocation of init method failed", ex); } if (mbd == null || !mbd.isSynthetic()) { /** * 調(diào)用Bean對象的postProcessAfterInitialization方法 * * 如果需要?jiǎng)?chuàng)建代理,在該步驟中執(zhí)行postProcessAfterInitialization方法的時(shí)候會(huì)去創(chuàng)建代理 * 調(diào)用AbstractAutoProxyCreator類的postProcessAfterInitialization方法,然后調(diào)用wrapIfNecessary方法去創(chuàng)建代理. * * * 另外還有一些Aware接口,也會(huì)在該步驟中執(zhí)行,例如:ApplicationContextAwareProcessor后置處理器,對應(yīng)的setApplicationContext方法會(huì)被執(zhí)行. */ wrappedBean = applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName); } return wrappedBean; }
5.2 實(shí)現(xiàn)前三個(gè)aware接口的處理
調(diào)用initializeBean =>invokeAwareMethods方法將前三個(gè)aware方法調(diào)用
AbstractAutowireCapableBeanFactory#invokeAwareMethods
private void invokeAwareMethods(String beanName, Object bean) { if (bean instanceof Aware) { if (bean instanceof BeanNameAware) { ((BeanNameAware) bean).setBeanName(beanName); } if (bean instanceof BeanClassLoaderAware) { ClassLoader bcl = getBeanClassLoader(); if (bcl != null) { ((BeanClassLoaderAware) bean).setBeanClassLoader(bcl); } } if (bean instanceof BeanFactoryAware) { ((BeanFactoryAware) bean).setBeanFactory(AbstractAutowireCapableBeanFactory.this); } } }
5.3 剩余實(shí)現(xiàn)aware接口的Bean的處理
調(diào)用initializeBean =>applyBeanPostProcessorsBeforeInitialization=>BeanPostProcessor.postProcessBeforeInitialization
進(jìn)入ApplicationContextAwareProcessor#postProcessBeforeInitialization=>invokeAwareInterfaces
private void invokeAwareInterfaces(Object bean) { if (bean instanceof EnvironmentAware) { ((EnvironmentAware) bean).setEnvironment(this.applicationContext.getEnvironment()); } if (bean instanceof EmbeddedValueResolverAware) { ((EmbeddedValueResolverAware) bean).setEmbeddedValueResolver(this.embeddedValueResolver); } if (bean instanceof ResourceLoaderAware) { ((ResourceLoaderAware) bean).setResourceLoader(this.applicationContext); } if (bean instanceof ApplicationEventPublisherAware) { ((ApplicationEventPublisherAware) bean).setApplicationEventPublisher(this.applicationContext); } if (bean instanceof MessageSourceAware) { ((MessageSourceAware) bean).setMessageSource(this.applicationContext); } if (bean instanceof ApplicationContextAware) { ((ApplicationContextAware) bean).setApplicationContext(this.applicationContext); } }
因此可以自定義aware接口,并且注冊一個(gè)實(shí)現(xiàn)BeanPostProcessor的postProcessBeforeInitialization方法的Bean,處理調(diào)用aware方法時(shí)的處理邏輯。
相關(guān)文章
java虛擬機(jī)深入學(xué)習(xí)之內(nèi)存管理機(jī)制
java虛擬機(jī)在程序運(yùn)行時(shí)將內(nèi)存劃分為多個(gè)區(qū)域,每個(gè)區(qū)域作用,生命周期各不相同,下面這篇文章主要給大家介紹了關(guān)于java虛擬機(jī)深入學(xué)習(xí)之內(nèi)存管理機(jī)制的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),需要的朋友可以參考下2018-11-11Spring Boot 使用 Swagger 構(gòu)建 RestAPI 接口文檔
這篇文章主要介紹了Spring Boot 使用 Swagger 構(gòu)建 RestAPI 接口文檔,幫助大家更好的理解和使用Spring Boot框架,感興趣的朋友可以了解下2020-10-10Java Socket實(shí)現(xiàn)多線程通信功能示例
這篇文章主要介紹了Java Socket實(shí)現(xiàn)多線程通信功能,結(jié)合具體實(shí)例形式較為詳細(xì)的分析了java多線程通信的原理及客戶端、服務(wù)器端相應(yīng)實(shí)現(xiàn)技巧,需要的朋友可以參考下2017-06-06DolphinScheduler容錯(cuò)Master源碼分析
這篇文章主要為大家介紹了DolphinScheduler容錯(cuò)Master源碼分析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-02-02Spring ApplicationContextAware 接口的作用及使用方式
Spring提供了許多回調(diào)接口,用于Bean生命周期中執(zhí)行特定的操作,通過實(shí)現(xiàn)ApplicationContextAware接口,Spring提供了一種便捷的方式讓 Bean獲取對Spring容器的引用,本文介紹ApplicationContextAware接口的作用、使用方式,以及在實(shí)際應(yīng)用中的常見場景,感興趣的朋友一起看看吧2024-01-01詳談hibernate,jpa與spring?data?jpa三者之間的關(guān)系
這篇文章主要介紹了hibernate,jpa與spring?data?jpa三者之間的關(guān)系,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-11-11