Серия SpringBoot: как реализованы условные аннотации в SpringBoot | Вызов в августе

Spring Boot Java

Это второй день моего участия в августовском испытании обновлений, подробности о мероприятии:Испытание августовского обновления

📖Сводка

鼓励有时比压力要重要！

В процессе обучения мы много раз слышим,你要怎样，怎样，你瞧瞧谁谁谁, даже если сегодня я не слышу такого голоса, но поскольку я слышал его неоднократно, это приводит к внутреннему сопротивлению. Хотя я знал, что буду учиться, но упорствовать было трудно. После обучения я терял направление. Я еще больше запаниковал, когда увидел, что есть так много людей, которые не знают, как это делать. В конце мой менталитет рухнул, и я еще больше не хотел учиться. На самом деле давление программистов не маленькое.Хочешь повзрослеть,нужно все время учиться.Вроде уже нельзя сказать,что ты хорошо разбираешься в java.Объем знаний действительно углубляется с ростом углубление обучения. Так нужно, счастливого обучения, счастливого роста!

Поделитесь сегодня - серия SpringBoot: некоторые базовые знания о том, как реализованы условные аннотации в SpringBoot, добро пожаловать на внимание!

🌂Поделиться

SpringBootВнутри предусмотрена специальная аннотация: условная аннотация (Conditional Annotation). Например:

  • @ConditionalOnBean,
  • @ConditionalOnClass,
  • @ConditionalOnExpression,
  • @ConditionalOnMissingBean и т. д.

Смысл условных аннотаций — динамическая идентификация (можно также сказать, автоматическое выполнение кода). Например@ConditionalOnClassПроверит, есть ли соответствующий класс в загрузчике классов, если есть, класс, измененный аннотацией, имеет право бытьSpringконтейнер зарегистрирован, в противном случае он будетskip 跳过.

Например, определение класса автоматической настройки FreemarkerAutoConfiguration выглядит следующим образом:

@Configuration
@ConditionalOnClass({ freemarker.template.Configuration.class,
    FreeMarkerConfigurationFactory.class })
@AutoConfigureAfter(WebMvcAutoConfiguration.class)
@EnableConfigurationProperties(FreeMarkerProperties.class)
public class FreeMarkerAutoConfiguration

Этот класс автоматической настройки@ConditionalOnClassУсловная модификация аннотации, значение этой условной аннотации состоит в том, чтобы определить, существует ли она в загрузчике классов.freemarker.template.Configurationа такжеFreeMarkerConfigurationFactoryЭти два класса, если они оба существуют, будут вSpringзагрузить это в контейнерFreeMarkerAutoConfigurationКласс конфигурации, иначе он не будет загружен.

✌ Некоторые основы работы с условными аннотациями

Перед анализом базового внедрения условных аннотаций давайте посмотрим на определения этих условных аннотаций. к@ConditionalOnClassНапример, аннотация определяется следующим образом:

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

Он имеет 2 атрибута: массивы и строковые массивы (одна и та же функция, разные типы) и@ConditionalИзмененный аннотацией, это@ConditionalУ аннотации есть имяvaluesизClass<? extends Condition>[]Свойства типа. этоConditionИнтерфейс, используемый для проверки того, может ли компонент быть зарегистрирован контейнером, определяемый следующим образом:

public interface Condition {
  // ConditionContext内部会存储Spring容器、应用程序环境信息、资源加载器、类加载器
  boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
}

то есть@ConditionalАтрибуты аннотаций могут содержать несколькоConditionКласс реализации интерфейса, всеConditionПосле этого интерфейс должен быть успешно сопоставлен.@ConditionalУкрашенные компоненты могут быть зарегистрированы только.

Интерфейс Condition имеет подинтерфейс ConfigurationCondition:

public interface ConfigurationCondition extends Condition {
  ConfigurationPhase getConfigurationPhase();
  public static enum ConfigurationPhase {
    PARSE_CONFIGURATION,
    REGISTER_BEAN
  }
}

