关闭swagger2导致接口异常No converter found for return value of type...

最新推荐文章于 2025-06-18 09:45:00 发布

阿瑟与非

最新推荐文章于 2025-06-18 09:45:00 发布

阅读量718

点赞数

CC 4.0 BY-SA版权

分类专栏： Exception 文章标签： spring springboot

本文链接：https://blog.youkuaiyun.com/cs373616511/article/details/105832543

Exception 专栏收录该内容

10 篇文章

订阅专栏

探讨了在项目中关闭Swagger2后，自定义实体类返回数据接口出现异常的原因及解决办法。重写configureMessageConverters方法导致默认converters无法初始化，通过修改StringHttpMessageConverter的默认编码解决了中文乱码问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

异常

场景：接口正常的项目在上线的时候关闭swagger2。

问题：使用自定义实体类返回数据的接口会出现如下异常：

原因分析

项目配置

项目中有这样的配置类：

class MyWebConfig extends WebMvcConfigurationSupport

类中有如下代码：

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        super.configureMessageConverters(converters);
        //解决中文乱码
        StringHttpMessageConverter stringHttpMessageConverter = new StringHttpMessageConverter(Charset.forName("UTF-8"));
        //添加 stringHttpMessageConverter
        converters.add(stringHttpMessageConverter);
    }

这个配置的初衷是解决直接返回String的接口中文乱码的问题(StringHttpMessageConverter的默认编码是ISO-8859-1)

问题的关键就在于这个重写的方法。

为什么swagger2开启时正常？

在未关闭swagger2之前接口正常，是因为swagger处理了converters，接口正常。

关闭swagger2之后，configureMessageConverters方法会导致默认的converts无法初始化。

注意：关于swagger是如何处理的此处不做分析。

通过WebMvcConfigurationSupport源码分析

WebMvcConfigurationSupport类中的代码片段：

protected final List<HttpMessageConverter<?>> getMessageConverters() {
        if (this.messageConverters == null) {
            this.messageConverters = new ArrayList();
            this.configureMessageConverters(this.messageConverters);
            if (this.messageConverters.isEmpty()) {
                this.addDefaultHttpMessageConverters(this.messageConverters);
            }

            this.extendMessageConverters(this.messageConverters);
        }

        return this.messageConverters;
    }

项目中重写了configureMessageConverters方法并addconverters会导致

this.ddDefaultHttpMessageConverters(this.messageConverters)方法不执行。

从而导致默认的converts无法添加到messageConverters中，这就是异常得原因。

解决办法

注释掉重写configureMessageConverters的代码

重写方法extendMessageConverters

protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
    }

更改StringHttpMessageConverter的默认编码

    @Override
    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        super.extendMessageConverters(converters);
        for (HttpMessageConverter<?> converter : converters) {
            if (converter instanceof StringHttpMessageConverter) {
                StringHttpMessageConverter stringHttpMessageConverter = (StringHttpMessageConverter) converter;
                stringHttpMessageConverter.setDefaultCharset(StandardCharsets.UTF_8);
            }
        }
    }

这样修改之后，返回String中文没有乱码问题，返回实体的接口也正常了。