【resttemplate】RestTemplate返回值亂碼問題分析與解決 | 您所在的位置:網(wǎng)站首頁 › 屬兔的跟屬兔的合不合得來(lái) › 【resttemplate】RestTemplate返回值亂碼問題分析與解決 |
使用RestTemplate發(fā)送請求時,如果接口返回值中包含中文就會出現(xiàn)亂碼: RestTemplate restTemplate = new RestTemplate(); String result = restTemplate.getForObject("http://www.baidu.com", String.class); System.out.println(result);運(yùn)行結(jié)果如下: ????o|??€???????? ?°±??¥é?“![]() ? 3?o?????o| About Baidu ©2017;Baidu;????”¨????o|?‰??? èˉ?; ???è§????é|?;?o?ICPèˉ?030173??·; 從源碼分析原因 這個問題我首先想到的是RestTemplate的MessageConverter消息轉(zhuǎn)換器,首先找到RestTemplate解析response的地方。 org.springframework.web.client.HttpMessageConverterExtractor#extractData public T extractData(ClientHttpResponse response) throws IOException { MessageBodyClientHttpResponseWrapper responseWrapper = new MessageBodyClientHttpResponseWrapper(response); if (!responseWrapper.hasMessageBody() || responseWrapper.hasEmptyMessageBody()) { return null; } MediaType contentType = getContentType(responseWrapper); try { for (HttpMessageConverter messageConverter : this.messageConverters) { if (messageConverter instanceof GenericHttpMessageConverter) { GenericHttpMessageConverter genericMessageConverter = (GenericHttpMessageConverter) messageConverter; if (genericMessageConverter.canRead(this.responseType, null, contentType)) { if (logger.isDebugEnabled()) { ResolvableType resolvableType = ResolvableType.forType(this.responseType); logger.debug("Reading to [" + resolvableType + "]"); } return (T) genericMessageConverter.read(this.responseType, null, responseWrapper); } } if (this.responseClass != null) { if (messageConverter.canRead(this.responseClass, contentType)) { if (logger.isDebugEnabled()) { String className = this.responseClass.getName(); logger.debug("Reading to [" + className + "] as \"" + contentType + "\""); } return (T) messageConverter.read((Class) this.responseClass, responseWrapper); } } } } catch (IOException | HttpMessageNotReadableException ex) { throw new RestClientException("Error while extracting response for type [" + this.responseType + "] and content type [" + contentType + "]", ex); } throw new UnknownContentTypeException(this.responseType, contentType, response.getRawStatusCode(), response.getStatusText(), response.getHeaders(), getResponseBody(response)); } HttpMessageConverter消息轉(zhuǎn)換器RestTemplate的構(gòu)造方法中默認(rèn)內(nèi)置了下面7個消息轉(zhuǎn)換器: ByteArrayHttpMessageConverterStringHttpMessageConverterResourceHttpMessageConverterSourceHttpMessageConverterAllEncompassingFormHttpMessageConverterJaxb2RootElementHttpMessageConverterMappingJackson2HttpMessageConverter![]() 上面的代碼最終會調(diào)用StringHttpMessageConverter來對結(jié)果進(jìn)行轉(zhuǎn)換。 canRead()主要根據(jù)返回結(jié)果的類型和mediaType來進(jìn)行校驗(yàn)是否可以是否此消息轉(zhuǎn)換器進(jìn)行轉(zhuǎn)換。 org.springframework.http.converter.AbstractHttpMessageConverter#canRead(java.lang.Class, org.springframework.http.MediaType) public boolean canRead(Class clazz, @Nullable MediaType mediaType) { return supports(clazz) && canRead(mediaType); } public boolean supports(Class clazz) { return String.class == clazz; } protected boolean canRead(@Nullable MediaType mediaType) { if (mediaType == null) { return true; } for (MediaType supportedMediaType : getSupportedMediaTypes()) { if (supportedMediaType.includes(mediaType)) { return true; } } return false; }StringHttpMessageConverter支持restTemplate.getForObject傳入的class為String類型,mediaType支持所有,在構(gòu)造方法中指定了MediaType.ALL public StringHttpMessageConverter() { this(DEFAULT_CHARSET); } /** * A constructor accepting a default charset to use if the requested content * type does not specify one. */ public StringHttpMessageConverter(Charset defaultCharset) { super(defaultCharset, MediaType.TEXT_PLAIN, MediaType.ALL); }當(dāng)前面的校驗(yàn)通過后,會調(diào)用readInternal()對結(jié)果進(jìn)行轉(zhuǎn)換: org.springframework.http.converter.StringHttpMessageConverter#readInternal protected String readInternal(Class clazz, HttpInputMessage inputMessage) throws IOException { Charset charset = getContentTypeCharset(inputMessage.getHeaders().getContentType()); return StreamUtils.copyToString(inputMessage.getBody(), charset); }getContentTypeCharset()會判斷使用何種編碼方法對結(jié)果進(jìn)行編碼,這里使用了默認(rèn)的編碼: org.springframework.http.converter.StringHttpMessageConverter#getContentTypeCharset private Charset getContentTypeCharset(@Nullable MediaType contentType) { if (contentType != null && contentType.getCharset() != null) { return contentType.getCharset(); } else if (contentType != null && (contentType.isCompatibleWith(MediaType.APPLICATION_JSON) || contentType.isCompatibleWith(APPLICATION_PLUS_JSON))) { // Matching to AbstractJackson2HttpMessageConverter#DEFAULT_CHARSET return StandardCharsets.UTF_8; } else { Charset charset = getDefaultCharset(); Assert.state(charset != null, "No default charset"); return charset; } }在StringHttpMessageConverter的構(gòu)造方法中指定了默認(rèn)的編碼是ISO_8859_1,這就是亂碼的根本原因。 public static final Charset DEFAULT_CHARSET = StandardCharsets.ISO_8859_1; public StringHttpMessageConverter() { this(DEFAULT_CHARSET); }我們只要將ISO_8859_1修改為UTF-8就能解決亂碼問題。 修改StringHttpMessageConverter的編碼方式一:簡單粗暴,從源碼可得知第一個位置的類型是StringHttpMessageConverter,直接取出來將編碼修改為UTF-8。 RestTemplate restTemplate = new RestTemplate(); StringHttpMessageConverter stringHttpMessageConverter = (StringHttpMessageConverter) restTemplate.getMessageConverters().get(1); stringHttpMessageConverter.setDefaultCharset(StandardCharsets.UTF_8); String result = restTemplate.getForObject("http://www.baidu.com", String.class); System.out.println(result);方式二:推薦使用,通過類型來找到StringHttpMessageConverter,將編碼修改為UTF-8。 RestTemplate restTemplate = new RestTemplate(); List messageConverters = restTemplate.getMessageConverters(); for (HttpMessageConverter messageConverter : messageConverters) { if(messageConverter instanceof StringHttpMessageConverter) { ((StringHttpMessageConverter) messageConverter).setDefaultCharset(StandardCharsets.UTF_8); } } String result = restTemplate.getForObject("http://www.baidu.com", String.class); System.out.println(result);方式三:將所有的消息轉(zhuǎn)換器的編碼都修改為UTF-8 RestTemplate restTemplate = new RestTemplate(); List messageConverters = restTemplate.getMessageConverters(); for (HttpMessageConverter messageConverter : messageConverters) { if(messageConverter instanceof AbstractHttpMessageConverter) { ((AbstractHttpMessageConverter) messageConverter).setDefaultCharset(StandardCharsets.UTF_8); } else if(messageConverter instanceof FormHttpMessageConverter) { ((FormHttpMessageConverter) messageConverter).setCharset(StandardCharsets.UTF_8); ((FormHttpMessageConverter) messageConverter).setMultipartCharset(StandardCharsets.UTF_8); } } String result = restTemplate.getForObject("http://www.baidu.com", String.class); System.out.println(result); MappingJackson2HttpMessageConverter最后來學(xué)習(xí)一下MappingJackson2HttpMessageConverter,只有MappingJackson2HttpMessageConverter是GenericHttpMessageConverter類型,只有Response的header中的Content-type是application/json才會解析: public MappingJackson2HttpMessageConverter() { this(Jackson2ObjectMapperBuilder.json().build()); } public MappingJackson2HttpMessageConverter(ObjectMapper objectMapper) { super(objectMapper, MediaType.APPLICATION_JSON, new MediaType("application", "*+json")); }MappingJackson2HttpMessageConverter使用了ObjectMapper來進(jìn)行序列化和反序列化。 |
今日新聞 |
推薦新聞 |
專題文章 |
CopyRight 2018-2019 實(shí)驗(yàn)室設(shè)備網(wǎng) 版權(quán)所有 |