修改 SpringBoot 默认响应为 UTF-8 (原 charset: ISO-8859-1)

TLDR: server.servlet.encoding.force-response=true

(1/2) 起因

由于 MediaType.APPLICATION_JSON_UTF8_VALUE 已经被废弃, 且推荐我们使用 MediaType.APPLICATION_JSON_VALUE , 理由是认为我们的浏览器都能自动分辨并解析 UTF-8 格式.

但现实是, 经过层层处理, 返回的响应被解析成 application/json;charset=iso-8859-1, 导致我们的文字都变成了问号 ?, 这明显是不行的.

网上有很多文章讲了如何设置默认为 UTF-8, 但都过于麻烦.

• 比如, 设置一个转换器, 以下是设置一个转换器的代码

@Configuration
public class MyWebMvcConfig extends WebMvcConfigurationSupport {
	@Override
	 protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
	    for (HttpMessageConverter<?> converter : converters) {
	       // 解决controller返回普通文本中文乱码问题
	    if (converter instanceof StringHttpMessageConverter) {
	      ((StringHttpMessageConverter) converter).setDefaultCharset(StandardCharsets.UTF_8);
	       }
	       // 解决controller返回json对象中文乱码问题
	    if (converter instanceof MappingJackson2HttpMessageConverter) {
	      ((MappingJackson2HttpMessageConverter) converter).setDefaultCharset(StandardCharsets.UTF_8);
	    }
	  }
	}
 }

• 比如, 单独在 @RequestMapping 加上 produces

@RequestMapping(value = "queryXXX", produces = "application/json;charset=UTF-8")

(2/2) 解决办法 (SpringBoot 2.0+)

只需一步: 设置 force-response 为 true 就可以了

server.servlet.encoding.force-response=true

or

server:
  # port: 8080
  servlet:
    encoding:
      force-response: true
      charset: UTF-8 # charset 默认值本就是 UTF-8, 可按实际情况忽略 (如果不生效再加上)
    # session:
	  ## 是否在重启之间保存 session
      # persistent: true
      ## 设置session过期时间, 最小时间依据容器的不同判定 Unlike Jetty and Undertow, Tomcat only supports minute precision for session timeout. Any value that is greater than zero is converted to minutes with a minimum of 1 minute # https://github.com/spring-projects/spring-boot/issues/7383
      # timeout: 5m

原理是将 charset 设为 UTF-8, 然后强制生效

server.servlet.encoding.charset=UTF-8 # charset 设为 UTF-8
server.servlet.encoding.force-response=true # respond 强制生效

又因为 charset 默认值本就是 UTF-8, 所以只需加上 强制生效 (force-response) 就行了

server.servlet.encoding.force-response=true

来源: https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties.server.server.servlet.encoding.charset

SpringBoot 1.x

网上还有一些是基于 SpringBoot 1.x 的, 所以生效不了.

• 使用以下设置

# Charset of HTTP requests and responses. Added to the "Content-Type" header if not set explicitly.
spring.http.encoding.charset=UTF-8
# Enable http encoding support.
spring.http.encoding.enabled=true
# Force the encoding to the configured charset on HTTP requests and responses.
spring.http.encoding.force=true 

Reference: https://docs.spring.io/spring-boot/docs/1.5.22.RELEASE/reference/html/common-application-properties.html

SpringMVC

https://www.iteye.com/blog/elim-1753271