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

标签: 知道 学习 httpmessageconverter | 发表时间:2020-10-23 08:46 | 作者:i听风逝夜
出处:https://juejin.im/backend

一、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<T> {
    /**
     * 根据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<Object> {
    @Override
    public boolean canRead(Class aClass, MediaType mediaType) {
        if (mediaType != null) {
            return mediaType.isCompatibleWith(MediaType.TEXT_HTML);
        }
        return false;
    }

    @Override
    public boolean canWrite(Class aClass, MediaType mediaType) {
        return false;
    }

    @Override
    public List getSupportedMediaTypes() {
        return Arrays.asList(MediaType.TEXT_HTML);
    }

    @Override
    public Object read(Class aClass, HttpInputMessage httpInputMessage) throws IOException, HttpMessageNotReadableException {
        String json = StreamUtils.copyToString(httpInputMessage.getBody(), Charset.forName("UTF-8"));
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        return objectMapper.readValue(json, aClass);
    }

    @Override
    public void write(Object o, MediaType mediaType, HttpOutputMessage httpOutputMessage) throws IOException, HttpMessageNotWritableException {

    }
}

复制代码

最后需要要进行配置,getMessageConverters()会返回现有的HttpMessageConverter集合,我们在这个基础上加入我们自定义的HttpMessageConverter即可,这回就不报错了。

   @Bean
public RestTemplate restTemplate(){
    RestTemplate restTemplate = new RestTemplate();
    restTemplate.getMessageConverters().add(new QQHttpMessageConverter());
    return  restTemplate;
}
复制代码

继承AbstractHttpMessageConverter

AbstractHttpMessageConverter帮我们封装了一部分事情,但是有些事情是他不能确定的,所以要交给子类实现,使用以下方法,同样可以解决text/html的问题。

   public class QQHttpMessageConverter extends AbstractHttpMessageConverter<Object> {
    public QQHttpMessageConverter() {
        super(MediaType.TEXT_HTML);
    }
    @Override
    protected boolean supports(Class aClass) {
        return true;
    }
    @Override
    protected Object readInternal(Class aClass, HttpInputMessage httpInputMessage) throws IOException, HttpMessageNotReadableException {
        String json = StreamUtils.copyToString(httpInputMessage.getBody(), Charset.forName("UTF-8"));
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        return objectMapper.readValue(json, aClass);
    }
    @Override
    protected void writeInternal(Object o, HttpOutputMessage httpOutputMessage) throws IOException, HttpMessageNotWritableException {
    }
}
复制代码

继承MappingJackson2HttpMessageConverter

好吧,使用MappingJackson2HttpMessageConverter,只需要给他能处理的MediaType即可,更简单。

   public class QQHttpMessageConverter extends MappingJackson2HttpMessageConverter {
    public QQHttpMessageConverter() {
        setSupportedMediaTypes(Arrays.asList(MediaType.TEXT_HTML));
    }
复制代码

相关 [知道 学习 httpmessageconverter] 推荐:

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

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

SpringMVC 消息转换器HttpMessageConverter

- - 企业架构 - ITeye博客
在SpringMVC中,可以使用@RequestBody和@ResponseBody两个注解,分别完成请求报文到对象和对象到响应报文的转换,底层这种灵活的消息转换机制,就是Spring3.x中新引入的HttpMessageConverter即消息转换器机制. 还是回到请求-响应,也就是解析请求体,然后返回响应报文这个最基本的Http请求过程中来.

基于机器学习的知道推荐—Enlister

- - 搜索引擎技术博客
基于机器学习的知道推荐—Enlister.         Enlister—最大的中文问答网站“百度知道”的问题推荐系统名字. 这个由几个百度一线工程师研发的系统,自2012年1月上线以来,承担着百度知道千万级登录用户的问题推荐计算.          百度知道这样的问答社区型网站有个典型特点:有些用户在平台上提出问题,这些问题被另一些用户发现,其中有能力且有意愿的人回答了这几个问题.

[译] 每个人都应该知道的十个机器学习常识

- - IT瘾-tuicool
当别人在高谈阔论机器学习时,你却插不上嘴,这是一种怎样的体验. 不懂机器学习没有关系,但你一定要知道下面的十个机器学习基本常识. 曾经在Endeca、谷歌和LinkedIn领导机器学习开发的Daniel Tunkelang为我们概括总结了这十个常识. 机器学习就是从数据中挖掘洞见,而人工智能是炒作.

关于机器学习,你应该知道的 3 个热门专业术语

- - IT瘾-dev
编者按:如果你是刚入门机器学习的AI探索者,你知道什么是胶囊网络吗. 为了帮大家节省查阅晦涩难懂的论文的时间,我们邀请微软亚洲研究院机器学习组实习生吴郦军、罗人千帮大家用最通俗的语言解释了这三个机器学习领域的热门词汇,赶紧收藏吧. 胶囊网络Capsule Networks 胶囊网络(Capsule Networks)是深度学习三巨头之一的Geoffrey Hinton提出的一种全新的神经网络.

学生党最应该知道的资源---技能/软件/编程/英语/二外/计算机二级/其他学习/论文下载/电子书/PPT模板_哔哩哔哩_bilibili

- -
1、技能学习平台:哔哩哔哩、中国大学慕课、coursera、edX. 2、软件操作:up主:oeasy、doyoudo、星月兮、Genji是真想教会你、旁门左道PPT、Excel自学成才、我是于干,+实战演练. 3、编程:基础:菜鸟教程、进阶:CSDN、Github、stackoverflow、leetcode.

iptables NAT 学习

- - BlogJava-首页技术区
为了搞清楚iptables NAT的过程,做了这个实验. 使用了1台双网卡服务器和1台单网卡服务器,2个网段. 1.       为了看到调度服务器上的数据转发过程,首先在调度服务器上分出内核的debug日志:. l 在/etc/rsyslog.conf最后增加:kern.debug /var/log/iptables.log.

Servlet Filter 学习

- - CSDN博客架构设计推荐文章
最近在研究CAS , CAS 中的Servlet Filter 不太熟悉, 所以花了点时间学下了下这部分的知识, 分成以下几部分 学习. Servlet Filter  的功能和用法. Servlet Filter 顺序的注意事项. A filter is an object that performs filtering tasks on either the request to a resource (a servlet or static content), or on the response from a resource, or both.

mongo 学习

- - CSDN博客系统运维推荐文章
mongod 启动参数详解:. master 启动: ./mongod --dbpath /data/db/master --logpath /data/db/master.log --logappend  --fork --port 2717 --master --oplogSize 64 . slave 启动: ./mongod  --dbpath /data/db/slave  --logpath  /data/db/slaver.log --logappend  --fork  -port 27018  --slave --slavedelay 5 --autoresync --source localhost:27017  .

pushlet 学习

- - 企业架构 - ITeye博客
转自: http://blog.csdn.net/houpengfei111/article/details/7498481.     pushlet是一种comet实现,在servlet机制下,数据从server端的java对象直接推送(push)到(动态)HTML页面,而无需任何java applet或者插件的帮助.