@RequestBody、@ResponseBody注解是如何將輸入輸出轉換成json的


@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。

借用下圖簡單描述整個過程:

 

 
00001.png

 

在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返回如下:

 

 
00002.png

 

這就是使用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); } } 

這里將字符串類型的值如果是null就返回“”,數值類型的如果是null就返回0,重啟應用,再次訪問/user/testt接口,返回如下:

 

 
00003.png

 

可以看到此時null都轉化成“”或0了。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM