ConditionalOnProperty配置swagger不生效如何解決

這篇文章主要介紹“ConditionalOnProperty配置swagger不生效如何解決”，在日常操作中，相信很多人在ConditionalOnProperty配置swagger不生效如何解決問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”ConditionalOnProperty配置swagger不生效如何解決”的疑惑有所幫助！接下來，請跟著小編一起來學習吧！

ConditionalOnProperty配置swagger不生效

問題

在正式環境準備關閉Swagger，添加了ConditionalOnProperty注解進行配置，結果發現怎么也無法關閉swagger。

問題原因

@EnableSwagger2在多個地方進行了配置，如下：

1）應用程序處進行了配置

@SpringCloudApplication
@EnableSwagger2  //在應用程序處進行了配置
public class SysApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(SysApplication.class,args);
    }
}

2）swagger處進行了配置

@Configuration
@EnableSwagger2  //在swagger本身配置處進行了配置
@ConditionalOnProperty(value = "swagger.manenabled", havingValue = "true")
public class SwaggerConfig {
}

實際在2）處的配置已經生效，但由于1）處有配置所以造成這個問題。

解決方案

將1）處的配置關閉即可。

@ConditionalOnProperty理解和使用

在Spring應用程序開發的過程中，可能需要根據配置屬性的存在和值有條件地創建一些bean，@ConditionalOnProperty注解用于僅在環境屬性存在且具有特定值時才啟用 bean 注冊。

注解源碼

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({OnPropertyCondition.class})
public @interface ConditionalOnProperty {
//獲取對應property名稱的值，與name不可同時使用
    String[] value() default {};
 
//配置屬性名稱的前綴
    String prefix() default "";
 
//配置屬性完整名稱或部分名稱
//可與prefix組合使用，組成完整的配置屬性名稱，與value不可同時使用
    String[] name() default {};
 
//可與name組合使用，比較獲取到的屬性值與havingValue給定的值是否相同，相同才加載配置
    String havingValue() default "";
 
//缺少該配置屬性時是否可以加載。如果為true，沒有該配置屬性時也會正常加載；反之則不會生效
    boolean matchIfMissing() default false;
}

value以及 prefix + name 決定屬性值(Property Value)，以下為匹配規則

解析：假如havingValue為空，

• 屬性值為boolean類型，則屬性值為true 加載該bean，屬性值為false 不加載該bean。

• 如果屬性值不為boolean類型，則有該屬性 則加載bean，沒有該屬性則不加載。

示例

屬性值不是boolean類型的情況

@Bean(name = "emailNotification")
@ConditionalOnProperty(prefix = "notification", name = "service")
public NotificationSender notificationSender() {
    return new EmailNotification();
}

如果配置該屬性則加載：

notification.service=email

屬性值為boolean類型

@Bean(name = "emailNotification")
@ConditionalOnProperty(prefix = "notification", name = "enable")
public NotificationSender notificationSender() {
    return new EmailNotification();
}

如果配置為true則加載

notification.enable=true

如果缺失或為false則不加載

到此，關于“ConditionalOnProperty配置swagger不生效如何解決”的學習就結束了，希望能夠解決大家的疑惑。理論與實踐的搭配能更好的幫助大家學習，快去試試吧！若想繼續學習更多相關知識，請繼續關注億速云網站，小編會繼續努力為大家帶來更多實用的文章！