Question

我有以下课程：

@Component
@ConifgurationProperties("redis")
public class RedisProperties {
    private List<String> hosts;
    // getters, setters
}

@Component
public class StaticRedisHostsProvider implements RedisHostsProvider {
    private final RedisProperties redisProperties;

    public StaticRedisHostsProvider(RedisProperties redisProperties) {
        this.redisProperties = redisProperties;
    }

    @Override
    public List<String> getAll() {
        return redisProperties.getHosts();
    }
}

@Component
public DiscoveryBasedRedisHostsProvider { ... }

如果指定了StaticRedisHostsProvider属性，我希望使用redis.hosts，否则DiscoveryBasedRedisHostsProvider。

我可以使用StaticRedisHostsProvider注释@ConditionalOnProperty(prefix = "redis", name = "hosts")，但没有与@ConditionalOnMissingProperty一起使用的类似DiscoveryBasedRedisHostsProvider注释。

我尝试使用@ConditionalOnExpression("@redisProperties.hosts.empty")，但由于某种原因它无法运作：

Description:
A component required a bean named 'redisProperties' that could not be found.
Action:
Consider defining a bean named 'redisProperties' in your configuration.

有没有办法解决这个问题（可能有@Order或类似的注释）？

Answer 1

您必须添加matchIfMissing以检查是否没有属性

@ConditionalOnProperty(prefix = "redis", name = "hosts", matchIfMissing = true)

默认设置为false

修改如果您想检查是否未设置该值，则可以尝试使用havingValue=""。

@ConditionalOnProperty(prefix = "redis", name = "hosts", havingValue="")

Answer 2

这是我在Spring自动配置中使用自定义条件的问题。

@Conditional批注在应用程序启动期间非常早地执行。属性源已经加载，但是尚未创建ConfgurationProperties Bean。但是，我们可以通过将属性自己绑定到Java POJO来解决该问题。

首先，我介绍一个功能接口，该接口使我们能够定义任何自定义逻辑检查属性是否存在。在您的情况下，此方法将检查属性List是否为空或空。

public interface OptionalProperties {
  boolean isPresent();
}

现在让我们创建一个注释，该注释将使用Spring @Conditional进行元注释，并允许我们定义自定义参数。 prefix代表属性名称空间，targetClass代表应将属性映射到的配置属性模型类。

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

  String prefix();

  Class<? extends OptionalProperties> targetClass();

}

现在是主要部分。自定义条件实现。

public class OnConfigurationPropertiesCondition extends SpringBootCondition {

  @Override
  public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
    MergedAnnotation<ConditionalOnConfigurationProperties> mergedAnnotation = metadata.getAnnotations().get(ConditionalOnConfigurationProperties.class);
    String prefix = mergedAnnotation.getString("prefix");
    Class<?> targetClass = mergedAnnotation.getClass("targetClass");
    // type precondition
    if (!OptionalProperties.class.isAssignableFrom(targetClass)) {
      return ConditionOutcome.noMatch("Target type does not implement the OptionalProperties interface.");
    }
    // the crux of this solution, binding properties to Java POJO
    Object bean = Binder.get(context.getEnvironment()).bind(prefix, targetClass).orElse(null);
    // if properties are not present at all return no match
    if (bean == null) {
      return ConditionOutcome.noMatch("Binding properties to target type resulted in null value.");
    }
    OptionalProperties props = (OptionalProperties) bean;

    // execute method from OptionalProperties interface 
    // to check if condition should be matched or not
    // can include any custom logic using property values in a type safe manner
    if (props.isPresent()) {
      return ConditionOutcome.match();
    } else {
      return ConditionOutcome.noMatch("Properties are not present.");
    }
  }

}

现在，您应该创建实现OptionalProperties接口的自己的配置属性类。

@ConfigurationProperties("redis")
@ConstructorBinding
public class RedisProperties implements OptionalProperties {

  private final List<String> hosts;

  @Override
  public boolean isPresent() {
    return hosts != null && !hosts.isEmpty();
  }

}

然后在Spring @Configuration类中。

@Configuration
class YourConfiguration {

  @ConditionalOnConfigurationProperty(prefix = "redis", targetClass = RedisProperties.class)
  StaticRedisHostsProvider staticRedisHostsProvider() {
    ...
  }

  @ConditionalOnMissingBean(StaticRedisHostsProvider.class)
  DiscoveryBasedRedisHostsProvider discoveryRedisHostsProvider() {
    ...
  }

}

此解决方案有两个缺点：

必须在两个位置指定属性前缀：在@ConfigurationProperties注释上和在@ConditionalOnConfigurationProperties注释上。通过在配置属性POJO中定义public static final String PREFIX = "namespace"，可以部分缓解这种情况。
对于每次使用我们的自定义条件注释，将分别执行属性绑定过程，然后再次创建配置属性bean本身。它仅在应用启动时发生，因此这不是问题，但仍然效率低下。

Spring Boot条件基于配置属性中的集合是否为空

2 个答案: