使用HttpMessageConverter实现HTTP的序列化和反序列化
對(duì)象的序列化/反序列化大家應(yīng)該都比較熟悉:序列化就是將object轉(zhuǎn)化為可以傳輸?shù)亩M(jìn)制,反序列化就是將二進(jìn)制轉(zhuǎn)化為程序內(nèi)部的對(duì)象。序列化/反序列化主要體現(xiàn)在程序I/O這個(gè)過(guò)程中,包括網(wǎng)絡(luò)I/O和磁盤I/O。
那么什么是http序列化和反序列化呢?
在使用springmvc/SpringBoot時(shí),我們經(jīng)常會(huì)這樣寫:
@RequestMapping("/test") @ResponseBodypublic String test(@RequestBody String param) {return "param '" + param + "'"; }@RestController中有@ResponseBody,可以幫我們把User序列化到resp.body中。@RequestBody可以幫我們把req.body的內(nèi)容轉(zhuǎn)化為User對(duì)象。如果是開(kāi)發(fā)Web應(yīng)用,一般這兩個(gè)注解對(duì)應(yīng)的就是Json序列化和反序列化的操作。這里實(shí)際上已經(jīng)體現(xiàn)了Http序列化/反序列化這個(gè)過(guò)程,只不過(guò)和普通的對(duì)象序列化有些不一樣,Http序列化/反序列化的層次更高,屬于一種Object2Object之間的轉(zhuǎn)換。
有過(guò)Netty使用經(jīng)驗(yàn)的對(duì)這個(gè)應(yīng)該比較了解,Netty中的Decoder和Encoder就有兩種基本層次,層次低的一種是Byte <—> Message,二進(jìn)制與程序內(nèi)部消息對(duì)象之間的轉(zhuǎn)換,就是常見(jiàn)的序列化/反序列化;另外一種是 Message <—> Message,程序內(nèi)部對(duì)象之間的轉(zhuǎn)換,比較高層次的序列化/反序列化。
Http協(xié)議的處理過(guò)程,TCP字節(jié)流 <—> HttpRequest/HttpResponse <—> 內(nèi)部對(duì)象,就涉及這兩種序列化。在springmvc中第一步已經(jīng)由Servlet容器(tomcat等等)幫我們處理了,第二步則主要由框架幫我們處理。上面所說(shuō)的Http序列化/反序列化就是指的這第二個(gè)步驟,它是controller層框架的核心功能之一,有了這個(gè)功能,就能大大減少代碼量,讓controller的邏輯更簡(jiǎn)潔清晰,就像上面示意的代碼那樣,方法中只有一行代碼。spirngmvc進(jìn)行第二步操作,也就是Http序列化和反序列化的核心是HttpMessageConverter。
HttpMessageConverter
Http請(qǐng)求響應(yīng)報(bào)文其實(shí)都是字符串,當(dāng)請(qǐng)求報(bào)文到j(luò)ava程序會(huì)被封裝為一個(gè)ServletInputStream流,開(kāi)發(fā)人員再讀取報(bào)文,響應(yīng)報(bào)文則通過(guò)ServletOutputStream流,來(lái)輸出響應(yīng)報(bào)文。
從流中只能讀取到原始的字符串報(bào)文,同樣輸出流也是。那么在報(bào)文到達(dá)SpringMVC / SpringBoot和從SpringMVC / SpringBoot出去,都存在一個(gè)字符串到j(luò)ava對(duì)象的轉(zhuǎn)化問(wèn)題。這一過(guò)程,在SpringMVC / SpringBoot中,是通過(guò)HttpMessageConverter來(lái)解決的。HttpMessageConverter接口源碼:
以上面的代碼為例子來(lái)說(shuō)明一下:在請(qǐng)求進(jìn)入test方法前,會(huì)根據(jù)@RequestBody注解選擇對(duì)應(yīng)的HttpMessageConverter實(shí)現(xiàn)類來(lái)將請(qǐng)求參數(shù)解析到param變量中,因?yàn)檫@里的參數(shù)是String類型的,所以這里是使用了StringHttpMessageConverter類,它的canRead()方法返回true,然后read()方法會(huì)從請(qǐng)求中讀出請(qǐng)求參數(shù),綁定到test()方法的param變量中。
同理當(dāng)執(zhí)行test方法后,由于返回值標(biāo)識(shí)了@ResponseBody,SpringMVC / SpringBoot將使用StringHttpMessageConverter的write()方法,將結(jié)果作為String值寫入響應(yīng)報(bào)文,當(dāng)然,此時(shí)canWrite()方法返回true。
借用下圖簡(jiǎn)單描述整個(gè)過(guò)程:
在Spring的處理過(guò)程中,一次請(qǐng)求報(bào)文和一次響應(yīng)報(bào)文,分別被抽象為一個(gè)請(qǐng)求消息HttpInputMessage和一個(gè)響應(yīng)消息HttpOutputMessage。處理請(qǐng)求時(shí),由合適的消息轉(zhuǎn)換器將請(qǐng)求報(bào)文綁定為方法中的形參對(duì)象,在這里同一個(gè)對(duì)象就有可能出現(xiàn)多種不同的消息形式,如json、xml。同樣響應(yīng)請(qǐng)求也是同樣道理。在Spring中,針對(duì)不同的消息形式,有不同的HttpMessageConverter實(shí)現(xiàn)類來(lái)處理各種消息形式,至于各種消息解析實(shí)現(xiàn)的不同,則在不同的HttpMessageConverter實(shí)現(xiàn)類中。
替換@ResponseBody默認(rèn)的HttpMessageConverter
1、springboot框架默認(rèn)的使用jackson進(jìn)行json轉(zhuǎn)化
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;} } @Controller @RequestMapping("/user") public class UserController {@RequestMapping("/testt")@ResponseBodypublic User testt() {User user = new User("name", 18);return user;} }瀏覽器訪問(wèn)/user/testt請(qǐng)求結(jié)果如下:
這就是使用Jackson解析的結(jié)果,沒(méi)有傳值的字段默認(rèn)被解析成了null。現(xiàn)在來(lái)改成使用fastjson解析對(duì)象,這里就是替換默認(rèn)的HttpMessageConverter,就是將其改成使用FastJsonHttpMessageConverter來(lái)處理Java對(duì)象與HttpInputMessage/HttpOutputMessage間的轉(zhuǎn)化。
2、使用fastjson替代默認(rèn)的jackson轉(zhuǎn)化方式
增加Fastjson的maven依賴
<dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.47</version> </dependency>Springboot配置FastJsonHttpMessageConverter有兩種方法:
方法一:啟動(dòng)類繼承extends WebMvcConfigurerAdapter,然后覆蓋方法configureMessageConverters
import com.alibaba.fastjson.serializer.SerializerFeature; import com.alibaba.fastjson.support.config.FastJsonConfig; import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter; import org.apache.log4j.Logger; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.web.HttpMessageConverters; import org.springframework.context.annotation.Bean; import org.springframework.http.MediaType; import org.springframework.http.converter.HttpMessageConverter; import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;import java.util.ArrayList; import java.util.List;/** springboot以fastjon方式轉(zhuǎn)化json數(shù)據(jù) */ @SpringBootApplication public class Application extends WebMvcConfigurerAdapter {private static Logger logger = Logger.getLogger(Application.class);@Overridepublic void configureMessageConverters(List<HttpMessageConverter<?>> converters) {super.configureMessageConverters(converters);//1.需要定義一個(gè)convert轉(zhuǎn)換消息的對(duì)象;FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter();//2.添加fastJson的配置信息,比如:是否要格式化返回的json數(shù)據(jù);FastJsonConfig fastJsonConfig = new FastJsonConfig();SerializerFeature[] serializerFeatures = new SerializerFeature[]{// 輸出key是包含雙引號(hào) // SerializerFeature.QuoteFieldNames,// 是否輸出為null的字段,若為null 則顯示該字段 // SerializerFeature.WriteMapNullValue,// 數(shù)值字段如果為null,則輸出為0SerializerFeature.WriteNullNumberAsZero,// List字段如果為null,輸出為[],而非nullSerializerFeature.WriteNullListAsEmpty,// 字符類型字段如果為null,輸出為"",而非nullSerializerFeature.WriteNullStringAsEmpty,// Boolean字段如果為null,輸出為false,而非nullSerializerFeature.WriteNullBooleanAsFalse,// Date的日期轉(zhuǎn)換器SerializerFeature.WriteDateUseDateFormat,// 循環(huán)引用SerializerFeature.DisableCircularReferenceDetect,};fastJsonConfig.setSerializerFeatures(serializerFeatures);//3處理中文亂碼問(wèn)題List<MediaType> fastMediaTypes = new ArrayList<>();fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);//4.在convert中添加配置信息.fastJsonHttpMessageConverter.setSupportedMediaTypes(fastMediaTypes);fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig);//5.將convert添加到converters當(dāng)中.converters.add(fastJsonHttpMessageConverter);}public static void main(String[] args) {SpringApplication.run(Application.class,args);logger.info("=====spring boot start success====");} }方法二:添加配置類來(lái)注入Bean:HttpMessageConverters
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,不使用默認(rèn)的jackson//必須在pom.xml引入fastjson的jar包,并且版必須大于1.2.10@Beanpublic HttpMessageConverters fastJsonHttpMessageConverters() {//1、定義一個(gè)convert轉(zhuǎn)換消息的對(duì)象FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();//2、添加fastjson的配置信息FastJsonConfig fastJsonConfig = new FastJsonConfig();SerializerFeature[] serializerFeatures = new SerializerFeature[]{// 輸出key是包含雙引號(hào) // SerializerFeature.QuoteFieldNames,// 是否輸出為null的字段,若為null 則顯示該字段 // SerializerFeature.WriteMapNullValue,// 數(shù)值字段如果為null,則輸出為0SerializerFeature.WriteNullNumberAsZero,// List字段如果為null,輸出為[],而非nullSerializerFeature.WriteNullListAsEmpty,// 字符類型字段如果為null,輸出為"",而非nullSerializerFeature.WriteNullStringAsEmpty,// Boolean字段如果為null,輸出為false,而非nullSerializerFeature.WriteNullBooleanAsFalse,// Date的日期轉(zhuǎn)換器SerializerFeature.WriteDateUseDateFormat,// 循環(huán)引用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);} }瀏覽器發(fā)起請(qǐng)求,得到的結(jié)果如下:
未傳值的字符串類型的屬性被解析為””,未傳值的數(shù)值類型的屬性被解析為0。
參考資料:
1、【Spring】HttpMessageConverter的作用及替換
2、springboot學(xué)習(xí)(三)——使用HttpMessageConverter進(jìn)行http序列化和反序列化
3、SpringBoot-擴(kuò)展FastJsonHttpMessageConverter對(duì)返回的json對(duì)象進(jìn)行擴(kuò)展
4、fastjson SerializerFeature詳解
總結(jié)
以上是生活随笔為你收集整理的使用HttpMessageConverter实现HTTP的序列化和反序列化的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: 自定义Redis序列化工具
- 下一篇: 使用fastjson提供的接口实现自定义