spring - @ConditionalOnProperty 注释的目的是什么？

Question

刚刚修改了spring boot的配置，遇到了

@ConditionalOnProperty(prefix = "spring.social.", value = "auto-connection-views") 

来自 org.springframework.boot.autoconfigure.social.TwitterAutoConfiguration

@Bean(name = { "connect/twitterConnect", "connect/twitterConnected" })
@ConditionalOnProperty(prefix = "spring.social.", value = "auto-connection-views")
public View twitterConnectView() {
    return new GenericConnectionStatusView("twitter", "Twitter");
}

我不明白这个注释的目的。我想这可能只有在属性值存在时才能使用 bean(例如“spring.social”、“auto-connection-views”)。

Answer 1

注解用于根据属性的配置有条件地创建 Spring bean。在您在问题中显示的用法中，只有 spring.social.auto-connection-views 属性存在并且它的值不是 false 时才会创建 bean >。这意味着，要创建这个 View bean，您需要设置 spring.social.auto-connection-views 属性，并且它的值必须不是假的。

您可以在整个 Spring Boot 代码库中找到此注解的许多其他用途。另一个例子是:

@ConditionalOnProperty(prefix = "spring.rabbitmq", name = "dynamic", matchIfMissing = true)
public AmqpAdmin amqpAdmin(CachingConnectionFactory connectionFactory) {
    return new RabbitAdmin(connectionFactory);
}

注意 matchIfMissing 的使用。在这种情况下，如果 spring.rabbitmq.dynamic 属性存在并且值不是 false 或 该属性根本不存在。这使得 bean 的创建选择退出，而不是问题中选择加入的示例。