【WEB系列】RestTemplate之中文乱码问题fix

2020-07-01

SpringBootWEB系列RestTemplate

RestTemplate

文章目录

I. 中文乱码Fix
II. 其他
1. 0. 项目&系列博文
2. 1. 一灰灰Blog

在RestTemplate基础用法博文中，post json表单时，会发现存在中文乱码问题，本文主要介绍对应的解决方案

I. 中文乱码Fix

1. “罪魁祸首”

场景复现

/**
 * json表单
 */
public void jsonPost() {
    RestTemplate restTemplate = new RestTemplate();

    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_JSON);

    JSONObject params = new JSONObject();
    params.put("name", "一灰灰Blog");
    params.put("age", 20);

    HttpEntity<String> request = new HttpEntity<>(params.toJSONString(), headers);

    String response = restTemplate.postForObject("http://127.0.0.1:8080/body", request, String.class);
    log.info("json post res: {}", response);
}

输出结果如下:

1
2
3

(json post res: params: {} | DemoRest.ReqBody(name=???Blog, age=20)
headers: {"content-length":"27","host":"127.0.0.1:8080","content-type":"application/json","connection":"keep-alive","accept":"text/plain, application/json, application/*+json, */*","user-agent":"Java/1.8.0_171"}
cookies:

原因定位

RestTemplate中存在一个HttpMessageConverter列表的属性成员，而HttpMessageConverter主要的职责就是消息转码

导致我们中文乱码的一个关键点在于StringHttpMessageConverter采用的默认编码格式为StandardCharsets.ISO_8859_1

2. 指定StringHttpMessageConverter编码

既然是因为StringHttpMessageConverter的默认编码不是UTF-8，那么将它手动改成utf-8不就over了么

/**
 * 中文乱码问题fix
 */
public void chinese() {
    RestTemplate restTemplate = new RestTemplate();

    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_JSON);

    JSONObject params = new JSONObject();
    params.put("name", "一灰灰Blog");
    params.put("age", 20);

    HttpEntity<String> request = new HttpEntity<>(params.toJSONString(), headers);

    // 中文乱码，主要是 StringHttpMessageConverter的默认编码为ISO导致的
    List<HttpMessageConverter<?>> list = restTemplate.getMessageConverters();
    for (HttpMessageConverter converter : list) {
        if (converter instanceof StringHttpMessageConverter) {
            ((StringHttpMessageConverter) converter).setDefaultCharset(Charset.forName("UTF-8"));
            break;
        }
    }

    String response = restTemplate.postForObject("http://127.0.0.1:8080/body", request, String.class);
    log.info("json post res: {}", response);
}

测试输出如:

1
2
3

(json post res: params: {} | DemoRest.ReqBody(name=一灰灰Blog, age=20)
headers: {"content-length":"33","host":"127.0.0.1:8080","content-type":"application/json","connection":"keep-alive","accept":"text/plain, application/json, application/*+json, */*","user-agent":"Java/1.8.0_171"}
cookies:

3. 传参POJO

在看RestTemplate的HttpMessageConvert时，会看到默认提供了一个MappingJackson2HttpMessageConverter，那么我们直接传参POJO，走Jackson序列化，是不是也可以解决中文乱码呢?

@Data
@NoArgsConstructor
@AllArgsConstructor
public static class InnerParam implements Serializable {
    private static final long serialVersionUID = -3693060057697231136L;
    private String name;
    private Integer age;
}


// 直接传一个POJO
public void chinese() {
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_JSON);

    RestTemplate restTemplate = new RestTemplate();
    InnerParam innerParam = new InnerParam("一灰灰Blog", 20);
    String HttpEntity<InnerParam> entity = new HttpEntity<>(innerParam, headers);
    response = restTemplate.postForObject("http://127.0.0.1:8080/body", entity, String.class);
    log.info("json post DO res: {}", response);
}

输出结果如下

1
2
3

(json post DO res: params: {} | DemoRest.ReqBody(name=一灰灰Blog, age=20)
headers: {"content-length":"33","host":"127.0.0.1:8080","content-type":"application/json","connection":"keep-alive","accept":"text/plain, application/json, application/*+json, */*","user-agent":"Java/1.8.0_171"}
cookies:

说明：上面的InnerParam对象改成HashMap，也是ok的

II. 其他

0. 项目&系列博文

博文

源码

1. 一灰灰Blog

尽信书则不如，以上内容，纯属一家之言，因个人能力有限，难免有疏漏和错误之处，如发现bug或者有更好的建议，欢迎批评指正，不吝感激

下面一灰灰的个人博客，记录所有学习和工作中的博文，欢迎大家前去逛逛

一灰灰Blog个人博客 https://blog.hhui.top
一灰灰Blog-Spring专题博客 http://spring.hhui.top

一灰灰blog

打赏如果觉得我的文章对您有帮助，请随意打赏。