跟着视频学习java，发现swagger打不开？怎么解决

最新推荐文章于 2024-05-29 21:19:32 发布

明天一定.

最新推荐文章于 2024-05-29 21:19:32 发布

阅读量1.1k

点赞数

分类专栏：开发文章标签： java spring mvc

本文链接：https://blog.csdn.net/wai_58934/article/details/132730303

版权

开发专栏收录该内容

41 篇文章 0 订阅

订阅专栏

前因

现在到处都在卷java，不会java的前端不是好前端。

这不，周围有前端同学开始学java了。

昨天他突然找我问说引入依赖，配置之后swagger打不开了。

分析过程

1、

查看他的swagger版本，让他试了对应路径/swagger-ui/index.html，确定一下真的打不开

2、

依赖和swagger配置拿过来我的纯净项目里边，发现能跑。如下

@Configuration
@EnableSwagger2
public class InitSwagger {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.springbootlearn.controller")) // 替换成你的Controller包名
                .paths(PathSelectors.any())
                .build()
                .apiInfo(new ApiInfoBuilder()
                        .title("API文档")
                        .description("描述你的API信息")
                        .version("1.0")
                        .build());
    }
}

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

3、

他的项目压缩，发给我，发现我这也访问不到。

我再一看，他的配置里边有个静态资源配置如下，这是他照着学习视频写的。

@Slf4j
@Configuration
public class WebResources extends WebMvcConfigurationSupport {
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        log.info("启动资源映射");
        super.addResourceHandlers(registry);
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
    }
}

说实话，这个配置我不太熟悉，有点忘记了。但是一看就是和静态资源相关。而且一眼看过去有点疑惑，为什么super的调用不是放在最后。

注释掉，访问到swagger一气呵成。

4、

明白了问题所在，开始分析这个配置的作用，看起来是拦截static的路径到自己static的资源目录下。不管三七二十八直接debug到FrameworkServlet下doGet里边，最后来到了doDispatch下的getHandler方法中查看handlerMappings的SimpleUrlHandlerMapping中的urlMap。

对比后发现上述配置中urlMap的key只有一个/static/**

而不加配置urlMap的key有以下

5、

分析到这里，想要让以上配置正确能访问到swagger，我相信你已经想到办法了，就是再加swagger-ui的前缀，如下

@Slf4j
@Configuration
public class WebResources extends WebMvcConfigurationSupport {
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        log.info("启动资源映射");
        super.addResourceHandlers(registry);
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
        registry.addResourceHandler("/swagger-ui/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/")
                .resourceChain(false);
    }
}

访问之后发现通了。你以为结束了吗？没有。

6、

但是，但是你想过没，如果我们引入其他内置框架也有静态资源呢，难不成引入一种，去查一种？这种重写的方法显然不合适，我们要做的是追加而不是重写。但是如何追加？我也不知道，所以现在开始看配置。既然swagger能追加，我们也能追加，我们看swagger怎么做的就好了。

点进去super.addResourceHandlers(registry);发现是空实现，这也就说明了这个玩意放在哪都无所谓，解答了我前边的疑惑。直接在WebMvcConfigurationSupport类里边搜索this.addResourceHandlers(registry);看看如果我们不实现addResourceHandlers方法，框架是怎么默认走的。

最后来到WebMvcConfigurerComposite的addResourceHandlers方法，可以看到是遍历delegates分别添加，这不就是追加嘛！

当delegates是swagger的配置时我们点进去查看，发现如下场景

人家是实现了WebMvcConfigurer而不是继承的WebMvcConfigurationSupport，照猫画虎呗，结果就有了以下配置

@Slf4j
@Configuration
public class WebResources implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.
                addResourceHandler("/static/**")
                .addResourceLocations("classpath:/static/")
                .resourceChain(false);
    }
}

尝试访问，可以访问，完结。