Этот подинтерфейс представляет собой специальный условный интерфейс с еще однимgetConfigurationPhaseметод, то есть действующий этап условной аннотации. только вConfigurationPhaseОн вступит в силу только на двух этапах, определенных в .

ConditionИнтерфейс имеет абстрактный класс, который его реализует.SpringBootCondition,SpringBootУсловные классы, соответствующие всем условным аннотациям в . он достигаетmatchesметод:

@Override
public final boolean matches(ConditionContext context,
    AnnotatedTypeMetadata metadata) {
  String classOrMethodName = getClassOrMethodName(metadata); // 得到类名或者方法名(条件注解可以作用的类或者方法上)
  try {
    ConditionOutcome outcome = getMatchOutcome(context, metadata); // 抽象方法，具体子类实现。ConditionOutcome记录了匹配结果boolean和log信息
    logOutcome(classOrMethodName, outcome); // log记录一下匹配信息
    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);
  }
}

🤞 Условные аннотации на основе классов

SpringBoot предоставляет две условные аннотации на основе классов:

  • @ConditionalOnClass (указанный класс существует в загрузчике классов) или @ConditionalOnMissingClass (указанный класс не существует в загрузчике классов).
  • Класс условия, соответствующий аннотации @ConditionalOnClass или @ConditionalOnMissingClass, — это OnClassCondition, который определяется следующим образом:
@Order(Ordered.HIGHEST_PRECEDENCE) // 优先级、最高级别
class OnClassCondition extends SpringBootCondition {

  @Override
  public ConditionOutcome getMatchOutcome(ConditionContext context,
      AnnotatedTypeMetadata metadata) {

    StringBuffer matchMessage = new StringBuffer(); // 记录匹配信息

    MultiValueMap<String, Object> onClasses = getAttributes(metadata,
        ConditionalOnClass.class); // 得到@ConditionalOnClass注解的属性
    if (onClasses != null) { // 如果属性存在
      List<String> missing = getMatchingClasses(onClasses, MatchType.MISSING,
          context); // 得到在类加载器中不存在的类
      if (!missing.isEmpty()) { // 如果存在类加载器中不存在对应的类，返回一个匹配失败的ConditionalOutcome
        return ConditionOutcome
            .noMatch("required @ConditionalOnClass classes not found: "
                + StringUtils.collectionToCommaDelimitedString(missing));
      }
                // 如果类加载器中存在对应的类的话，匹配信息进行记录
      matchMessage.append("@ConditionalOnClass classes found: "
          + StringUtils.collectionToCommaDelimitedString(
              getMatchingClasses(onClasses, MatchType.PRESENT, context)));
    }
        // 对@ConditionalOnMissingClass注解做相同的逻辑处理(说明@ConditionalOnClass和@ConditionalOnMissingClass可以一起使用)
    MultiValueMap<String, Object> onMissingClasses = getAttributes(metadata,
        ConditionalOnMissingClass.class);
    if (onMissingClasses != null) {
      List<String> present = getMatchingClasses(onMissingClasses, MatchType.PRESENT,
          context);
      if (!present.isEmpty()) {
        return ConditionOutcome
            .noMatch("required @ConditionalOnMissing classes found: "
                + StringUtils.collectionToCommaDelimitedString(present));
      }
      matchMessage.append(matchMessage.length() == 0 ? "" : " ");
      matchMessage.append("@ConditionalOnMissing classes not found: "
          + StringUtils.collectionToCommaDelimitedString(getMatchingClasses(
              onMissingClasses, MatchType.MISSING, context)));
    }
        // 返回全部匹配成功的ConditionalOutcome
    return ConditionOutcome.match(matchMessage.toString());
  }
  
