springboot注解--基础--2.3--ConditionalOnMissingClass

springboot注解–基础–2.3–ConditionalOnMissingClass

---

代码位置

https://gitee.com/DanShenGuiZu/learnDemo/tree/master/annotation-learn/annotation-learn1

1、介绍

1. ConditionalOnMissingClass的value对应的String[]，都不能在classpath下找到，就构建这个bean。
   1. 也就是说，找不到class文件，就构建bean
2. 通过class.forName来判断class能不能找到
3. 通过OnClassCondition.class来判断

1.1、注解内容

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnClassCondition.class)
public @interface ConditionalOnMissingClass {

	/**
	 * 匹配的类名称 
	 */
	String[] value() default {};

}

1.2、OnClassCondition类关系

2、测试

2.1、代码

 
@Configuration
public class TestConfig {
    
    @Bean
    @ConditionalOnClass(Test2.class)
    Test2 test2() {
        System.out.println("---------Test2 的class文件存在，将Test2注册到容器中---------");
        return new Test2();
    }
    
    public class Test2 {
    }
    
    public static void main(String[] args) {
        
        // 设置日志级别,去掉我不要的信息
        LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
        List<Logger> loggerList = loggerContext.getLoggerList();
        loggerList.forEach(logger -> {
            logger.setLevel(Level.ERROR);
        });
        
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(TestConfig.class);
        
    }
}

2.2、测试

3、原理分析

我们通过类关系图找到Condition接口有个实现抽象类SpringBootCondition，SpringBoot中所有条件注解对应的条件类都继承这个抽象类。它实现了matches方法

getMatchOutcome是个抽象方法，需要子类去实现

子类getMatchOutcome方法

@Override
public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
	//类加载器
	ClassLoader classLoader = context.getClassLoader();
	//条件元信息
	ConditionMessage matchMessage = ConditionMessage.empty();
	//获取ConditionalOnClass注解中value的内容，也就是class的类名全路径
	List<String> onClasses = getCandidates(metadata, ConditionalOnClass.class);
	if (onClasses != null) {
		//如果类名不存在，missing就有内容
		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));
		}
		//构建提示消息
		matchMessage = matchMessage.andCondition(ConditionalOnClass.class)
				.found("required class", "required classes")
				.items(Style.QUOTE, filter(onClasses, ClassNameFilter.PRESENT, classLoader));
	}
	//获取ConditionalOnMissingClass注解中value的内容，也就是class的类名全路径
	List<String> onMissingClasses = getCandidates(metadata, ConditionalOnMissingClass.class);
	if (onMissingClasses != null) {
		//如果类名不存在，present就为空
		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));
	}
	//返回成功匹配信息
	return ConditionOutcome.match(matchMessage);
}

getCandidates方法

filter方法

当前类不存在，就加入matches列表中

ClassNameFilter方法