异常
场景:接口正常的项目在上线的时候关闭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中文没有乱码问题,返回实体的接口也正常了。