  private enum MatchType { // 枚举：匹配类型。用于查询类名在对应的类加载器中是否存在。
    PRESENT { // 匹配成功
      @Override
      public boolean matches(String className, ConditionContext context) {
        return ClassUtils.isPresent(className, context.getClassLoader());
      }
    },

    MISSING { // 匹配不成功
      @Override
      public boolean matches(String className, ConditionContext context) {
        return !ClassUtils.isPresent(className, context.getClassLoader());
      }
    };

    public abstract boolean matches(String className, ConditionContext context);

  }

}

НапримерFreemarkerAutoConfigurationсередина@ConditionalOnClassв примечанияхvalueсобственностьfreemarker.template.Configuration.classа такжеFreeMarkerConfigurationFactory.class. существуетOnClassConditionКонечный результат, полученный при выполненииConditionalOutcomeсерединаlog messageследующим образом:

@ConditionalOnClass classes found: freemarker.template.Configuration,org.springframework.ui.freemarker.FreeMarkerConfigurationFactory

🙌 Условные аннотации на основе компонентов

@ConditionalOnBean (SpringУказанное наличие в контейнереbean),@ConditionalOnMissingBean (SpringЭто не существует в указанном контейнереbean)так же какConditionalOnSingleCandidate (SpringВ контейнере указан один и только одинbean) основаны наBeanусловные аннотации, их соответствующие условные классыConditionOnBean.

@ConditionOnBeanАннотации определяются следующим образом:

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnBeanCondition.class)
public @interface ConditionalOnBean {
  Class<?>[] value() default {}; // 匹配的bean类型
  String[] type() default {}; // 匹配的bean类型的类名
  Class<? extends Annotation>[] annotation() default {}; // 匹配的bean注解
  String[] name() default {}; // 匹配的bean的名字
  SearchStrategy search() default SearchStrategy.ALL; // 搜索策略。提供CURRENT(只在当前容器中找)、PARENTS(只在所有的父容器中找；但是不包括当前容器)和ALL(CURRENT和PARENTS的组合)
}

OnBeanConditionСопоставление кода класса условия следующим образом:

@Override
public ConditionOutcome getMatchOutcome(ConditionContext context,
    AnnotatedTypeMetadata metadata) {
  StringBuffer matchMessage = new StringBuffer(); // 记录匹配信息
  if (metadata.isAnnotated(ConditionalOnBean.class.getName())) {
    BeanSearchSpec spec = new BeanSearchSpec(context, metadata,
        ConditionalOnBean.class); // 构造一个BeanSearchSpec，会从@ConditionalOnBean注解中获取属性，然后设置到BeanSearchSpec中
    List<String> matching = getMatchingBeans(context, spec); // 从BeanFactory中根据策略找出所有匹配的bean
    if (matching.isEmpty()) { // 如果没有匹配的bean，返回一个没有匹配成功的ConditionalOutcome
      return ConditionOutcome
          .noMatch("@ConditionalOnBean " + spec + " found no beans");
    }
    // 如果找到匹配的bean，匹配信息进行记录
    matchMessage.append(
        "@ConditionalOnBean " + spec + " found the following " + matching);
  }
  if (metadata.isAnnotated(ConditionalOnSingleCandidate.class.getName())) { // 相同的逻辑，针对@ConditionalOnSingleCandidate注解
    BeanSearchSpec spec = new SingleCandidateBeanSearchSpec(context, metadata,
        ConditionalOnSingleCandidate.class);
    List<String> matching = getMatchingBeans(context, spec);
    if (matching.isEmpty()) {
      return ConditionOutcome.noMatch(
          "@ConditionalOnSingleCandidate " + spec + " found no beans");
    }
    else if (!hasSingleAutowireCandidate(context.getBeanFactory(), matching)) { // 多了一层判断，判断是否只有一个bean
      return ConditionOutcome.noMatch("@ConditionalOnSingleCandidate " + spec
          + " found no primary candidate amongst the" + " following "
          + matching);
    }
    matchMessage.append("@ConditionalOnSingleCandidate " + spec + " found "
        + "a primary candidate amongst the following " + matching);
  }
  if (metadata.isAnnotated(ConditionalOnMissingBean.class.getName())) { // 相同的逻辑，针对@ConditionalOnMissingBean注解
    BeanSearchSpec spec = new BeanSearchSpec(context, metadata,
        ConditionalOnMissingBean.class);
    List<String> matching = getMatchingBeans(context, spec);
    if (!matching.isEmpty()) {
      return ConditionOutcome.noMatch("@ConditionalOnMissingBean " + spec
          + " found the following " + matching);
    }
    matchMessage.append(matchMessage.length() == 0 ? "" : " ");
    matchMessage.append("@ConditionalOnMissingBean " + spec + " found no beans");
  }
  return ConditionOutcome.match(matchMessage.toString()); //返回匹配成功的ConditonalOutcome
}

