用来指定配置文件是否生效,下面用一个具体例子讲解具体用法。
例子:我们开发环境中希望使用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
才可用。