Spring通過工具類實現(xiàn)獲取容器中的Bean
1. Aware 接口
小伙伴們知道,Spring 容器最大的特點在于所有的 Bean 對于 Spring 容器的存在是沒有意識的,因此我們常說理論上你可以無縫將 Spring 容器切換為其他容器(然而在現(xiàn)實世界中,我們其實沒有這樣的選擇,除了 Spring 容器,難道還有更好用的?)。
當(dāng)然這只是一個理論,在實際開發(fā)中,我們往往要用到 Spring 容器為我們提供的諸多資源,例如想要獲取到容器中的配置、獲取到容器中的 Bean 等等。在這種情況下,就需要 Spring 容器中的 Bean 真正的意識到 Spring 容器的存在,才能要到這些東西,那么如何讓一個 Bean 意識到 Spring 容器的存在呢?
這就依賴于 Spring 容器給我們提供的各種 Aware 接口了。
/** ?*?A?marker?superinterface?indicating?that?a?bean?is?eligible?to?be?notified?by?the ?*?Spring?container?of?a?particular?framework?object?through?a?callback-style?method. ?*?The?actual?method?signature?is?determined?by?individual?subinterfaces?but?should ?*?typically?consist?of?just?one?void-returning?method?that?accepts?a?single?argument. ?* ?*?<p>Note?that?merely?implementing?{@link?Aware}?provides?no?default?functionality. ?*?Rather,?processing?must?be?done?explicitly,?for?example?in?a ?*?{@link?org.springframework.beans.factory.config.BeanPostProcessor}. ?*?Refer?to?{@link?org.springframework.context.support.ApplicationContextAwareProcessor} ?*?for?an?example?of?processing?specific?{@code?*Aware}?interface?callbacks. ?* ?*?@author?Chris?Beams ?*?@author?Juergen?Hoeller ?*?@since?3.1 ?*/ public?interface?Aware?{ }
從這個接口的注釋中,我們也能大概看出來,這個接口的子類,主要是提供了一些只有一個參數(shù)的 set 方法,通過這些方法可以讓 Spring 容器感知到某一件事情。
Aware 的實現(xiàn)有很多,大的方向來說主要有如下一些:
每一個 Aware 的作用如下:
- ApplicationEventPublisherAware:實現(xiàn)該接口的對象可以獲取事件發(fā)布的能力。
- ServletContextAware:實現(xiàn)該接口的對象可以獲取到 ServletContext 對象。
- MessageSourceAware:實現(xiàn)該接口的對象可以獲取到 MessageSource 對象,MessageSource 支持多消息源,主要用于主要用于國際化。
- ResourceLoaderAware:實現(xiàn)該接口的對象可以獲取到一個 ResourceLoader,Spring ResourceLoader 則為我們提供了一個統(tǒng)一的 getResource() 方法來通過資源路徑檢索外部資源,例如文本文件、XML 文件、屬性文件或圖像文件等。
- ApplicationStartupAware:實現(xiàn)該接口的對象可以獲取到一個 ApplicationStartup 對象,這個比較新,是 Spring 5.3 中新推出的,通過 ApplicationStartup 可以標(biāo)記應(yīng)用程序啟動期間的步驟,并收集有關(guān)執(zhí)行上下文或其處理時間的數(shù)據(jù)。
- NotificationPublisherAware:實現(xiàn)該接的對象可以獲取到一個 NotificationPublisher 對象,通過該對象可以實現(xiàn)通知的發(fā)送。
- EnvironmentAware:實現(xiàn)該接口的對象可以獲取到一個 Environment 對象,通過 Environment 可以獲取到容器的環(huán)境信息。
- BeanFactoryAware:實現(xiàn)該接口的對象可以獲取到一個 BeanFactory 對象,通過 BeanFactory 可以完成 Bean 的查詢等操作。
- ImportAware:實現(xiàn)該接口的對象可以獲取到一個 AnnotationMetadata 對象,ImportAware 接口是需要和 @Import 注解一起使用的。在 @Import 作為元注解使用時,通過 @Import 導(dǎo)入的配置類如果實現(xiàn)了 ImportAware 接口就可以獲取到導(dǎo)入該配置類接口的數(shù)據(jù)配置。
- EmbeddedValueResolverAware:實現(xiàn)該接口的對象可以獲取到一個 StringValueResolver 對象,通過 StringValueResolver 對象,可以讀取到 Spring 容器中的 properties 配置的值(YAML 配置也可以)。
- ServletConfigAware:實現(xiàn)該接口的對象可以獲取到一個 ServletConfig 對象,不過這個似乎沒什么用,我們很少自己去配置 ServletConfig。
- LoadTimeWeaverAware:實現(xiàn)該接口的對象可以獲取到一個 LoadTimeWeaver 對象,通過該對象可以獲取加載 Spring Bean 時織入的第三方模塊,如 AspectJ 等。
- BeanClassLoaderAware:實現(xiàn)該接口的對象可以獲取到一個 ClassLoader 對象,ClassLoader 能干嘛不需要我多說了吧。
- BeanNameAware:實現(xiàn)該接口的對象可以獲取到一個當(dāng)前 Bean 的名稱。
- ApplicationContextAware:實現(xiàn)該接口的對象可以獲取到一個 ApplicationContext 對象,通過 ApplicationContext 可以獲取容器中的 Bean、環(huán)境等信息。
這是 Spring 中提供的一堆 Aware。
接下來松哥隨便寫個例子大家來看下 Aware 的用法。
2. BeanFactoryAware
實現(xiàn)該接口的對象可以獲取到一個 BeanFactory 對象,通過 BeanFactory 可以完成 Bean 的查詢等操作。這算是一個比較常見的 Aware 了,我們一起來看下。
這里為了省事,我就在 Spring Boot 中來和大家演示。
首先我們來定義一個簡單的 UserService:
@Service public?class?UserService?{ ????public?void?hello()?{ ????????System.out.println("hello?javaboy!"); ????} }
然后提供一個工具類:
@Component public?class?BeanUtils?implements?BeanFactoryAware?{ ????private?static?BeanFactory?beanFactory?=?null; ????@Override ????public?void?setBeanFactory(BeanFactory?beanFactory)?throws?BeansException?{ ????????BeanUtils.beanFactory?=?beanFactory; ????} ????public?static?<T>?T?getBean(String?beanName)?{ ????????return?(T)?beanFactory.getBean(beanName); ????} }
有了這個工具類,接下來我們就可以在一個非 Spring 管理的 Bean 中,隨時隨地的查詢 Bean 了,像下面這樣:
UserService?userService?=?BeanUtils.getBean("userService"); userService.hello();
3. TienChin 項目實踐
為什么會有今天這篇文章呢?主要是在松哥最近做的 TienChin 項目中,有一個地方涉及到這塊知識點了,但是有的小伙伴不熟悉,因此就拎出來和大家梳理下。
在 TienChin 項目中,在記錄日志的時候,因為日志是一個延遲任務(wù),所以提前準(zhǔn)備好了相關(guān)的 Bean 已經(jīng)注冊到 Spring 容器中了,像下面這樣:
@Configuration public?class?ThreadPoolConfig?{ ????/** ?????*?執(zhí)行周期性或定時任務(wù) ?????*/ ????@Bean(name?=?"scheduledExecutorService") ????protected?ScheduledExecutorService?scheduledExecutorService()?{ ????????return?new?ScheduledThreadPoolExecutor(corePoolSize, ????????????????new?BasicThreadFactory.Builder().namingPattern("schedule-pool-%d").daemon(true).build(), ????????????????new?ThreadPoolExecutor.CallerRunsPolicy())?{ ????????????@Override ????????????protected?void?afterExecute(Runnable?r,?Throwable?t)?{ ????????????????super.afterExecute(r,?t); ????????????????Threads.printException(r,?t); ????????????} ????????}; ????} } @Component public?final?class?SpringUtils?implements?BeanFactoryPostProcessor,?ApplicationContextAware?{ ????/** ?????*?Spring應(yīng)用上下文環(huán)境 ?????*/ ????private?static?ConfigurableListableBeanFactory?beanFactory; ????private?static?ApplicationContext?applicationContext; ????@Override ????public?void?postProcessBeanFactory(ConfigurableListableBeanFactory?beanFactory)?throws?BeansException?{ ????????SpringUtils.beanFactory?=?beanFactory; ????} ????@Override ????public?void?setApplicationContext(ApplicationContext?applicationContext)?throws?BeansException?{ ????????SpringUtils.applicationContext?=?applicationContext; ????} ????/** ?????*?獲取對象 ?????* ?????*?@param?name ?????*?@return?Object?一個以所給名字注冊的bean的實例 ?????*?@throws?org.springframework.beans.BeansException ?????*/ ????@SuppressWarnings("unchecked") ????public?static?<T>?T?getBean(String?name)?throws?BeansException?{ ????????return?(T)?beanFactory.getBean(name); ????} ????/** ?????*?獲取類型為requiredType的對象 ?????* ?????*?@param?clz ?????*?@return ?????*?@throws?org.springframework.beans.BeansException ?????*/ ????public?static?<T>?T?getBean(Class<T>?clz)?throws?BeansException?{ ????????T?result?=?(T)?beanFactory.getBean(clz); ????????return?result; ????} }
而寫日志的異步任務(wù)工具類,并非一個容器,所以要通過這個工具類獲取相應(yīng)的 Bean,如下:
public?class?AsyncManager?{ ????/** ?????*?操作延遲10毫秒 ?????*/ ????private?final?int?OPERATE_DELAY_TIME?=?10; ????/** ?????*?異步操作任務(wù)調(diào)度線程池 ?????*/ ????private?ScheduledExecutorService?executor?=?SpringUtils.getBean("scheduledExecutorService"); ????/** ?????*?單例模式 ?????*/ ????private?AsyncManager()?{ ????} ????private?static?AsyncManager?me?=?new?AsyncManager(); ????public?static?AsyncManager?me()?{ ????????return?me; ????} ????/** ?????*?執(zhí)行任務(wù) ?????* ?????*?@param?task?任務(wù) ?????*/ ????public?void?execute(TimerTask?task)?{ ????????executor.schedule(task,?OPERATE_DELAY_TIME,?TimeUnit.MILLISECONDS); ????} }
有了 SpringUtils 我們就可以在一個非 Spring 容器所管理的 Bean 中,獲取到 Spring 容器中的 Bean 了。
到此這篇關(guān)于Spring通過工具類實現(xiàn)獲取容器中的Bean的文章就介紹到這了,更多相關(guān)Spring獲取Bean內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring?Cache+Redis緩存數(shù)據(jù)的實現(xiàn)示例
本文主要介紹了Spring?Cache+Redis緩存數(shù)據(jù),文中通過示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2022-01-01Java中mybatis關(guān)于example類的使用詳解
這篇文章主要介紹了Java中mybatis中關(guān)于example類的使用詳解,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07SpringBoot應(yīng)用能直接運行java -jar的原因分析
這篇文章主要介紹了SpringBoot應(yīng)用為什么能直接運行java -jar,首先明確一點,普通jar包是不能直接運行的,比如工具類jar,要能運行,至少得要一個main函數(shù)作為入口吧?本文給大家介紹了詳細的原因分析,需要的朋友可以參考下2024-03-03MyBatis將查詢出的兩列數(shù)據(jù)裝配成鍵值對的操作方法
這篇文章主要介紹了MyBatis將查詢出的兩列數(shù)據(jù)裝配成鍵值對的操作代碼,本文通過實例代碼給大家介紹的非常詳細,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2022-08-08