关于在Spring自动配置中使用自定义条件的问题,我有一些看法。与@Strumbels提出的类似,但更具可重用性。
@Conditional
注释在应用程序启动期间非常早就执行了。属性源已经加载,但是ConfigurationProperties bean尚未创建。但是,我们可以通过将属性绑定到Java POJO来解决这个问题。
首先,我介绍一个函数接口,它将使我们能够定义任何自定义逻辑,检查属性是否实际存在。在您的情况下,此方法将负责检查属性列表是否为空/ null以及其中所有项目是否有效。
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");
if (!OptionalProperties.class.isAssignableFrom(targetClass)) {
return ConditionOutcome.noMatch("Target type does not implement the OptionalProperties interface.");
}
Object bean = Binder.get(context.getEnvironment()).bind(prefix, targetClass).orElse(null);
if (bean == null) {
return ConditionOutcome.noMatch("Binding properties to target type resulted in null value.");
}
OptionalProperties props = (OptionalProperties) bean;
if (props.isPresent()) {
return ConditionOutcome.match();
} else {
return ConditionOutcome.noMatch("Properties are not present.");
}
}
}
现在,您应该创建自己的配置属性类,实现 OptionalProperties
接口。
@ConfigurationProperties("your.property.prefix")
@ConstructorBinding
public class YourConfigurationProperties implements OptionalProperties {
private final List<Service> services;
@Override
public boolean isPresent() {
return services != null && services.stream().all(Service::isValid);
}
}
然后在Spring的@Configuration
类中。
@Configuration
@ConditionalOnConfigurationProperties(prefix = "", targetClass = YourConfigurationProperties.class)
class AutoConfigureServices {
....
}
这种解决方案有两个缺点:
- 属性前缀必须在两个位置指定:在
@ConfigurationProperties
注释和@ConditionalOnConfigurationProperties
注释上。您可以通过在配置属性POJO中定义public static final String PREFIX = "namespace"
来部分缓解这个问题。
- 属性绑定过程针对每个自定义条件注释的使用单独执行,然后再次创建配置属性bean。它仅在应用程序启动期间发生,因此不应该是一个问题,但仍然存在效率问题。
@Autoconfiguration
和@Conditionals
会阻止bean被创建。这个想法是用户依赖于具有自动配置的jar包,但它不应该通过抛出致命错误来阻止他们的应用程序加载。 - Strumbles