被坑过后才知道学习HttpMessageConverter有多重要

一、HttpMessageConverter简介

或许HttpMessageConverter没听过，但是@RequestBody和@ResponseBody这两个注解不会不知道吧，深入研究数据转换时，就会发现HttpMessageConverter这个接口，简单说就是HTTP的request和response的转换器，在遇到@RequestBody时候SpringBoot会选择一个合适的HttpMessageConverter实现类来进行转换，内部有很多实现类，也可以自己实现，如果这个实现类能处理这个数据，那么它的canRead()方法会返回true，SpringBoot会调用他的read()方法从请求中读出并转换成实体类，同样canWrite也是。

但是我并不是从这里认识到HttpMessageConverter的，而是从RestTemplate，RestTemplate是一个使用同步方式执行HTTP请求的类，因此不需要加入OkHttp或者其他HTTP客户端的依赖，使用他就可以和其他服务进行通信，但是容易出现转换问题，如果对微信接口或者qq接口有所了解的话，那么在使用RestTemplate调用他们服务的时候，必定会报一个错误。

如下面在调用qq互联获取用户信息的接口时，报的错误。

   org.springframework.web.client.UnknownContentTypeException: Could not extract response: no suitable HttpMessageConverter found for response type [class xxx.xxx.xxxxx] and content type [text/html;charset=utf-8]
复制代码

错误信息是未知的ContentType，这个ContentType就是第三方接口返回时候在HTTP头中的Content-Type，如果通过其他工具查看这个接口返回的HTTP头，会发现他的值是text/html，通常我们见的都是application/json类型。（微信接口返回的是text/plain），由于内部没有HttpMessageConverter能处理text/html的数据，没有一个实现类的canRead()返回true，所以最后报错。

通常使用OkHttp或者其他框架时不会遇到这个错误。

二、深入报错源码

只有了解了报错原因以及源码，才能更好的解决问题，所以，我们更具报错源码的行数，定位到HttpMessageConverterExtractor下的extractData方法，从这个结构一眼就能看出大概逻辑：循环找出能处理这个contentType的HttpMessageConverter，然后调用这个HttpMessageConverter的read()并返回。

    public T extractData(ClientHttpResponse response) throws IOException {
     MessageBodyClientHttpResponseWrapper responseWrapper = new MessageBodyClientHttpResponseWrapper(response);
     if (responseWrapper.hasMessageBody() && !responseWrapper.hasEmptyMessageBody()) {
         MediaType contentType = this.getContentType(responseWrapper);
         try {
            //拿到messageConverters的迭代器
             Iterator var4 = this.messageConverters.iterator();
             while(var4.hasNext()) {
                //下一个HttpMessageConverter
                 HttpMessageConverter messageConverter = (HttpMessageConverter)var4.next();
                 //如果是GenericHttpMessageConverter接口的实例，继承AbstractHttpMessageConverter会走这个if。
                 if (messageConverter instanceof GenericHttpMessageConverter) {
                     GenericHttpMessageConverter genericMessageConverter = (GenericHttpMessageConverter)messageConverter;
                     //判断这个转换器是不能能转换这个类型
                     if (genericMessageConverter.canRead(this.responseType, (Class)null, contentType)) {
                         if (this.logger.isDebugEnabled()) {
                             ResolvableType resolvableType = ResolvableType.forType(this.responseType);
                             this.logger.debug("Reading to [" + resolvableType + "]");
                         }
                         //走到这代表当前的HttpMessageConverter能进行转换，则调用read并返回
                         return genericMessageConverter.read(this.responseType, (Class)null, responseWrapper);
                     }
                 }
                 //还是判断这个转换器能不能进行转换
                 if (this.responseClass != null && messageConverter.canRead(this.responseClass, contentType)) {
                     if (this.logger.isDebugEnabled()) {
                         String className = this.responseClass.getName();
                         this.logger.debug("Reading to [" + className + "] as \"" + contentType + "\"");
                     }
                     ////走到这代表当前的HttpMessageConverter能进行转换，则调用read并返回
                     return messageConverter.read(this.responseClass, responseWrapper);
                 }
             }
         } catch (HttpMessageNotReadableException | IOException var8) {
             throw new RestClientException("Error while extracting response for type [" + this.responseType + "] and content type [" + contentType + "]", var8);
         }
         //走到这抛出异常，所有的消息转换器都不能进行处理。
         throw new UnknownContentTypeException(this.responseType, contentType, response.getRawStatusCode(), response.getStatusText(), response.getHeaders(), getResponseBody(response));
     } else {
         return null;
     }
 }
复制代码

messageConverters集合中就保存着在RestTemplate构造方法中添加的HttpMessageConverter实现类。

三、自定义HttpMessageConverter

找到了原因，我们就需要解决问题，下面使用一个简单的办法，即重新设置MappingJackson2HttpMessageConverter能处理的MediaType。

       @Bean
    public RestTemplate restTemplate(){
        RestTemplate restTemplate = new RestTemplate();
        MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();
        mappingJackson2HttpMessageConverter.setSupportedMediaTypes(Arrays.asList(MediaType.TEXT_HTML));
        restTemplate.getMessageConverters().add(mappingJackson2HttpMessageConverter);
        return  restTemplate;
    }
复制代码

对，没错，这就解决了，MappingJackson2HttpMessageConverter也是一个HttpMessageConverter转换类，但是他不能处理text/html的数据，原因是他的父类AbstractHttpMessageConverter中的supportedMediaTypes集合中没有text/html类型，如果有的话就能处理了，通过setSupportedMediaTypes可以给他指定一个新的MediaType集合，上面的写法会导致MappingJackson2HttpMessageConverter只能处理text/html类型的数据。

但是，为了更深的研究，我们要直接继承HttpMessageConverter（当然更推荐的是继承AbstractHttpMessageConverter）来实现,在此之前，先看这几个方法具体代表什么意思，才能继续往下写。

   public interface HttpMessageConverter {
    /**
     * 根据mediaType判断clazz是否可读
     */
    boolean canRead(Class clazz, @Nullable MediaType mediaType);

    /**
     * 根据mediaType判断clazz是否可写
     */
    boolean canWrite(Class clazz, @Nullable MediaType mediaType);

    /**
     * 获取支持的mediaType
     */
    List getSupportedMediaTypes();

    /**
     * 将HttpInputMessage流中的数据绑定到clazz中
     */
    T read(Class clazz, HttpInputMessage inputMessage)
            throws IOException, HttpMessageNotReadableException;

    /**
     * 将t对象写入到HttpOutputMessage流中
     */
    void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage)
            throws IOException, HttpMessageNotWritableException;
}
复制代码

对于解决这个问题，canWrite，write方式是不需要处理的，只管canRead和read就行，在canRead方法中判断了是不是text/html类型，是的话就会返回true，Spring就会调用read，用来将字节流中的数据转换成具体实体，aClass就是我们最终想要得到的实例对象的Class，StreamUtils这个工具类是SpringBoot自带的一个，用来读取InputStream中的数据并返回String字符串，SpringBoott内部很多地方都用到了这个工具类，所以这里来借用一下，现在拿到了String型的数据后，就需要将String转换成对应的对象，这里可能想到了Gson、Fastjson，使用他们也可以完成，但是还需要额外的加入jar包，SpringBoot自身已经集成了ObjectMapper，所以在来借用一下。

   package com.hxl.vote.config;

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import org.springframework.util.StreamUtils;

import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.List;

public class QQHttpMessageConverter implements HttpMessageConverter