SpringBoot注解@ConditionalOnClass底層源碼實(shí)現(xiàn)

第SpringBoot注解@ConditionalOnClass底層源碼實(shí)現(xiàn)@ConditionalOnClass的底層源碼實(shí)現(xiàn)

在SpringBoot中，支持了很多種條件注解，@ConditionalOnClass注解就是其中之一，而且及其重要，它主要是用來判斷該注解所指定的某個(gè)類或某些類，是否在ClassPath中存在，如果存在則符合條件，如果不存在則不符合。

@Target({ElementType.TYPE,ElementType.METHOD})

@Retention(RetentionPolicy.RUNTIME)

@Documented

@Conditional(OnClassCondition.class)

public@interfaceConditionalOnClass{

Class[]value()default{};

String[]name()default{};

這是該注解的源碼，可以通過value和name來指定要判斷的類，而真正執(zhí)行判斷的邏輯在OnClassCondition類中。

OnClassCondition類繼承了FilteringSpringBootCondition類

FilteringSpringBootCondition類又繼承了SpringBootCondition類

SpringBootCondition類實(shí)現(xiàn)了Condition接口

Spring在解析條件注解時(shí)，就會調(diào)用Condition接口的matches()方法，在上面的類繼承關(guān)系中，SpringBootCondition類實(shí)現(xiàn)了matches()方法，所以會先被調(diào)用。

ConditionOutcome對象

在matches()方法中，會調(diào)用getMatchOutcome()方法，并得到ConditionOutcome對象，ConditionOutcome對象就表示條件判斷的結(jié)果。

publicclassConditionOutcome{

//表示條件是否匹配

privatefinalbooleanmatch;

//...

getMatchOutcome()方法在SpringBootCondition類中是一個(gè)抽象方法，在子類OnClassCondition類中才真正實(shí)現(xiàn)了getMatchOutcome()方法，并真正會進(jìn)行條件判斷。

所以核心就是這個(gè)getMatchOutcome()方法，在這個(gè)方法中會先獲取@ConditionalOnClass注解的value和name屬性的值，這些值就是待判斷的類名集合。

//調(diào)用getCandidates方法

ListStringonClasses=getCandidates(metadata,ConditionalOnClass.class);

privateListStringgetCandidates(AnnotatedTypeMetadatametadata,ClassannotationType){

MultiValueMapString,Objectattributes=

metadata.getAllAnnotationAttributes(annotationType.getName(),true);

if(attributes==null){

returnnull;

ListStringcandidates=newArrayList();

addAll(candidates,attributes.get(value));

addAll(candidates,attributes.get(name));

returncandidates;

ClassNameFilter.MISSING判斷某類是否不存在

接下來就會逐個(gè)判斷類名集合中的每個(gè)類名，判斷邏輯為：利用ClassNameFilter.MISSING來判斷某類是否不存在？

ListStringmissing=filter(onClasses,ClassNameFilter.MISSING,classLoader);

protectedfinalListStringfilter(CollectionStringclassNames,ClassNameFilterclassNameFilter,ClassLoaderclassLoader){

if(CollectionUtils.isEmpty(classNames)){

returnCollections.emptyList();

ListStringmatches=newArrayList(classNames.size());

for(Stringcandidate:classNames){

if(classNameFilter.matches(candidate,classLoader)){

matches.add(candidate);

returnmatches;

ClassNameFilter.MISSING就是利用ClassLoader來加載類，如果加載到了表示類存在，沒加載到就表示不存在。

protectedenumClassNameFilter{

//...

MISSING{

@Override

publicbooleanmatches(StringclassName,ClassLoaderclassLoader){

//是否不存在

return!isPresent(className,classLoader);

staticbooleanisPresent(StringclassName,ClassLoaderclassLoader){

if(classLoader==null){

classLoader=ClassUtils.getDefaultClassLoader();

try{

resolve(className,classLoader);

returntrue;

catch(Throwableex){

returnfalse;

protectedstaticClassresolve(StringclassName,ClassLoaderclassLoader)throwsClassNotFoundException{

if(classLoader!=null){

returnClass.forName(className,false,classLoader);

returnClass.forName(className);

判斷完之后，只要missing集合不為空，那就表示待判斷的類中有類不存在，那就返回條件不匹配的ConditionOutcome對象，否則就返回條件匹