快捷導(dǎo)航

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

更新時(shí)間：2023年02月06日 16:35:36 作者：Hoeller

這篇文章主要為大家介紹了SpringBoot注解@ConditionalOnClass底層源碼實(shí)現(xiàn)，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

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

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

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnClassCondition.class)
public @interface ConditionalOnClass {
	Class<?>[] value() default {};
	String[] name() default {};
}

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

OnClassCondition類(lèi)繼承了FilteringSpringBootCondition類(lèi)
FilteringSpringBootCondition類(lèi)又繼承了SpringBootCondition類(lèi)
SpringBootCondition類(lèi)實(shí)現(xiàn)了Condition接口

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

ConditionOutcome對(duì)象

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

public class ConditionOutcome {
	// 表示條件是否匹配
	private final boolean match;
	// ...
}

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

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

// 調(diào)用getCandidates方法
List<String> onClasses = getCandidates(metadata, ConditionalOnClass.class);

private List<String> getCandidates(AnnotatedTypeMetadata metadata, Class<?> annotationType) {
	MultiValueMap<String, Object> attributes = 
		metadata.getAllAnnotationAttributes(annotationType.getName(), true);
	if (attributes == null) {
		return null;
	}
	List<String> candidates = new ArrayList<>();
	addAll(candidates, attributes.get("value"));
	addAll(candidates, attributes.get("name"));
	return candidates;
}

ClassNameFilter.MISSING判斷某類(lèi)是否不存在

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

List<String> missing = filter(onClasses, ClassNameFilter.MISSING, classLoader);

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) {
		if (classNameFilter.matches(candidate, classLoader)) {
			matches.add(candidate);
		}
	}
	return matches;
}

ClassNameFilter.MISSING就是利用ClassLoader來(lái)加載類(lèi)，如果加載到了表示類(lèi)存在，沒(méi)加載到就表示不存在。

protected enum ClassNameFilter {
	// ...
	MISSING {
		@Override
		public boolean matches(String className, ClassLoader classLoader) {
                        // 是否不存在
			return !isPresent(className, classLoader);
		}
	};
	static boolean isPresent(String className, ClassLoader classLoader) {
		if (classLoader == null) {
			classLoader = ClassUtils.getDefaultClassLoader();
		}
		try {
			resolve(className, classLoader);
			return true;
		}
		catch (Throwable ex) {
			return false;
		}
	}
}

protected static Class<?> resolve(String className, ClassLoader classLoader) throws ClassNotFoundException {
	if (classLoader != null) {
		return Class.forName(className, false, classLoader);
	}
	return Class.forName(className);
}

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

這就是@ConditionalOnClass注解的核心源碼流程，期待你的點(diǎn)贊哦。

以上就是SpringBoot注解@ConditionalOnClass底層源碼實(shí)現(xiàn)的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot ConditionalOnClass的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: