springboot中注解@ConditionalOnProperty的使用规则

用来指定配置文件是否生效,下面用一个具体例子讲解具体用法。

例子:我们开发环境中希望使用swagger来生成api在线文档,但是在生产环境中则希望能够禁用swagger功能,这时@ConditionalOnProperty就排上用场了。

SwaggerConfig中配置ConditionalOnProperty,然后在配置文件application.properties中配置swagger.config.enabled即可灵活控制swagger的开启和关闭。具体代码如下:

// 文件: SwaggerConfig.java
@Configuration
@EnableSwagger2
@ConditionalOnProperty(prefix = "swagger.config", value = "enabled", havingValue = "true")  //只有当配置文件配置了swagger.config.enabled=true时,swagger才生效
public class SwaggerConfig {
  ...//省略具体配置项
}
# 文件:application.properties
swagger.config.enabled=true

上例中,只有当配置文件配置了swagger.config.enabled=true时,swagger才可用。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。