@ConditionOnBean 注解解析 —— BeanDefinition 加载顺序

最新推荐文章于 2023-12-21 12:53:27 发布

开心小蜗牛

最新推荐文章于 2023-12-21 12:53:27 发布

阅读量2.6k

点赞数 1

分类专栏： springboot 文章标签： @ConditionOnBean BeanDefinition 加载 AutoConfiguration

本文链接：https://blog.csdn.net/kangsa998/article/details/97940187

版权

文章目录

1 问题来源

对于 @ConditionOnBean 注解的匹配成功的条件不是很清晰
随着项目的复杂化，各个 bean 直接的关联也越来越复杂，这样极有可能在使用 @ConditionOnBean 注解时，并不能达到预期的目的
预要清晰的知道使用的 @ConditionOnBean 注解的预期效果，必须了解清楚它的匹配的时机和匹配的成功的条件

2 @ConditionOnBean 注解匹配的时机

在 Springboot 源码分析 —— refreshContext() 解析一文中，详细介绍了配置类的解析过程
在其中可以看出在解析 ConfigurationClass 和加载 BeanDefinition 这两个阶段都使用了条件注解进行配置类过滤
过滤的关键是 ConditionEvluator#shouldSkip 方法，源码分析如下
- 在解析 ConfigurationClass 阶段，phase 参数是 PARSE_CONFIGURATION
- 在加载 BeanDefinition 阶段，phase 参数是 REGISTER_BEAN
通过源码分析可知：@ConditionOnBean 注解是在 加载 BeanDefinition 阶段，才去匹配的

public boolean shouldSkip(@Nullable AnnotatedTypeMetadata metadata, @Nullable ConfigurationPhase phase) {
   
   //判断类是否被 @Conditional 注解，如果不是，返回 false，表示不需要跳过该类
   if (metadata == null || !metadata.isAnnotated(Conditional.class.getName())) {
   return false;}
   //如果 phase 为 null，判断类是否是配置类，如果是旧是在 PARSE_CONFIGURATION 阶段
   if (phase == null) {
   
      if (metadata instanceof AnnotationMetadata &&
            ConfigurationClassUtils.isConfigurationCandidate((AnnotationMetadata) metadata)) {
   
         return shouldSkip(metadata, ConfigurationPhase.PARSE_CONFIGURATION);
      }
      return shouldSkip(metadata, ConfigurationPhase.REGISTER_BEAN);
   }
   //获取所有的 conditions
   List<Condition> conditions;//具体代码略
   AnnotationAwareOrderComparator.sort(conditions);//排序
   for (Condition condition : conditions) {
   
      ConfigurationPhase requiredPhase = null;
      //这里很关键：@ConditionOnBean 注解对应的 条件类就是 实现了 ConfigurationCondition 接口
      if (condition instanceof ConfigurationCondition) {
   
         //并且 @ConditionOnBean 注解 得到的 requiredPhase 为 REGISTER_BEAN
         requiredPhase = ((ConfigurationCondition) condition).getConfigurationPhase();
      }
      //第一阶段 phase 为 PARSE_CONFIGURATION，这时 @ConditionOnBean 注解 就会被忽略
      //第二阶段 phase 为 REGISTER_BEAN，这时 @ConditionOnBean 注解 就会生效
      if ((requiredPhase == null || requiredPhase == phase) && !condition.matches(this.context, metadata)) {
   
         return true;
      }
   }
   return fals