詳解SpringBoot中@ConditionalOnClass注解的使用
今天給大家?guī)淼氖莝pringboot中的@ConditionalOnClass注解的用法。上次的@ConditionalOnBean注解還記得嗎？
一、@ConditionalOnClass注解初始
看下@CodidtionalOnClass注解的定義，
需要注意的有兩點(diǎn)，
- 該注解可以用在類及方法上；類指的是標(biāo)有@Configuration的類，方法是標(biāo)有@Bean的方法；
- 該注解使用了@Conditional注解標(biāo)記；這是重點(diǎn)
看到這里，有小伙伴會(huì)疑惑，講了那么多@Conditional注解的作用是什么，不急，作用馬上來。
@ConditionalOnClass注解的作用是當(dāng)項(xiàng)目中存在某個(gè)類時(shí)才會(huì)使標(biāo)有該注解的類或方法生效；
這句話有點(diǎn)拗口，通俗的講，@ConditionalOnClass標(biāo)識(shí)在@Configuration類上，只有存在@ConditionalOnClass中value/name配置的類該Configuration類才會(huì)生效；@ConditionalOnClass標(biāo)識(shí)在@Bean方法上，只有只有存在@ConditionalOnClass中value/name配置的類方法才會(huì)生效?？淳唧w的實(shí)例更容易理解些
二、@ConditionalOnClass注解用法
從上面@ConditionalOnClass注解的定義中我們知道該注解可以配置兩個(gè)屬性，分別是value和name，其中value和name都是數(shù)組，只不過內(nèi)容不一樣，
value是Class的數(shù)組，name是全限類名的字符串。
1、使用value屬性
開始，我一直使用value屬性進(jìn)行配置，但是總是報(bào)錯(cuò)，比如我配置
@Configuration
@ConditionalOnClass(value = {Client.class})
public class MyAutoConfig {
public MyAutoConfig(){
System.out.println("constructor MyAutoConfig");
}
}該Client是下面的類，
org.springframework.boot.autoconfigure.data.elasticsearch.Client
它是ES中的一個(gè)類，我本身配置的含義是只有在Client存在的時(shí)候MyAutoConfig才會(huì)生效，但是總是不成功。你知道為什么不成功嗎？
這是因?yàn)槲覜]有引ES的依賴，導(dǎo)致在我的classpath中沒有這個(gè)類，按照@ConditionalOnClass的理解，應(yīng)該是不存在則不會(huì)生效，但是由于沒有這個(gè)類，導(dǎo)致的問題是：無法編譯，提示下面的錯(cuò)誤
java: 找不到符號(hào)
符號(hào): 類 Client
這是可以理解的，因?yàn)闆]有這個(gè)類，而我要引用這個(gè)類肯定是引用不到的，所以編譯是失敗的，也就程序跑不起來。那么存在一個(gè)問題，@ConditionalOnClass注解的value屬性要在什么情況下使用？
這里有一個(gè)mybatisplus的配置類，
其配置類上標(biāo)識(shí)了@ConditionalOnClass注解，該注解中配置了value屬性，且配置了SqlSessionFactory和SqlSessionFactoryBean兩個(gè)類，
MyBatisPlusAutoConfiguration是在mybatis-plus-boot-starter的jar包下
SqlSessionFactory是在mybatis的jar包下
SqlSessionFactoryBean是在mybaits-spring的jar包下
這三個(gè)類分屬于不同的jar包，如果我在一個(gè)項(xiàng)目中引入了mybatis-plus-boot-starter的jar包，沒有引入mybatis的jar包那么MybatisPlusAutoConfiguration不會(huì)生效，也就是只有mybatis和mybatis-spring的jar包都引入了，MybatisPlusAutoConfiguration才會(huì)生效，才會(huì)被納入spring容器的管理。
需要注意一點(diǎn)：為了防止少引包，在mybatis-plus-boot-starter中會(huì)依賴mybatis和mybatis-spring，這也是starter的好處，不會(huì)少引包，需要哪些依賴它都引好了。
那么再回到問題的開始，為什么，我配置了一個(gè)不存在的類就沒成功，那是因?yàn)閖ava的源文件需要編譯，在編譯時(shí)會(huì)檢查類是否存在，不存在肯定是編譯不通過的；而如果引用的是jar包中的文件引用另外一個(gè)jar的，則是因?yàn)閖ar包經(jīng)過了編譯，已經(jīng)打包成功了，故不存在問題。
通過value屬性需要結(jié)合jar包的方式，這里就不演示了，感興趣的小伙伴可以自己嘗試。通過name屬性來指定。
2、使用name屬性
@ConditionalOnClass注解還有name屬性，name屬性指定的是全限類名，也就是包含包名+類名。看下我的配置，
@Configuration
@ConditionalOnClass(name = {"com.my.template.config.ClassA"})
public class MyAutoConfig {
public MyAutoConfig(){
System.out.println("constructor MyAutoConfig");
}
}這里配置了“com.my.template.config.ClassA”，ClassA是我的一個(gè)存在的類，
下面啟動(dòng)，看下在啟動(dòng)日志中是否有“constructor MyConfig”打印，
constructor MyAutoConfig constructor MyAutoConfig2 constructor classA 2022-07-30 17:18:54.113
看到了，日志說明name配置是生效的，也就是存在ClassA則MyAutoConfig會(huì)注冊(cè)到spring的容器中。作為對(duì)比，下面配置一個(gè)不存在的類ClassD,
@Configuration
@ConditionalOnClass(name = {"com.my.template.config.ClassD"})
public class MyAutoConfig {
public MyAutoConfig(){
System.out.println("constructor MyAutoConfig");
}
}看下啟動(dòng)日志
constructor MyAutoConfig2 constructor classA 2022-07-30 21:43:30.550 INFO 13116 --- [
從上面的日志可以看到，沒有打印出來想要的日志，說明MyAutoConfig沒有注冊(cè)到spring的容器中。
我們知道name屬性是一個(gè)數(shù)組，上面僅僅配置了一個(gè)類，如果配置多個(gè)會(huì)是什么樣子，感興趣的可以自己嘗試，這里這直接給出答案，只有name屬性中配置的全部滿足相應(yīng)的配置類才會(huì)生效。
不知道，你是否對(duì)@ConditionalOnClass是怎么實(shí)現(xiàn)的感興趣嗎，繼續(xù)往下看，大揭秘了。
三、@ConditionalOnClass是怎么實(shí)現(xiàn)的
要理解@ConditionalOnClass是怎么實(shí)現(xiàn)的還是要回到該注解的定義上，前邊提到該注解被
@Conditional(OnClassCondition.class)
注解標(biāo)識(shí)，@Conditional注解的含有是要滿足條件才會(huì)生效，該注解后邊再看。今天的主角是OnClassCondition類，看下其繼承關(guān)系
重點(diǎn)關(guān)注XXCondition即可，可以看到最終實(shí)現(xiàn)了Condition接口，@Conditional注解的本質(zhì)就是考查是否滿足Codition接口的matches()方法，所以這看SpringBootCondition中matches方法的實(shí)現(xiàn)，
@Override
public final boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
//獲得該注解標(biāo)準(zhǔn)的類或方法
String classOrMethodName = getClassOrMethodName(metadata);
try {
//模板方法，該實(shí)現(xiàn)在OnClassCodition類中
ConditionOutcome outcome = getMatchOutcome(context, metadata);
logOutcome(classOrMethodName, outcome);
recordEvaluation(context, classOrMethodName, outcome);
//返回是否符合條件
return outcome.isMatch();
}
catch (NoClassDefFoundError ex) {
throw new IllegalStateException("Could not evaluate condition on " + classOrMethodName + " due to "
+ ex.getMessage() + " not found. Make sure your own configuration does not rely on "
+ "that class. This can also happen if you are "
+ "@ComponentScanning a springframework package (e.g. if you "
+ "put a @ComponentScan in the default package by mistake)", ex);
}
catch (RuntimeException ex) {
throw new IllegalStateException("Error processing condition on " + getName(metadata), ex);
}
}getMatchOutCome()方法使用了模板方法，實(shí)現(xiàn)在OnClassCondition類中，這是最要的方法，
@Override
public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
ClassLoader classLoader = context.getClassLoader();
ConditionMessage matchMessage = ConditionMessage.empty();
//獲得@ConditionalOnClass注解中配置的value和name屬性的值
List<String> onClasses = getCandidates(metadata, ConditionalOnClass.class);
if (onClasses != null) {
//判斷@ConditionOnClass注解配置的類是否都可以加載到，如有加載不到的則放到missing中
List<String> missing = filter(onClasses, ClassNameFilter.MISSING, classLoader);
if (!missing.isEmpty()) {
//有加載不到的，則返回ConditionOutcome對(duì)下，其中屬性match為false
return ConditionOutcome.noMatch(ConditionMessage.forCondition(ConditionalOnClass.class)
.didNotFind("required class", "required classes").items(Style.QUOTE, missing));
}
matchMessage = matchMessage.andCondition(ConditionalOnClass.class)
.found("required class", "required classes")
.items(Style.QUOTE, filter(onClasses, ClassNameFilter.PRESENT, classLoader));
}
//@ConditionalOnMissingClass的處理邏輯
List<String> onMissingClasses = getCandidates(metadata, ConditionalOnMissingClass.class);
if (onMissingClasses != null) {
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));
}
matchMessage = matchMessage.andCondition(ConditionalOnMissingClass.class)
.didNotFind("unwanted class", "unwanted classes")
.items(Style.QUOTE, filter(onMissingClasses, ClassNameFilter.MISSING, classLoader));
}
//返回ConditionOutCome對(duì)下，其match屬性為true
return ConditionOutcome.match(matchMessage);
}上面的代碼已經(jīng)給出了注釋，對(duì)應(yīng)@ConditionalOnClass注解的處理就是解析器配置的value和name屬性，判斷配置的類是否加載到，如有未加載到的則直接返回屬性match=false的ConditionOutcome對(duì)象，那么是如何判斷是否加載到的，是通過FilteringSpringBootCondition中的filter方法，
protected final List<String> filter(Collection<String> classNames, ClassNameFilter classNameFilter,
ClassLoader classLoader) {
if (CollectionUtils.isEmpty(classNames)) {
return Collections.emptyList();
}
List<String> matches = new ArrayList<>(classNames.size());
for (String candidate : classNames) {
//循環(huán)調(diào)用matches方法
if (classNameFilter.matches(candidate, classLoader)) {
matches.add(candidate);
}
}
return matches;
}對(duì)于@CoditionalOnClass的處理該方法傳入的參數(shù)為
List<String> missing = filter(onClasses, ClassNameFilter.MISSING, classLoader);
那么也就是調(diào)用ClassNameFilter.MISSING的matches方法，其方法如下
可以看到調(diào)用的是!isPresent方法，看下該方法的實(shí)現(xiàn)，
static boolean isPresent(String className, ClassLoader classLoader) {
if (classLoader == null) {
classLoader = ClassUtils.getDefaultClassLoader();
}
try {
//具體實(shí)現(xiàn)邏輯
FilteringSpringBootCondition.resolve(className, classLoader);
return true;
} catch (Throwable var3) {
return false;
}
}具體的實(shí)現(xiàn)在resolve方法中，且該方法被try catch包住了，如果加載不到，直接返回false。
protected static Class<?> resolve(String className, ClassLoader classLoader) throws ClassNotFoundException {
return classLoader != null ? Class.forName(className, false, classLoader) : Class.forName(className);
}看到這里，大家明白了，@ConditionalOnClass注解中判斷配置的類是否存在使用的方法是Class.forName，類加載。
四、總結(jié)
本文主要認(rèn)識(shí)了@ConditionalOnClass注解，分析了其注解的原理，如何判斷配置的類是否存在。
- @ConditionalOnClass注解有兩個(gè)屬性，分別是value和name，注意其配置方式；
- @ConditionalOnClass注解判斷配置的類是否存在的方式是通過Class.forName的方式；
以上就是詳解SpringBoot中@ConditionalOnClass注解的使用的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot @ConditionalOnClass注解的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
這篇文章主要介紹了jvm支持最大線程數(shù)簡(jiǎn)單測(cè)試，具有一定參考價(jià)值，需要的朋友可以了解下。2017-11-11
Netty與Spring Boot的整合實(shí)現(xiàn)
這篇文章主要介紹了Netty與Spring Boot的整合的實(shí)現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-08-08
Fastjson2是Fastjson的升級(jí)版,提供了更好的性能和擴(kuò)展性,它支持多種方式解析JSON數(shù)據(jù),包括將JSON字符串轉(zhuǎn)換為Java對(duì)象、嵌套的JSON對(duì)象和數(shù)組,以及轉(zhuǎn)換成Map或List,本文介紹Java fastjson2 解析JSON用法,感興趣的朋友一起看看吧2025-02-02
這篇文章主要為大家詳細(xì)介紹了Java如何將文件壓縮成zip和下載,并處理base64和url,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以參考一下2025-04-04
在生產(chǎn)環(huán)境下，我們需要關(guān)閉swagger配置，避免暴露接口的這種危險(xiǎn)行為。本文就詳細(xì)的介紹了3種情況，感興趣的可以了解一下2021-11-11
這篇文章主要為大家介紹了java開發(fā)中代碼寫的快且bug少的原因分析及技巧詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-12-12
在開發(fā)中,不管是dao層、service層還是controller層,都有可能拋出異常,在springmvc中,能將所有類型的異常處理從各處理過程解耦出來,既保證了相關(guān)處理過程的功能較單一,也實(shí)現(xiàn)了異常信息的統(tǒng)一處理和維護(hù),本文介紹SpringMVC全局異常處理,感興趣的朋友一起看看吧2024-03-03
這篇文章主要介紹了批量上傳Jar包到Maven私服的工具的方法，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-12-12
Springboot實(shí)現(xiàn)添加本地模塊依賴方式
這篇文章主要介紹了Springboot實(shí)現(xiàn)添加本地模塊依賴方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-02-02
java實(shí)現(xiàn)簡(jiǎn)單的搜索引擎
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)簡(jiǎn)單的搜索引擎的相關(guān)資料,需要的朋友可以參考下2016-02-02