Spring HttpMessageConverter的作用及替換解析
相信使用過(guò)Spring的開(kāi)發(fā)人員都用過(guò)@RequestBody、@ResponseBody注解,可以直接將輸入解析成Json、將輸出解析成Json,但HTTP 請(qǐng)求和響應(yīng)是基于文本的,意味著瀏覽器和服務(wù)器通過(guò)交換原始文本進(jìn)行通信,而這里其實(shí)就是HttpMessageConverter發(fā)揮著作用。
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接口源碼:
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; }
下面以一例子來(lái)說(shuō)明,
@RequestMapping("/test") @ResponseBody public String test(@RequestBody String param) { return "param '" + param + "'"; }
在請(qǐng)求進(jìn)入test方法前,會(huì)根據(jù)@RequestBody注解選擇對(duì)應(yīng)的HttpMessageConverter實(shí)現(xiàn)類(lèi)來(lái)將請(qǐng)求參數(shù)解析到param變量中,因?yàn)檫@里的參數(shù)是String類(lèi)型的,所以這里是使用了StringHttpMessageConverter類(lèi),它的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值寫(xiě)入響應(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)來(lái)處理各種消息形式,至于各種消息解析實(shí)現(xiàn)的不同,則在不同的HttpMessageConverter實(shí)現(xiàn)類(lèi)中。
替換@ResponseBody默認(rèn)的HttpMessageConverter
這里使用SpringBoot演示例子,在SpringMVC / SpringBoot中@RequestBody這類(lèi)注解默認(rèn)使用的是jackson來(lái)解析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; } }
瀏覽器訪問(wèn)/user/testt返回如下:
這就是使用jackson解析的結(jié)果,現(xiàn)在來(lái)改成使用fastjson解析對(duì)象,這里就是替換默認(rèn)的HttpMessageConverter,就是將其改成使用FastJsonHttpMessageConverter來(lái)處理Java對(duì)象與HttpInputMessage/HttpOutputMessage間的轉(zhuǎn)化。
首先新建一配置類(lèi)來(lái)添加配置FastJsonHttpMessageConverter,Spring4.x開(kāi)始推薦使用Java配置加注解的方式,也就是無(wú)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,不使用默認(rèn)的jackson //必須在pom.xml引入fastjson的jar包,并且版必須大于1.2.10 @Bean public 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,則輸出為0 SerializerFeature.WriteNullNumberAsZero, // List字段如果為null,輸出為[],而非null SerializerFeature.WriteNullListAsEmpty, // 字符類(lèi)型字段如果為null,輸出為"",而非null SerializerFeature.WriteNullStringAsEmpty, // Boolean字段如果為null,輸出為false,而非null SerializerFeature.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); } }
這里將字符串類(lèi)型的值如果是null就返回“”,數(shù)值類(lèi)型的如果是null就返回0,重啟應(yīng)用,再次訪問(wèn)/user/testt接口,返回如下:
可以看到此時(shí)null都轉(zhuǎn)化成“”或0了。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
SpringBoot集成gRPC微服務(wù)工程搭建實(shí)踐的方法
這篇文章主要介紹了SpringBoot集成gRPC微服務(wù)工程搭建實(shí)踐的方法,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2019-01-01Java實(shí)現(xiàn)Dijkstra輸出最短路徑的實(shí)例
這篇文章主要介紹了Java實(shí)現(xiàn)Dijkstra輸出最短路徑的實(shí)例的相關(guān)資料,希望通過(guò)本文能幫助到大家,需要的朋友可以參考下2017-09-09Java 生成任意長(zhǎng)度的驗(yàn)證碼過(guò)程解析
這篇文章主要介紹了Java 生成任意長(zhǎng)度的驗(yàn)證碼過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-10-10java并發(fā)包中CountDownLatch和線程池的使用詳解
這篇文章主要介紹了java并發(fā)包中CountDownLatch和線程池的使用詳解,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2021-02-02淺談Java實(shí)現(xiàn)面向?qū)ο缶幊蘪ava oop
這篇文章主要介紹了淺談Java實(shí)現(xiàn)面向?qū)ο缶幊蘪ava oop,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07Java中Arrays工具類(lèi)的一些常見(jiàn)方法總結(jié)
在Java中Arrays類(lèi)是一個(gè)實(shí)用工具類(lèi),用于在數(shù)組上執(zhí)行各種操作,包括排序、搜索、比較等,這篇文章主要給大家介紹了關(guān)于Java中Arrays工具類(lèi)的一些常見(jiàn)方法,文中通過(guò)圖文介紹的非常詳細(xì),需要的朋友可以參考下2024-02-02