【排错日记】swagger配置错误导致启动失败

现象

在测试/预发环境（dev/pre）可以正常启动，正式环境（prod）却启动报错了。

报错信息如下：

***************************
APPLICATION FAILED TO START
***************************

Description:

Parameter 1 of constructor in com.github.xiaoymin.swaggerbootstrapui.web.SwaggerBootstrapUiController required a bean of type 'springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper' that could not be found.


Action:

Consider defining a bean of type 'springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper' in your configuration.

分析

分析应该是环境加载类的问题，查看配置类如下：

启动类

@EnableSwaggerBootstrapUI
public class AccountApplication {

    public static void main(String[] args) {
    ...
     省略
    ...
    }
}

配置类

@Configuration
@EnableSwagger2
@Profile({“dev”,“pre”})
class SwaggerConfig {
/**
* swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(this.apiInfo())
.select()
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
.paths(PathSelectors.any())
.build();
}

...
省略
...

}

可见，生产环境（prod）下SwaggerConfig配置类不加载，但是@EnableSwaggerBootstrapUI还生效，导致相关的类查询不到。

解决

将@EnableSwaggerBootstrapUI注解添加到SwaggerConfig上即可，见代码

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
@Profile({"dev", "pre"})
class SwaggerConfig {
    /**
     * swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(this.apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                .build();
    }

    ......
}