Springboot下swagger-ui.html访问不到的解决方案

 更新时间:2021年10月13日 10:07:34   作者:牧竹子  
这篇文章主要介绍了Springboot下swagger-ui.html访问不到的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

Springboot swagger-ui.html访问不到

问题

在前面的Swagger2的基本配置中是可以访问到swagger-ui.html的

但当自定义继承配置WebMvcConfigurationSupport后便无法访问到该页面,原因参考请看参考资料。

首先看我的自定义配置,

*************
 * HttpMessageConverter转换处理
 * 处理转义hmtl标签为正常的hmtl标签
 * @author zjcjava@163.com
 *
 */
@Configuration
public class WebConfig extends WebMvcConfigurationSupport {
    @Bean
    public MappingJackson2HttpMessageConverter customJackson2HttpMessageConverter() {
        MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter();
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.configure(
                DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        objectMapper.getSerializerProvider().setNullValueSerializer(
                new JsonSerializer<Object>() {
                    @Override
                    public void serialize(Object value, JsonGenerator jgen,
                            SerializerProvider provider) throws IOException,
                            JsonProcessingException {
                        jgen.writeString("");
                    }
                });
        // 进行HTML解码
        objectMapper.registerModule(new SimpleModule().addSerializer(
                String.class, new JsonSerializer<String>() {
                    @Override
                    public void serialize(String value, JsonGenerator jgen,
                            SerializerProvider provider) throws IOException,
                            JsonProcessingException {
                        jgen.writeString(StringEscapeUtils.unescapeHtml4(value));
                    }
                }));
        jsonConverter.setObjectMapper(objectMapper);
        return jsonConverter;
    }
    @Override
    public void configureMessageConverters(
            List<HttpMessageConverter<?>> converters) {
        converters.add(customJackson2HttpMessageConverter());
        super.addDefaultHttpMessageConverters(converters);
    }
}

如果我把该文件全部注释掉则会正常显示,否则无法访问到swagger-ui.html,

解决方法

如果继承了WebMvcConfigurationSupport,则在配置文件在中配置的相关内容会失效,需要重新指定静态资源

因此参照资料2我做了处理如下,在该代码的末尾加上静态资源配置

代码加在

*************
 * HttpMessageConverter转换处理
 * 处理转义hmtl标签为正常的hmtl标签
 * @author zjcjava@163.com
 *
 */
@Configuration
public class WebConfig extends WebMvcConfigurationSupport {
    @Bean
    public MappingJackson2HttpMessageConverter customJackson2HttpMessageConverter() {
        MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter();
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.configure(
                DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        objectMapper.getSerializerProvider().setNullValueSerializer(
                new JsonSerializer<Object>() {
                    @Override
                    public void serialize(Object value, JsonGenerator jgen,
                            SerializerProvider provider) throws IOException,
                            JsonProcessingException {
                        jgen.writeString("");
                    }
                });
        // 进行HTML解码
        objectMapper.registerModule(new SimpleModule().addSerializer(
                String.class, new JsonSerializer<String>() {
                    @Override
                    public void serialize(String value, JsonGenerator jgen,
                            SerializerProvider provider) throws IOException,
                            JsonProcessingException {
                        jgen.writeString(StringEscapeUtils.unescapeHtml4(value));
                    }
                }));
        jsonConverter.setObjectMapper(objectMapper);
        return jsonConverter;
    }
    @Override
    public void configureMessageConverters(
            List<HttpMessageConverter<?>> converters) {
        converters.add(customJackson2HttpMessageConverter());
        super.addDefaultHttpMessageConverters(converters);
    }
    /**
     * 发现如果继承了WebMvcConfigurationSupport,则在yml中配置的相关内容会失效。 需要重新指定静态资源
     * 
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations(
                "classpath:/static/");
        registry.addResourceHandler("swagger-ui.html").addResourceLocations(
                "classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations(
                "classpath:/META-INF/resources/webjars/");
        super.addResourceHandlers(registry);
    }
    /**
     * 配置servlet处理
     */
    @Override
    public void configureDefaultServletHandling(
            DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }
}

swagger-ui的坑,swagger-ui.html无显示

且返回200无报错,且/v2/api-docs可以正常访问

因为粗心,踩中的坑,代码规范,细心真的能节省很多时间

上图,界面显示如图,一切都正常,控制台,也没有报错,很诡异吧

docs却可以正常访问,包括接口,都是正常的,网上很多解决方案都是说,跨域问题,或者是静态资源访问不到

1,首先跨域问题,会报错,有很明显的报错提示,这里排除,

2,静态资源,可以参考csdn上的其他方案很多,排查方法,可以查看targer目录下是否有静态文件

现在说这个问题导致的原因,以及解决方案

由于当时再写监听器相关代码,里面还涉及到过滤器,网上说到swagger会和拦截器有冲突,所以一直错误认为是监听器导致的问题,而且还有fastdfs的相关代码,也有说这两个起冲突,没办法,一一排查,进行版本回滚,发现fasdfs这个版本没有问题,这里要说,平时开发一定要切分支,分支切不了也要多提交版本,这样一旦出现问题也好解决。

然后下个版本发现,加上监听器,问题就又出现了,把监听器所有代码注释掉,问题依旧,百思不得其解,无奈,地毯扫描,版本不一样的全部注释,直到注释到controller层,又正常了,非常怀疑,一个controller,service业务代码这些不应该导致出问题的,怎么会是这的问题,然后进入代码准备细查,打开代码惊喜就来了

这是代码,本来还准备去看service层,看下是不是业务上有什么代码报错,到这就感觉更奇怪了,什么代码都没写,去掉就正常了,然后搜一下是不是方法名重复了,发现没有,

这时发现:@RequestMapping(),对就是这个注解,里面没东西是什么鬼,估计是当时注释的时候直接给删掉了,加入值后一切恢复正常

现在想想,swagger本来就是对controller的提取,没有报错就可以怀疑接口问题。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • SpringBoot 文件上传和下载的实现源码

    SpringBoot 文件上传和下载的实现源码

    这篇文章主要介绍了SpringBoot 文件上传和下载的实现源码,代码简单易懂非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2018-04-04
  • spring cloud 使用Hystrix 实现断路器进行服务容错保护的方法

    spring cloud 使用Hystrix 实现断路器进行服务容错保护的方法

    本篇文章主要介绍了spring cloud 使用Hystrix 实现断路器进行服务容错保护的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-05-05
  • JAVA控制流程break continue的示例代码

    JAVA控制流程break continue的示例代码

    JAVA流程控制中有相关代码可以终止整个流程的进程,他们就是(break和continue),本文通过实例代码介绍下JAVA控制流程break continue的相关知识,感兴趣的朋友一起看看吧
    2022-03-03
  • Java中的InputStreamReader和OutputStreamWriter源码分析_动力节点Java学院整理

    Java中的InputStreamReader和OutputStreamWriter源码分析_动力节点Java学院整理

    本文通过示例代码给大家解析了Java中的InputStreamReader和OutputStreamWriter知识,需要的的朋友参考下吧
    2017-05-05
  • 在IntelliJ IDEA中使用gulp的方法步骤(图文)

    在IntelliJ IDEA中使用gulp的方法步骤(图文)

    这篇文章主要介绍了在IntelliJ IDEA中使用gulp的方法步骤(图文),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-01-01
  • Spring Cloud Ribbon客户端详细介绍

    Spring Cloud Ribbon客户端详细介绍

    Spring Cloud Ribbon 是一套基于 Netflix Ribbon 实现的客户端负载均衡和服务调用工具。通过Spring Cloud的封装,可以让我们轻松地将面向服务的REST模版请求自动转换成客户端负载均衡的服务调用
    2022-09-09
  • ByteArrayInputStream简介和使用_动力节点Java学院整理

    ByteArrayInputStream简介和使用_动力节点Java学院整理

    ByteArrayInputStream 是字节数组输入流。它继承于InputStream。这篇文章主要介绍了ByteArrayInputStream简介和使用_动力节点Java学院整理,需要的朋友可以参考下
    2017-05-05
  • java数据结构图论霍夫曼树及其编码示例详解

    java数据结构图论霍夫曼树及其编码示例详解

    这篇文章主要为大家介绍了java数据结构图论霍夫曼树及其编码示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步早日升职加薪
    2021-11-11
  • JVM虚拟机的执行流程解析

    JVM虚拟机的执行流程解析

    这篇文章主要介绍了JVM虚拟机的执行流程图解,Java虚拟机的启动是通过引导类加载器创建一个初始类来完成的,这个类是由虚拟机的具体实现指定的,程序开始执行时他才运行,程序结束时他就停止,需要的朋友可以参考下
    2023-08-08
  • Java递归模糊查询文件实例代码

    Java递归模糊查询文件实例代码

    递归算法是一种直接或间接地调用自身的算法,在计算机编写程序中,递归算法对解决一大类问题是十分有效的,它往往使算法的描述简洁而且易于理解,这篇文章主要给大家介绍了关于Java递归模糊查询文件的相关资料,需要的朋友可以参考下
    2021-11-11

最新评论