Poison

关于 Spring @Profile 注解中使用表达式不生效的问题

发表于

早期我们曾使用 @Profile("!prepub") 控制预发环境不执行定时任务，后面又有需求需要让开发环境也不执行定时任务，于是将表达式改为了 @Profile("!dev & !prepub")，随即发现环境控制不生效了，所有环境都在执行定时任务。然后我又测试了表达式 @Profile("daily | product"), 发现也不生效，于是简单跟了下源码，在此简单记录。

首先根据 Profile (Spring Framework API) 的文档，我们知道：

A profile expression allows for more complicated profile logic to be expressed, for example “p1 & p2”. See Profiles.of(String…) for more details about supported formats.

即在配置中可以使用表达式，比如 p1 & p2，在 Profiles (Spring Framework API) 中还给出了其他表达式的示例。

但是在我们的场景中，为何配置没有生效呢，通过跟踪源码，发现在我们的应用环境中，处理 @Profile 注解时会进入 ConditionEvaluator.java at v4.3.16.RELEASE 中的如下代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
/**
 * Determine if an item should be skipped based on {@code @Conditional} annotations.
 * @param metadata the meta data
 * @param phase the phase of the call
 * @return if the item should be skipped
 */
public boolean shouldSkip(AnnotatedTypeMetadata metadata, ConfigurationPhase phase) {
  if (metadata == null || !metadata.isAnnotated(Conditional.class.getName())) {
    return false;
  }

  if (phase == null) {
    if (metadata instanceof AnnotationMetadata &&
        ConfigurationClassUtils.isConfigurationCandidate((AnnotationMetadata) metadata)) {
      return shouldSkip(metadata, ConfigurationPhase.PARSE_CONFIGURATION);
    }
    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) {
      if (!condition.matches(this.context, metadata)) {
        return true;
      }
    }
  }

  return false;
}

随即调用至 ProfileCondition.java at v4.3.16.RELEASE:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
/**
 * {@link Condition} that matches based on the value of a {@link Profile @Profile}
 * annotation.
 *
 * @author Chris Beams
 * @author Phillip Webb
 * @author Juergen Hoeller
 * @since 4.0
 */
class ProfileCondition implements Condition {

 @Override
 public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
  if (context.getEnvironment() != null) {
   MultiValueMap<String, Object> attrs = metadata.getAllAnnotationAttributes(Profile.class.getName());
   if (attrs != null) {
    for (Object value : attrs.get("value")) {
     if (context.getEnvironment().acceptsProfiles(((String[]) value))) {
      return true;
     }
    }
    return false;
   }
  }
  return true;
 }

}

继续跟踪源码，调用至 AbstractEnvironment.java at v4.3.16.RELEASE:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
@Override
public boolean acceptsProfiles(String... profiles) {
  Assert.notEmpty(profiles, "Must specify at least one profile");
  for (String profile : profiles) {
    if (StringUtils.hasLength(profile) && profile.charAt(0) == '!') {
      if (!isProfileActive(profile.substring(1))) {
        return true;
      }
    }
    else if (isProfileActive(profile)) {
      return true;
    }
  }
  return false;
}

/**
 * Return whether the given profile is active, or if active profiles are empty
 * whether the profile should be active by default.
 * @throws IllegalArgumentException per {@link #validateProfile(String)}
 */
protected boolean isProfileActive(String profile) {
  validateProfile(profile);
  Set<String> currentActiveProfiles = doGetActiveProfiles();
  return (currentActiveProfiles.contains(profile) ||
      (currentActiveProfiles.isEmpty() && doGetDefaultProfiles().contains(profile)));
}

看到这里就清楚了，源码中仅有处理 ! 开头的 profile 的逻辑，并没有处理多个表达式的逻辑，导致我们写的表达式都被当作单个 profile 进行处理，从而使预想的逻辑没有生效，然后检查了下 AbstractEnvironment 类的提交记录，发现表达式支持自 Spring 5.1.0 开始提供，而我们使用的 Spring 版本为 4.3.16，表达式支持的代码提交位于：Add profile expression support · spring-projects/spring-framework@e2623b7 · GitHub。

再仔细查看之前提到的 Profile (Spring Framework API) 与 Profiles (Spring Framework API) 的文档，发现 Profile 的文档中 since 为 3.1，而 Profiles 的文档中 since 为 5.1，而表达式的例子在 Profile 中就提供了，从而使我们误以为自 3.1 开始就支持，导致了该问题，最后我们将配置调整为 @Profile({"daily", "product"}) 解决了该问题。

