纯净、安全、绿色的下载网站

首页|软件分类|下载排行|最新软件|IT学院

当前位置:首页IT学院IT技术

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

牧竹子   2021-10-13 我要评论
想了解Springboot下swagger-ui.html访问不到的解决方案的相关内容吗,牧竹子在本文为您仔细讲解Springboot swagger-ui.html访问不到的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:Springboot,swagger-ui.html,swagger-ui.html访问不到,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 cross跨域请求 springboot 怎样解决cross跨域请求的问题

    想了解springboot 怎样解决cross跨域请求的问题的相关内容吗,jwolf2在本文为您仔细讲解springboot cross跨域请求的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:springboot跨域请求,cross跨域请求,springboot跨域问题,下面大家一起来学习吧。..
  • Flutter圆盘取色器 Flutter自定义圆盘取色器

    想了解Flutter自定义圆盘取色器的相关内容吗,风向决定发型M在本文为您仔细讲解Flutter圆盘取色器的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:Flutter圆盘取色器,Flutter圆盘取色,Flutter取色器,下面大家一起来学习吧。..

网友评论

Copyright 2020 www.3a4a5a.com 【3A软件站】 版权所有 软件发布

声明:所有软件和文章来自软件开发商或者作者 如有异议 请与本站联系 点此查看联系方式