【Spring】HttpMessageConverter的作用及替換

相信使用過Spring的開發(fā)人員都用過@RequestBody、@ResponseBody注解,可以直接將輸入解析成Json、將輸出解析成Json,但HTTP 請求和響應(yīng)是基于文本的,意味著瀏覽器和服務(wù)器通過交換原始文本進(jìn)行通信,而這里其實(shí)就是HttpMessageConverter發(fā)揮著作用。

HttpMessageConverter

Http請求響應(yīng)報(bào)文其實(shí)都是字符串,當(dāng)請求報(bào)文到j(luò)ava程序會被封裝為一個(gè)ServletInputStream流,開發(fā)人員再讀取報(bào)文,響應(yīng)報(bào)文則通過ServletOutputStream流,來輸出響應(yīng)報(bào)文。

從流中只能讀取到原始的字符串報(bào)文,同樣輸出流也是。那么在報(bào)文到達(dá)SpringMVC / SpringBoot和從SpringMVC / SpringBoot出去,都存在一個(gè)字符串到j(luò)ava對象的轉(zhuǎn)化問題。這一過程,在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 + "'";
}

在請求進(jìn)入test方法前,會根據(jù)@RequestBody注解選擇對應(yīng)的HttpMessageConverter實(shí)現(xiàn)類來將請求參數(shù)解析到param變量中,因?yàn)檫@里的參數(shù)是String類型的,所以這里是使用了StringHttpMessageConverter類,它的canRead()方法返回true,然后read()方法會從請求中讀出請求參數(shù),綁定到test()方法的param變量中。

同理當(dāng)執(zhí)行test方法后,由于返回值標(biāo)識了@ResponseBody,SpringMVC / SpringBoot將使用StringHttpMessageConverter的write()方法,將結(jié)果作為String值寫入響應(yīng)報(bào)文,當(dāng)然,此時(shí)canWrite()方法返回true。

借用下圖簡單描述整個(gè)過程:


00001.png

在Spring的處理過程中,一次請求報(bào)文和一次響應(yīng)報(bào)文,分別被抽象為一個(gè)請求消息HttpInputMessage和一個(gè)響應(yīng)消息HttpOutputMessage。

處理請求時(shí),由合適的消息轉(zhuǎn)換器將請求報(bào)文綁定為方法中的形參對象,在這里同一個(gè)對象就有可能出現(xiàn)多種不同的消息形式,如json、xml。同樣響應(yīng)請求也是同樣道理。

在Spring中,針對不同的消息形式,有不同的HttpMessageConverter實(shí)現(xiàn)類來處理各種消息形式,至于各種消息解析實(shí)現(xiàn)的不同,則在不同的HttpMessageConverter實(shí)現(xiàn)類中。

替換@ResponseBody默認(rèn)的HttpMessageConverter

這里使用SpringBoot演示例子,在SpringMVC / SpringBoot中@RequestBody這類注解默認(rèn)使用的是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解析的結(jié)果,現(xiàn)在來改成使用fastjson解析對象,這里就是替換默認(rèn)的HttpMessageConverter,就是將其改成使用FastJsonHttpMessageConverter來處理Java對象與HttpInputMessage/HttpOutputMessage間的轉(zhuǎn)化。

首先新建一配置類來添加配置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,不使用默認(rèn)的jackson
    //必須在pom.xml引入fastjson的jar包,并且版必須大于1.2.10
    @Bean
    public HttpMessageConverters fastJsonHttpMessageConverters() {
        //1、定義一個(gè)convert轉(zhuǎn)換消息的對象
        FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();

        //2、添加fastjson的配置信息
        FastJsonConfig fastJsonConfig = new FastJsonConfig();

        SerializerFeature[] serializerFeatures = new SerializerFeature[]{
                //    輸出key是包含雙引號
//                SerializerFeature.QuoteFieldNames,
                //    是否輸出為null的字段,若為null 則顯示該字段
//                SerializerFeature.WriteMapNullValue,
                //    數(shù)值字段如果為null,則輸出為0
                SerializerFeature.WriteNullNumberAsZero,
                //     List字段如果為null,輸出為[],而非null
                SerializerFeature.WriteNullListAsEmpty,
                //    字符類型字段如果為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);
    }
}

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


00003.png

可以看到此時(shí)null都轉(zhuǎn)化成“”或0了。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容