附上 @Profile 判断逻辑的调用栈帧：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
"RMI TCP Connection(2)-127.0.0.1@1847" daemon prio=5 tid=0x14 nid=NA runnable
  java.lang.Thread.State: RUNNABLE
   at org.springframework.core.env.AbstractEnvironment.isProfileActive(AbstractEnvironment.java:348)
   at org.springframework.core.env.AbstractEnvironment.acceptsProfiles(AbstractEnvironment.java:333)
   at org.springframework.context.annotation.ProfileCondition.matches(ProfileCondition.java:39)
   at org.springframework.context.annotation.ConditionEvaluator.shouldSkip(ConditionEvaluator.java:102)
   at org.springframework.context.annotation.ConditionEvaluator.shouldSkip(ConditionEvaluator.java:81)
   at org.springframework.context.annotation.ConditionEvaluator.shouldSkip(ConditionEvaluator.java:64)
   at org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider.isConditionMatch(ClassPathScanningCandidateComponentProvider.java:371)
   at org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider.isCandidateComponent(ClassPathScanningCandidateComponentProvider.java:355)
   at org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider.findCandidateComponents(ClassPathScanningCandidateComponentProvider.java:288)
   at org.springframework.context.annotation.ClassPathBeanDefinitionScanner.doScan(ClassPathBeanDefinitionScanner.java:272)
   at org.springframework.context.annotation.ComponentScanBeanDefinitionParser.parse(ComponentScanBeanDefinitionParser.java:87)
   at org.springframework.beans.factory.xml.NamespaceHandlerSupport.parse(NamespaceHandlerSupport.java:74)
   at org.springframework.beans.factory.xml.BeanDefinitionParserDelegate.parseCustomElement(BeanDefinitionParserDelegate.java:1410)
   at org.springframework.beans.factory.xml.BeanDefinitionParserDelegate.parseCustomElement(BeanDefinitionParserDelegate.java:1400)
   at org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader.parseBeanDefinitions(DefaultBeanDefinitionDocumentReader.java:172)
   at org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader.doRegisterBeanDefinitions(DefaultBeanDefinitionDocumentReader.java:142)
   at org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader.registerBeanDefinitions(DefaultBeanDefinitionDocumentReader.java:94)
   at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.registerBeanDefinitions(XmlBeanDefinitionReader.java:508)
   at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.doLoadBeanDefinitions(XmlBeanDefinitionReader.java:392)
   at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.loadBeanDefinitions(XmlBeanDefinitionReader.java:336)
   at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.loadBeanDefinitions(XmlBeanDefinitionReader.java:304)
   at org.springframework.beans.factory.support.AbstractBeanDefinitionReader.loadBeanDefinitions(AbstractBeanDefinitionReader.java:181)
   at org.springframework.beans.factory.support.AbstractBeanDefinitionReader.loadBeanDefinitions(AbstractBeanDefinitionReader.java:217)
   at org.springframework.beans.factory.support.AbstractBeanDefinitionReader.loadBeanDefinitions(AbstractBeanDefinitionReader.java:188)
   at org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader.loadBeanDefinitionsFromImportedResources(ConfigurationClassBeanDefinitionReader.java:353)
   at org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader.loadBeanDefinitionsForConfigurationClass(ConfigurationClassBeanDefinitionReader.java:142)
   at org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader.loadBeanDefinitions(ConfigurationClassBeanDefinitionReader.java:116)
   at org.springframework.context.annotation.ConfigurationClassPostProcessor.processConfigBeanDefinitions(ConfigurationClassPostProcessor.java:320)
   at org.springframework.context.annotation.ConfigurationClassPostProcessor.postProcessBeanDefinitionRegistry(ConfigurationClassPostProcessor.java:228)
   at org.springframework.context.support.PostProcessorRegistrationDelegate.invokeBeanDefinitionRegistryPostProcessors(PostProcessorRegistrationDelegate.java:272)
   at org.springframework.context.support.PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(PostProcessorRegistrationDelegate.java:92)
   at org.springframework.context.support.AbstractApplicationContext.invokeBeanFactoryPostProcessors(AbstractApplicationContext.java:687)
   at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:525)