使用@ConditionalOnExpression決定是否生效註釋,swagger開關(生產禁用)

最近因爲使用了swagger集成,當時swagger一般只在dev、sit等環境使用,生產是不建議使用的。

因此對swagger進行,是否使用進行配置。然後就有了一些對@ConditionalOnExpression認識的需要

  edu:
      swagger:
          enable: false
package com.edu.web.common.conf;

import com.edu.common.config.Global;
import io.swagger.annotations.ApiOperation;
import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2的接口配置
 *
 * @author ChenHuaming
 */
@Configuration
@EnableSwagger2
@ConditionalOnExpression("${edu.swagger.enable:true}")
public class SwaggerConfig {
    /**
     * 創建API
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                // 詳細定製
                .apiInfo(apiInfo())
                .select()
                // 指定當前包路徑
                // 掃描所有
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 添加摘要信息
     */
    private ApiInfo apiInfo() {
        // 用ApiInfoBuilder進行定製
        return new ApiInfoBuilder()
                .title("接口文檔")
                .description("用於人員查看、調試接口使用")
                .contact(new Contact(Global.getName(), null, null))
                .version("版本號:" + Global.getVersion())
                .build();
    }
}

該註解還支持一些java條件判斷


@ConditionalOnExpression("${edu.swagger.enable}==1&&${edu.swagger.enable:true}")

字符串也匹配

@ConditionalOnExpression("'${edu.swagger.enable:true}'.equals('used')")

這樣配置swagger 如果默認集成了 沒有配置,貌似會有個很噁心的彈窗,個人強迫證原因調整了,上面的還是可以使用的

package com.edu.web.common.conf;

import com.edu.common.config.Global;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2的接口配置
 *
 * @author ChenHuaming
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    /**
     * 創建API
     */
    @Bean
    @ConditionalOnProperty(prefix = "edu.swagger", name = "enable", havingValue = "true")
    public Docket createDisEnableRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                // 詳細定製
                .apiInfo(apiInfo())
                .select()
                // 掃描有ApiOperation的方法
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                .build();
    }

    @Bean
    @ConditionalOnProperty(prefix = "edu.swagger", name = "enable", havingValue = "false")
    public Docket createEnableRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                // 詳細定製
                .apiInfo(apiInfo())
                .select()
                // 掃描有ApiOperation的方法
                .apis(RequestHandlerSelectors.none())
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 添加摘要信息
     */
    private ApiInfo apiInfo() {
        // 用ApiInfoBuilder進行定製
        return new ApiInfoBuilder()
                .title("接口文檔")
                .description("用於人員查看、調試接口使用")
                .contact(new Contact(Global.getName(), null, null))
                .version("版本號:" + Global.getVersion())
                .build();
    }
}

@ConditionalOnProperty 對yml配置兼用會好些

想換工作咯,不知道有沒有大佬帶走

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章