Spring HttpMessageConverter的作用及替换解析

相信使用过spring的开发人员都用过@requestbody、@responsebody注解，可以直接将输入解析成json、将输出解析成json，但http 请求和响应是基于文本的，意味着浏览器和服务器通过交换原始文本进行通信，而这里其实就是httpmessageconverter发挥着作用。

httpmessageconverter

http请求响应报文其实都是字符串，当请求报文到java程序会被封装为一个servletinputstream流，开发人员再读取报文，响应报文则通过servletoutputstream流，来输出响应报文。

从流中只能读取到原始的字符串报文，同样输出流也是。那么在报文到达springmvc / springboot和从springmvc / springboot出去，都存在一个字符串到java对象的转化问题。这一过程，在springmvc / springboot中，是通过httpmessageconverter来解决的。httpmessageconverter接口源码：

									public interface httpmessageconverter<t> {

									  boolean canread(class<?> clazz, mediatype mediatype);

									  boolean canwrite(class<?> clazz, mediatype mediatype);

									  list<mediatype> getsupportedmediatypes();

									  t read(class<? extends t> clazz, httpinputmessage inputmessage)

									      throws ioexception, httpmessagenotreadableexception;

									  void write(t t, mediatype contenttype, httpoutputmessage outputmessage)

									      throws ioexception, httpmessagenotwritableexception;

									}

下面以一例子来说明，

									@requestmapping("/test")

									@responsebody

									public string test(@requestbody string param) {

									  return "param '" + param + "'";

									}

在请求进入test方法前，会根据@requestbody注解选择对应的httpmessageconverter实现类来将请求参数解析到param变量中，因为这里的参数是string类型的，所以这里是使用了stringhttpmessageconverter类，它的canread()方法返回true，然后read()方法会从请求中读出请求参数，绑定到test()方法的param变量中。

同理当执行test方法后，由于返回值标识了@responsebody，springmvc / springboot将使用stringhttpmessageconverter的write()方法，将结果作为string值写入响应报文，当然，此时canwrite()方法返回true。

借用下图简单描述整个过程：

Spring HttpMessageConverter的作用及替换解析

在spring的处理过程中，一次请求报文和一次响应报文，分别被抽象为一个请求消息httpinputmessage和一个响应消息httpoutputmessage。

处理请求时，由合适的消息转换器将请求报文绑定为方法中的形参对象，在这里同一个对象就有可能出现多种不同的消息形式，如json、xml。同样响应请求也是同样道理。

在spring中，针对不同的消息形式，有不同的httpmessageconverter实现类来处理各种消息形式，至于各种消息解析实现的不同，则在不同的httpmessageconverter实现类中。

替换@responsebody默认的httpmessageconverter

这里使用springboot演示例子，在springmvc / springboot中@requestbody这类注解默认使用的是jackson来解析json，看下面例子：

									@controller

									@requestmapping("/user")

									public class usercontroller {

									  @requestmapping("/testt")

									  @responsebody

									  public user testt() {

									    user user = new user("name", 18);

									    return user;

									  }

									}

									public class user {

									  private string username;

									  private integer age;

									  private integer phone;

									  private string email;

									  public user(string username, integer age) {

									  super();

									  this.username = username;

									  this.age = age;

									  }

									}

浏览器访问/user/testt返回如下：

Spring HttpMessageConverter的作用及替换解析

这就是使用jackson解析的结果，现在来改成使用fastjson解析对象，这里就是替换默认的httpmessageconverter，就是将其改成使用fastjsonhttpmessageconverter来处理java对象与httpinputmessage/httpoutputmessage间的转化。

首先新建一配置类来添加配置fastjsonhttpmessageconverter，spring4.x开始推荐使用java配置加注解的方式，也就是无xml文件，springboot就更是了。

									import com.alibaba.fastjson.serializer.serializerfeature;

									import com.alibaba.fastjson.support.config.fastjsonconfig;

									import com.alibaba.fastjson.support.spring.fastjsonhttpmessageconverter;

									import org.springframework.boot.autoconfigure.web.httpmessageconverters;

									import org.springframework.context.annotation.bean;

									import org.springframework.context.annotation.configuration;

									import org.springframework.http.converter.httpmessageconverter;

									import java.nio.charset.charset;

									@configuration

									public class httpmessageconverterconfig {

									  //引入fastjson解析json，不使用默认的jackson

									  //必须在pom.xml引入fastjson的jar包，并且版必须大于1.2.10

									  @bean

									  public httpmessageconverters fastjsonhttpmessageconverters() {

									    //1、定义一个convert转换消息的对象

									    fastjsonhttpmessageconverter fastconverter = new fastjsonhttpmessageconverter();

									    //2、添加fastjson的配置信息

									    fastjsonconfig fastjsonconfig = new fastjsonconfig();

									    serializerfeature[] serializerfeatures = new serializerfeature[]{

									        //  输出key是包含双引号

									//        serializerfeature.quotefieldnames,

									        //  是否输出为null的字段,若为null 则显示该字段

									//        serializerfeature.writemapnullvalue,

									        //  数值字段如果为null，则输出为0

									        serializerfeature.writenullnumberaszero,

									        //   list字段如果为null,输出为[],而非null

									        serializerfeature.writenulllistasempty,

									        //  字符类型字段如果为null,输出为"",而非null

									        serializerfeature.writenullstringasempty,

									        //  boolean字段如果为null,输出为false,而非null

									        serializerfeature.writenullbooleanasfalse,

									        //  date的日期转换器

									        serializerfeature.writedateusedateformat,

									        //  循环引用

									        serializerfeature.disablecircularreferencedetect,

									    };

									    fastjsonconfig.setserializerfeatures(serializerfeatures);

									    fastjsonconfig.setcharset(charset.forname("utf-8"));

									    //3、在convert中添加配置信息

									    fastconverter.setfastjsonconfig(fastjsonconfig);

									    //4、将convert添加到converters中

									    httpmessageconverter<?> converter = fastconverter;

									    return new httpmessageconverters(converter);

									  }

									}