Spring框架的ImportSelector詳細解讀
前言
最近一直在鉆研Spring源碼,感覺要把自己看吐了,但是看到奧妙的地方還是會拍手稱快。
這次就總結一下Spring中一個非常重要的注解@Import中的ImportSelector接口的作用以及它到底有啥作用。
也會捎帶一部分源碼說一下DeferredImportSelector是干啥的,以及Spring解析這個和ImportSelector有什么區(qū)別。
ImportSelector
說到ImportSelector這個接口就不得不說這里面最重要的一個方法:selectImports()。
public interface ImportSelector {
/**
* Select and return the names of which class(es) should be imported based on
* the {@link AnnotationMetadata} of the importing @{@link Configuration} class.
* 選擇并返回需要導入的類的名稱,這些類基于AnnotationMetadata
* 并且導入到@Configuration注解的類中的
* @return the class names, or an empty array if none
* 返回所有的class name,如果沒有,就返回空
*/
String[] selectImports(AnnotationMetadata importingClassMetadata);
/**
* 返回排除的類,是一個類過濾器,但是這個方法被default注解了,
* 可見Spring公司也知道,這個基本沒啥人用
*/
@Nullable
default Predicate<String> getExclusionFilter() {
return null;
}
}源碼的注解里說了一大堆,就直接說這個方法能干啥吧。這個方法的返回值是一個字符串數組,只要在配置類被引用了,這里返回的字符串數組中的類名就會被Spring容器new出來,然后再把這些對象放到工廠當中去。所以這有啥用呢?我們還是用一個例子演示一下。
ImportSelector簡單例子
首先我們先有一個實現(xiàn)了ImportSelector的類MyImportSelect,再構造一個業(yè)務類IndexDao,然后配置類用@Import引入,最后測試類Test。
/**
* 由于我們使用的ImportSelector所以就不需要放到Spring容器當中了。
* 我們要用@Import這個注解引入進去。
*/
public class MyImportSelect implements ImportSelector {
@Override
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
return new String[]{IndexDao.class.getName()};
}
}@ComponentScan("com.demo")
@Import(MyImportSelect.class)
public class AppConfig {
}public class IndexDao {
public void query(){
System.out.println("query IndexDao for MyImportSelect");
}
}public class Test {
public static void main(String[] args) {
AnnotationConfigApplicationContext anno=new AnnotationConfigApplicationContext(AppConfig.class);
anno.getBean(IndexDao.class).query();
}
}
運行打印
query IndexDao for MyImportSelect從上面的例子看,盡管程序上沒有把MyImportSelect類放到Spring容器中,也沒有把IndexDao放到Spring容器中,但是在測試上就可以把IndexDao從容器中拿出來,并且正常執(zhí)行。
不知道大家看到這里有什么感覺,到這里我其實是有疑問的。我這么做有個卵用噻。我是有病吧,直接把類上加個@Component注冊進去不香嗎?所以這個ImportSelector把程序搞這么復雜是有毛病吧,把簡單的功能搞這么復雜。
ImportSelector真正的作用
其實Spring公司既然這么設計,那肯定是有用的。那么有什么用呢?設想這樣一個場景,如果有些功能我們并不需要Spring在一開始就加載進去,而是需要Spring幫助我們把這些功能動態(tài)加載進去,這時候這個ImportSelector的作用就來了。我們完全可以把實現(xiàn)這個接口的類做成一個開關,用來開啟或者關閉某一個或者某些功能類。
比如說我們上面的例子IndexDao,假設這個IndexDao實現(xiàn)的功能是一個擴展功能,在正式的生產上不一定用的到。如果說一個包下有100個類,那么使用掃描去屏蔽這個類就很麻煩,但是屏蔽這個類用ImportSelector去做就很容易了。下次如果需要用到了,我再放開這個開關,直接可以使用IndexDao的功能了,這樣就做到了一個靈活的功能掌控。
再舉一個實際的用例,假設我們的IndexDao不是打印而是返回一個針對代理IndexDao3的代理對象,比如輸出一個log。但是這個方法我不一定會用到,因為只有需要用到代理的時候,這個方法才有意義。我不需要去代理,這里的代碼就不要運行。只有給一個顯示的通知,我這個代理才會去執(zhí)行。
public class IndexDao {
public void query(){
System.out.println("log for IndexDao3");
return Proxy.newProxyInstance(IndexDao3);//偽碼
}
}看到這里,大家有沒有聯(lián)想到SpringAOP其實就是這個樣子。能夠做到動態(tài)加載與卸載,與我們的程序沒有什么耦合關系。怎么才能實現(xiàn)這個所謂的動態(tài)開啟呢?
ImportSelector開關
為了完成這個開關,我們也模仿Spring寫一個EnableMySelector的注解,然后@Import我們自己的ImportSelector接口類。
@Retention(RetentionPolicy.RUNTIME) //開啟運行時加載
@Import(MyImportSelect.class)
public @interface EnableMySelector {
}
做好了這一步在AppConfig這個配置里面就可以直接使用這個@ EnableMySelector自定義注解去開關一個類了。
@ComponentScan("com.demo")
@EnableMySelector
public class AppConfig { }
運行,一樣打印
query IndexDao for MyImportSelect
講道理其實Spring中那么多的EnableXXXX的注解底層就是這樣的原理。到此還有誰敢說ImportSelector用處?。?/p>
連帶說一下DeferredImportSelector
這個是看Spring源碼的時候發(fā)現(xiàn)的,直接翻譯就是延時加載ImportSelector,實現(xiàn)這個接口的類,將會在@Configuration后面被加載,用法什么的和ImportSelector功能基本一樣。因為用的比較稀有就不多做解釋了,僅僅作為一個只是擴展點介紹下。在ConfigurationClassParser中會有一個判斷,是不是這個接口,如果是就會放到后面解析。以下摘自源碼:
org.springframework.context.annotation.ConfigurationClassParser#processImports
//這里攔截了DeferredImportSelector然后使用handle()
if (selector instanceof DeferredImportSelector) {
this.deferredImportSelectorHandler.handle(configClass, (DeferredImportSelector) selector);
}進入handle()方法,發(fā)現(xiàn)和這個接口相關的都被加入了一個deferredImportSelectors的list中。
public void handle(ConfigurationClass configClass, DeferredImportSelector importSelector) {
DeferredImportSelectorHolder holder = new DeferredImportSelectorHolder(configClass, importSelector);
if (this.deferredImportSelectors == null) {
DeferredImportSelectorGroupingHandler handler = new DeferredImportSelectorGroupingHandler();
handler.register(holder);
handler.processGroupImports();
}
else {
//加入到了一個ArrayList中
this.deferredImportSelectors.add(holder);
}
}最終這個ArrayList在parse()方法的最后被處理了
org.springframework.context.annotation.ConfigurationClassParser#parse(java.util.Set<org.springframework.beans.factory.config.BeanDefinitionHolder>)
public void parse(Set<BeanDefinitionHolder> configCandidates) {
//根據BeanDefinition的類型做不同的處理,一般都會調用ConfigurationClassParser.parse()進行解析
for (BeanDefinitionHolder holder : configCandidates) {
BeanDefinition bd = holder.getBeanDefinition(); //拿出BeanDefinition
try {
if (bd instanceof AnnotatedBeanDefinition) { //判斷是不是加了注解的
// 解析注解對象,并且把解析出來的bd方法map中,但是這里的bd指的的普通的
// 普通和不普通的怎么區(qū)分。比如@Bean和各種beanFactoryPostProcessor得到的bean
//如果被加了注解,又調用了一個parse()方法
parse(((AnnotatedBeanDefinition) bd).getMetadata(), holder.getBeanName());
}
else if (bd instanceof AbstractBeanDefinition && ((AbstractBeanDefinition) bd).hasBeanClass()) {
parse(((AbstractBeanDefinition) bd).getBeanClass(), holder.getBeanName());
}
else {
parse(bd.getBeanClassName(), holder.getBeanName());
}
}
catch (BeanDefinitionStoreException ex) {
throw ex;
}
catch (Throwable ex) {
throw new BeanDefinitionStoreException(
"Failed to parse configuration class [" + bd.getBeanClassName() + "]", ex);
}
}
//處理,而此時上面其他的Import已經處理完了
this.deferredImportSelectorHandler.process();
}到此這篇關于Spring框架的ImportSelector詳細解讀的文章就介紹到這了,更多相關ImportSelector詳細解讀內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
Spring Boot中使用Server-Sent Events (SSE) 實
Server-Sent Events (SSE) 是HTML5引入的一種輕量級的服務器向瀏覽器客戶端單向推送實時數據的技術,本文主要介紹了Spring Boot中使用Server-Sent Events (SSE) 實現(xiàn)實時數據推送教程,具有一定的參考價值,感興趣的可以了解一下2024-03-03
注冊中心配置了spring?security后客戶端啟動報錯
這篇文章主要為大家介紹了注冊中心配置了spring?security后客戶端啟動報錯問題解決,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-07-07

