SpringMVC如何在生产环境禁用Swagger的方法

如果您的Spring MVC项目使用了Swagger来生成文档并进行接口测试，在生产环境下禁用Swagger是一个不错的选择。本文将详细讲解如何在生产环境中禁用Swagger。

方法一：使用Profile

首先，创建一个新的profile，在该profile中配置Swagger禁用。在application.yml文件中添加以下配置，该配置将Swagger在没有profile的情况下禁用：

springfox.documentation.swagger.v2.enabled: false

然后，在application-production.yml文件中启用一个新的profile并关闭Swagger：

spring:
  profiles:
    active: production

springfox.documentation.swagger.v2.enabled: false

现在，在生产环境中，Swagger将被禁用。如果您使用的是Spring Boot，则可以使用spring.profiles.active系统属性来指定active profile。

方法二：使用Java Config

如果您不使用YAML配置文件，则可以通过Java Config方式来禁用Swagger。在Java配置中添加以下内容：

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Autowired
    private Environment environment;

    @Bean
    public Docket api() {
        // 禁用Swagger
        if (Arrays.asList(environment.getActiveProfiles()).contains("production")) {
            return new Docket(DocumentationType.SWAGGER_2)
                    .enable(false);
        }
        else {
            return new Docket(DocumentationType.SWAGGER_2)
                    .enable(true)
                    .select()
                    .apis(RequestHandlerSelectors.any())
                    .paths(PathSelectors.any())
                    .build();
        }
    }
}

上述Java代码检查active profile是否为“production”，如果是，将禁用Swagger。否则，Swagger将启用。

总结

禁用Swagger有两种常见的方式：使用Profile和Java Config。使用Profile方式需要在application.yml文件中添加相关配置来禁用Swagger，而Java Config方式则直接在JavaConfig中控制。

这两种方法都可以轻松地禁用Swagger，保证生产环境的接口安全。