Spring條件注解@ConditionnalOnClass的原理分析
前言
用過springboot的小伙伴們都知道,相比于spring,它最大的優(yōu)勢是幫我們省去了一大堆超大一堆繁瑣的配置。比如在spring中,當我們需要在項目中整合第三方插件(如redis、mybatis、rabbitmq)時,往往需要在xml配置文件中去配置這些插件的ConnectionFactory等將其與spring進行整合。而在springboot中,他會根據(jù)項目中引入哪些插件自動地將插件進行整合,這都得益于springboot的自動裝配 或稱為 自動配置。
那么springboot是如何知道我們項目中引入了哪些插件,又怎么知道需要幫助我們配置哪些插件呢?
介紹
所謂@ConditionalOnClass注解,翻譯過來就是基于class的條件,它為所標注的類或方法添加限制條件,當該條件的值為true時,其所標注的類或方法才能生效?;赾lass的意思是在類路徑classpath中存在value()屬性指定的類或存在name()屬性指定的類名。
為了讓上面的介紹更加容易理解,我們就舉個例子吧
在rabbitmq的自動配置類RabbitAutoConfiguration中,有一行注解為@ConditionalOnClass({ RabbitTemplate.class, Channel.class }),則表示當類路徑classpath中存在 RabbitTemplate 和 Channel這兩個類時,該條件注解才會通過,rabbitmq的自動配置RabbitAutoConfiguration才會生效。如下圖所示。由于我項目中已經引入了rabbitmq的依賴,該依賴中存在著兩個類,因此該條件是通過的。
在redis的自動配置類RedisAutoConfiguration中,有一行注解為@ConditionalOnClass(RedisOperations.class),則表示當類路徑classpath中存在 RedisOperations 這個類時,該條件注解才會通過,redis的自動配置RedisAutoConfiguration才會生效。如下圖所示。由于我項目中沒有引入redis的依賴,類路徑classpath中不存在RedisOperations,因此該條件是不通過的,從代碼爆紅即可得知。
正文
是否覺得這個注解如此流批?今天我們從源碼扒開它神秘的面紗。
先看一下該注解的源碼,該注解只提供給我們兩個屬性,實現(xiàn)條件的邏輯在哪呢?
@Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional(OnClassCondition.class) public @interface ConditionalOnClass { // The classes that must be present. Class<?>[] value() default {}; // The classes names that must be present. String[] name() default {}; }
我們應當注意到該注解上還有另一個注解@Conditional(OnClassCondition.class),它才是@ConditionalOnClass注解的核心所在。
那么我們就看一下@Conditional()注解的源碼。該注解通過value()屬性接收一個Condition數(shù)組的參數(shù)。
@Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Conditional { /** * All {@link Condition} classes that must {@linkplain Condition#matches match} * in order for the component to be registered. */ Class<? extends Condition>[] value(); }
那么Condition又是什么?繼續(xù)看源碼。從源碼中我們知道,Condition是一個接口,其內部聲明一個方法matches(),且返回boolean類型的值。
@FunctionalInterface public interface Condition { /** * 決定條件是否通過 * @param context - 條件上下文 * @param metadata - 元數(shù)據(jù),里面標注該注解的類或方法 * @return true-通過,false-不通過 **/ boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata); }
至此,通過兩個注解 + 一個接口,我們可以對@ConditionalOnClass注解得出以下結論:
@Conditional注解接收Condition類型的參數(shù),通過其matches()方法的返回值判斷條件是否通過,而在@ConditionalOnClass注解上向@Conditional注解傳入的實際類型為Condition的實現(xiàn)類OnClassCondition。
現(xiàn)在,我們只需要把目光轉移到Condition接口的實現(xiàn)類OnClassCondition上面來。
OnClassCondition類
OnClassCondition類表示為基于classpath類路徑下的條件,因此它在對條件進行判斷時,都是從classpath類路徑中進行判斷的。這一點從命名上可以看出。 先看一下該類的UML圖吧,對源碼的閱讀有所幫助。
從圖中我們看到,中間兩個類SpringBootCondition 和 FilteringSpringBootCondition均為抽象類,而OnClassCondition為具體實現(xiàn)類,因此我們猜測這里定有模版方法的設計模式,這使代碼讀起來可能有點跳來跳去。
那么我們看一下OnClassCondition是如何實現(xiàn)接口Condition的matches()方法的。但是找來找去并為找到matches()方法,其實該方法是在其父類SpringBootCondition中實現(xiàn)的。
public abstract class SpringBootCondition implements Condition { private final Log logger = LogFactory.getLog(getClass()); /** * matches()方法的實現(xiàn)————決定條件是否通過 * @param context - 條件上下文 * @param metadata - 元數(shù)據(jù),里面標注該注解的類或方法 * @return true-通過,false-不通過 **/ @Override public final boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) { // 獲取方法名或類名 String classOrMethodName = getClassOrMethodName(metadata); try { // 對元數(shù)據(jù)進行判斷,看是否符合要求。 // ConditionOutcome中封裝了判斷的結果和相應的結果信息, ConditionOutcome outcome = getMatchOutcome(context, metadata); // 日志, logOutcome(classOrMethodName, outcome); // 記錄 recordEvaluation(context, classOrMethodName, outcome); // 如果isMatch()的值為true,則表示條件通過 return outcome.isMatch(); } catch (NoClassDefFoundError ex) { // 拋出IllegalStateException異常 } catch (RuntimeException ex) { // 拋出IllegalStateException異常 } } public abstract ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata); }
從SpringBootCondition抽象類中實現(xiàn)的matches()方法來看,它只是提供了一個模版,而真正對條件進行判斷的邏輯在其抽象方法getMatchOutcome()中,OnClassCondition類對該抽象方法提供了實現(xiàn)。這就是設計模式—模版方法的體現(xiàn)。
class OnClassCondition extends FilteringSpringBootCondition { // 該方法分三部分 // 1. 處理ConditionalOnClass注解 // 2. 處理ConditionalOnMissingClass注解 // 3. 返回條件判斷的結果 @Override public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) { ClassLoader classLoader = context.getClassLoader(); // 通過靜態(tài)方法,創(chuàng)建一個ConditionMessage實例,用來保存條件判斷結果對應的信息 ConditionMessage matchMessage = ConditionMessage.empty(); // 1. 處理ConditionalOnClass注解 // 獲取該元數(shù)據(jù)表示的類或方法上的ConditionalOnClass注解中標注的類的限定名, // 表示這些類應當在classpath類路徑中存在,所以叫onClass // 例如:@ConditionalOnClass({ RabbitTemplate.class, Channel.class }), // 則返回RabbitTemplate和Channel的全限定類名 List<String> onClasses = getCandidates(metadata, ConditionalOnClass.class); if (onClasses != null) { // filter()方法內部 對onClass表示的類進行反射,條件為MISSING, // 如果得到的集合不為空,則說明類路徑中不存在ConditionalOnClass注解中標注的類 // 這種情況下直接通過ConditionOutcome.noMatch()封裝ConditionOutcome條件判斷的結果并返回,noMatch()即表示不通過。 List<String> missing = filter(onClasses, ClassNameFilter.MISSING, classLoader); if (!missing.isEmpty()) { return ConditionOutcome.noMatch(ConditionMessage.forCondition(ConditionalOnClass.class) .didNotFind("required class", "required classes").items(Style.QUOTE, missing)); } // 對ConditionalOnClass注解的條件判斷通過,并保存對應的信息到matchMessage matchMessage = matchMessage.andCondition(ConditionalOnClass.class) .found("required class", "required classes") .items(Style.QUOTE, filter(onClasses, ClassNameFilter.PRESENT, classLoader)); } // 2. 處理ConditionalOnMissingClass注解 // 獲取該元數(shù)據(jù)表示的類或方法上的ConditionalOnMissingClass注解中標注的類的限定名, // 表示這些類應當在classpath類路徑中不存在,所以叫onMissingClass // 例如:@ConditionalOnMissingClass({ RabbitTemplate.class, Channel.class }), // 則返回RabbitTemplate和Channel的全限定類名 List<String> onMissingClasses = getCandidates(metadata, ConditionalOnMissingClass.class); if (onMissingClasses != null) { // filter()方法內部 對onMissingClasses表示的類進行反射,條件為PRESENT, // 如果得到的集合不為空,則說明類路徑中存在ConditionalOnMissingClass注解中標注的類 // 這種情況下直接通過ConditionOutcome.noMatch()封裝ConditionOutcome條件判斷的結果并返回,noMatch()即表示不通過。 List<String> present = filter(onMissingClasses, ClassNameFilter.PRESENT, classLoader); if (!present.isEmpty()) { return ConditionOutcome.noMatch(ConditionMessage.forCondition(ConditionalOnMissingClass.class) .found("unwanted class", "unwanted classes").items(Style.QUOTE, present)); } // 對ConditionalOnMissingClass注解的條件判斷通過,并保存對應的信息到matchMessage matchMessage = matchMessage.andCondition(ConditionalOnMissingClass.class) .didNotFind("unwanted class", "unwanted classes") .items(Style.QUOTE, filter(onMissingClasses, ClassNameFilter.MISSING, classLoader)); } // 3. 返回條件判斷的結果,到這一步,就說明ConditionalOnClass注解和ConditionalOnMissingClass注解上的條件都已經通過了。 return ConditionOutcome.match(matchMessage); } }
到這里,我們把抽象父類SpringBootCondition的matches()模版方法,和具體實現(xiàn)類OnClassCondition的getMatchOutcome()真正方法搞定后,就已經對@ConditionalOnClass和@ConditionalOnMissingClass這兩個注解的實現(xiàn)原理搞清楚了。
調用場景
上面我們搞清楚@ConditionalOnClass和@ConditionalOnMissingClass這兩個注解了,但他們內部的邏輯是如何調用的呢?也就是說springboot在啟動過程中,如果通過這兩個注解實現(xiàn)自動裝配的呢?
一般我們能想到的是通過AOP對這兩個注解實現(xiàn)切面,在切面里進行裝配。但其實不是的,我們繼續(xù)往下看。
要想知道m(xù)atches()方法如何被調用起來,打個斷點不就行了。
如下圖所示,我在OnClassCondition的getMatchOutcome()方法上打個條件斷點,以rabbitmq的自動裝配為例,給該斷點添加條件,當方法參數(shù)metadata表示的類為RabbitAutoConfiguration時,進入斷點。
下面我們啟動項目,當springboot要對rabbitmq進行自動裝配時,我們可以看到進入斷點了。
那如何查看該方法是被誰調用的呢?在上面源碼的解析中,我們知道該方法是被其抽象父類的模版方法matches()所調用的。那matches()方法又是誰調用的呢?這就涉及到框架源碼的閱讀技巧了。把目光放在idea的左下方,可以看到方法的調用棧,而棧頂就是斷點的方法getMatchOutcome(),點擊下面的一層就可以回到抽象父類的模版方法matches()
再點擊調用棧下面的一層,就可以看到調用matches()方法的地方
shouldSkip()方法是springboot啟動過程中重要的一環(huán)。大家都知道springboot在啟動過程中會將很多類作為spring的Bean放在IOC容器中,但有些類是不需要添加到容器中的,這種情況下shouldSkip()方法就返回true表示應當跳過當前類不要把它放到IOC容器中。
而在shouldSkip()方法中,判斷當前類應當跳過的重要依據(jù)就是matches()方法返回false(即條件判斷不通過)。
到此這篇關于Spring條件注解@ConditionnalOnClass的原理分析的文章就介紹到這了,更多相關條件注解@ConditionnalOnClass內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
Intellij IDEA 2019 最新亂碼問題及解決必殺技(必看篇)
大家在使用Intellij IDEA 的時候會經常遇到各種亂碼問題,今天小編給大家分享一些關于Intellij IDEA 2019 最新亂碼問題及解決必殺技,感興趣的朋友跟隨小編一起看看吧2020-04-04Java實現(xiàn)在線考試系統(tǒng)與設計(學生功能)
這篇文章主要介紹了Java實現(xiàn)在線考試系統(tǒng)與設計(學生功能),本文通過實例代碼給大家介紹的非常詳細,具有一定的參考借鑒價值,需要的朋友可以參考下2020-02-02SpringBoot詳細分析自動裝配原理并實現(xiàn)starter
相對于傳統(tǒng)意義上的Spring項目,SpringBoot具有開箱即用,簡化配置,內置Tomcat等等等等一系列的特點。在這些特點中,最重要的兩條就是約定優(yōu)于配置和自動裝配2022-07-07關于MyBatisSystemException異常產生的原因及解決過程
文章講述了在使用MyBatis進行數(shù)據(jù)庫操作時遇到的異常及其解決過程,首先考慮了事務問題,但未解決,接著懷疑是MyBatis的一級緩存問題,關閉緩存后問題依舊存在,最終發(fā)現(xiàn)是SQL映射文件中的參數(shù)傳遞錯誤,使用了錯誤的標簽導致循環(huán)插入2025-01-01