SpringBootТакже предоставляется в других, чемConditionalOnJava、ConditionalOnNotWebApplication、ConditionalOnWebApplication、ConditionalOnResource、ConditionalOnProperty、ConditionalOnExpressionи другие условные аннотации заинтересованные читатели могут самостоятельно просмотреть лежащую в их основе логику обработки.

👍Сводка различных условных аннотаций

在这里插入图片描述 在这里插入图片描述 在这里插入图片描述 在这里插入图片描述

👌Механизм активации условных аннотаций SpringBoot

После анализа логики выполнения условных аннотаций возникает следующий вопрос: как SpringBoot заставляет эти условные аннотации действовать?

SpringBoot использует внутренний класс ConditionEvaluator для завершения синтаксического анализа и оценки условных аннотаций.

В процессе обновления контейнера Spring только классы, связанные с синтаксическим анализом или регистрацией bean-компонентов, будут использовать ConditionEvaluator для завершения оценки условных аннотаций.В этом процессе некоторые классы будут пропущены, если они не соответствуют условиям. Эти классы включают AnnotatedBeanDefinitionReader, ConfigurationClassBeanDefinitionReader, ConfigurationClassParse, ClassPathScanningCandidateComponentProvider и так далее.

Например, конструктор ConfigurationClassParser инициализирует внутренние свойства ConditionEValuator:

public ConfigurationClassParser(MetadataReaderFactory metadataReaderFactory,
    ProblemReporter problemReporter, Environment environment, ResourceLoader resourceLoader,
    BeanNameGenerator componentScanBeanNameGenerator, BeanDefinitionRegistry registry) {

  this.metadataReaderFactory = metadataReaderFactory;
  this.problemReporter = problemReporter;
  this.environment = environment;
  this.resourceLoader = resourceLoader;
  this.registry = registry;
  this.componentScanParser = new ComponentScanAnnotationParser(
      resourceLoader, environment, componentScanBeanNameGenerator, registry);
  // 构造ConditionEvaluator用于处理条件注解
  this.conditionEvaluator = new ConditionEvaluator(registry, environment, resourceLoader);
}
    
ConfigurationClassParser对每个配置类进行解析的时候都会使用ConditionEvaluator：

if (this.conditionEvaluator.shouldSkip(configClass.getMetadata(), ConfigurationPhase.PARSE_CONFIGURATION)) {
  return;
}

ConditionEvaluatorизskipметод:

