解决SpringBoot请求返回字符串中文乱码的问题
作者：古辛
问题
当Controller的接口返回字符串，在SwaggerUI中测试时，发现返回都是问号，比如”?????id 100 ???????“，这是由于字符编码问题导致
例如：
ResponseEntity.status(HttpStatus.NOT_FOUND)
.body(String.format("未找到相应id %d 的记录", id));网上解决方案
现有的两种解决方案：
- 第一种，针对单独接口，在RequestMapping里设置 produces = {"text/plain;charset=UTF-8"}
- 第二种，统一在MVC配置类中，通过修改StringHttpMessageConverter默认配置，部分代码（PS，该代码从别处拷贝而来）：
@Configuration
@EnableWebMvc
public class MyMvcConfig implements WebMvcConfigurer {
@Bean
public HttpMessageConverter<String> responseBodyStringConverter() {
StringHttpMessageConverter converter = new StringHttpMessageConverter(StandardCharsets.UTF_8);
return converter;
}
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters){
converters.add(responseBodyStringConverter());
}
}是由于默认的编码是”StandardCharsets.ISO_8859_1“导致，是通过重写”configureMessageConverters“方法来设置UTF-8编码来解决。
也就是第二种，坑了我，也许是我使用不当？
新解决方案
通过研究源码，找到了新的解决思路：
因为通过重写”configureMessageConverters“方法后，会导致一些其他问题
比如，统一处理异常的ExceptionAdviceHandler不工作，还导致Controller接口不支持文件下载
比如：
//解决中文文件名的乱码问题
String utf8 = StandardCharsets.UTF_8.name();
try {
downloadFileName = URLEncoder.encode(downloadFileName, utf8);
} catch (UnsupportedEncodingException e) {
//
}
return ResponseEntity.ok()
.contentType(MediaType.APPLICATION_OCTET_STREAM)
.header(HttpHeaders.CONTENT_DISPOSITION,
"attachment; filename* = " + utf8 + "''" + downloadFileName)
.body(new UrlResource(downloadFile.toURI()));并且调用下载接口时，会报406错误和异常”No converter for [class org.springframework.core.io.UrlResource]”，意思是不支持 “application/octet-stream“的转换，见鬼了，通过测试，禁用掉WebMvcConfigurer的重写，下载功能就ok了，但是会重新有编码问题。
最终通过研究源码，找到了根源，这是由于设置了自己的converter导致默认的其他converters不会再被初始化添加导致，参见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;
}所以基于这个代码，我们则应该重写extendMessageConverters方法来达到目的，最终的代码是：
@Bean
public HttpMessageConverter<String> responseBodyStringConverter() {
StringHttpMessageConverter converter = new StringHttpMessageConverter(StandardCharsets.UTF_8);
return converter;
}
@Override
public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
List<StringHttpMessageConverter> stringHttpMessageConverters = converters.stream()
.filter(converter -> converter.getClass().equals(StringHttpMessageConverter.class))
.map(converter -> (StringHttpMessageConverter) converter)
.collect(Collectors.toList());
if (stringHttpMessageConverters.isEmpty()) {
converters.add(responseBodyStringConverter());
} else {
stringHttpMessageConverters.forEach(converter -> converter.setDefaultCharset(StandardCharsets.UTF_8));
}
}JSON格式的编码探讨
这里仅处理接口直接返回字符串的问题，而对于处理JSON返回，这是因为JSON返回由MappingJackson2HttpMessageConverter来控制：
protected JsonEncoding getJsonEncoding(@Nullable MediaType contentType) {
if (contentType != null && contentType.getCharset() != null) {
Charset charset = contentType.getCharset();
for (JsonEncoding encoding : JsonEncoding.values()) {
if (charset.name().equals(encoding.getJavaName())) {
return encoding;
}
}
}
return JsonEncoding.UTF8;
}所以对于返回JSON对象，无需处理，且已经提供了默认的UTF-8编码，因为当默认没有设置MediaType的编码格式时，则会使用该默认的UTF-8编码。
并且MediaType中针对JSON的编码有如下解释：
/**
* A String equivalent of {@link MediaType#APPLICATION_JSON_UTF8}.
* @deprecated as of 5.2 in favor of {@link #APPLICATION_JSON_VALUE}
* since major browsers like Chrome
* <a href="https://bugs.chromium.org/p/chromium/issues/detail?id=438464" rel="external nofollow" >
* now comply with the specification</a> and interpret correctly UTF-8 special
* characters without requiring a {@code charset=UTF-8} parameter.
*/
@Deprecated
public static final String APPLICATION_JSON_UTF8_VALUE = "application/json;charset=UTF-8";PS：org.springframework.boot:spring-boot-starter-web:jar:2.2.1.RELEASE
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。