如图所示,在一次开发中接收Json字符串使用@RequestBody接收,传入的中文出现了乱码问题
解决过程
一、对配置文件定义http的编码
问题尚未解决
#编码格式
spring.http.encoding.force=true
spring.http.encoding.charset=UTF-8
spring.http.encoding.enabled=true
server.tomcat.uri-encoding=UTF-8
二、写一个字符编码配置类
@Bean
public HttpMessageConverter<String> responseBodyStringConverter() {
StringHttpMessageConverter converter = new StringHttpMessageConverter(StandardCharsets.UTF_8);
return converter;
}
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters){
converters.add(responseBodyStringConverter());
}
三、设置请求接收字符类型
针对单独接口,在RequestMapping里设置 produces = {"application/json;charset=UTF-8"}
此方法依然无法解决问题
四、解决
实际上在解决的途中,我也参考了之前写过的一些项目配置,发现并无特殊之处
其他项目配置下都能正常接收Json字符串的中文并不会出现乱码
刹那之间我想起了如果不是本身配置问题那会不会出现在IDEA工具上呢
其实这个想法比较清奇,因为之前做一个人脸识别项目时由于对方提供的SDK包是GBK编码
所以我对项目的Project Encoding设置为GBK编码
将它改回UTF-8,问题解决。。。
五、新的解决思路
链接: link.
因为通过重写”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">
* 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