public boolean shouldSkip(AnnotatedTypeMetadata metadata, ConfigurationPhase phase) {
  // 如果这个类没有被@Conditional注解所修饰，不会skip
  if (metadata == null || !metadata.isAnnotated(Conditional.class.getName())) {
    return false;
  }
  // 如果参数中沒有设置条件注解的生效阶段
  if (phase == null) {
    // 是配置类的话直接使用PARSE_CONFIGURATION阶段
    if (metadata instanceof AnnotationMetadata &&
        ConfigurationClassUtils.isConfigurationCandidate((AnnotationMetadata) metadata)) {
      return shouldSkip(metadata, ConfigurationPhase.PARSE_CONFIGURATION);
    }
    // 否则使用REGISTER_BEAN阶段
    return shouldSkip(metadata, ConfigurationPhase.REGISTER_BEAN);
  }
  // 要解析的配置类的条件集合
  List<Condition> conditions = new ArrayList<Condition>();
  // 获取配置类的条件注解得到条件数据，并添加到集合中
  for (String[] conditionClasses : getConditionClasses(metadata)) {
    for (String conditionClass : conditionClasses) {
      Condition condition = getCondition(conditionClass, this.context.getClassLoader());
      conditions.add(condition);
    }
  }

  // 对条件集合做个排序
  AnnotationAwareOrderComparator.sort(conditions);
  // 遍历条件集合
  for (Condition condition : conditions) {
    ConfigurationPhase requiredPhase = null;
    if (condition instanceof ConfigurationCondition) {
      requiredPhase = ((ConfigurationCondition) condition).getConfigurationPhase();
    }
    // 没有这个解析类不需要阶段的判断或者解析类和参数中的阶段一致才会继续进行
    if (requiredPhase == null || requiredPhase == phase) {
      // 阶段一致切不满足条件的话，返回true并跳过这个bean的解析
      if (!condition.matches(this.context, metadata)) {
        return true;
      }
    }
  }

  return false;
}

SpringBootРазбор в условных аннотацияхlogзаписано вConditionEvaluationReportкласс, можно пройтиBeanFactoryПолучать(BeanFactoryОтношения между родителями и детьми существуют, каждыйBeanFactoryиметь копиюConditionEvaluationReport, не связанные друг с другом):

ConditionEvaluationReport conditionEvaluationReport = beanFactory.getBean("autoConfigurationReport", ConditionEvaluationReport.class);
Map<String, ConditionEvaluationReport.ConditionAndOutcomes> result = conditionEvaluationReport.getConditionAndOutcomesBySource();
for(String key : result.keySet()) {
    ConditionEvaluationReport.ConditionAndOutcomes conditionAndOutcomes = result.get(key);
    Iterator<ConditionEvaluationReport.ConditionAndOutcome> iterator = conditionAndOutcomes.iterator();
    while(iterator.hasNext()) {
        ConditionEvaluationReport.ConditionAndOutcome conditionAndOutcome = iterator.next();
        System.out.println(key + " -- " + conditionAndOutcome.getCondition().getClass().getSimpleName() + " -- " + conditionAndOutcome.getOutcome());
    }
}

Распечатайте информацию о загрузке класса под условной аннотацией:

.......
org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration -- OnClassCondition -- required @ConditionalOnClass classes not found: freemarker.template.Configuration,org.springframework.ui.freemarker.FreeMarkerConfigurationFactory
org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration -- OnClassCondition -- required @ConditionalOnClass classes not found: groovy.text.markup.MarkupTemplateEngine
org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration -- OnClassCondition -- required @ConditionalOnClass classes not found: com.google.gson.Gson
org.springframework.boot.autoconfigure.h2.H2ConsoleAutoConfiguration -- OnClassCondition -- required @ConditionalOnClass classes not found: org.h2.server.web.WebServlet
org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration -- OnClassCondition -- required @ConditionalOnClass classes not found: org.springframework.hateoas.Resource,org.springframework.plugin.core.Plugin
org.springframework.boot.autoconfigure.hazelcast.HazelcastAutoConfiguration -- OnClassCondition -- required @ConditionalOnClass classes not found: com.hazelcast.core.HazelcastInstance
.......

🎉 Наконец-то

  • Дополнительные справочные сообщения в блоге см. здесь:"Блог Чен Юнцзя"

  • Друзья, которым нравятся блогеры, могут подписаться, поставить лайк и продолжать обновлять, хе-хе!

Категории