從零搭建自己的SpringBoot後臺框架(四)

Mr_初晨發表於2018-04-19
Spring Boot框架
Hello大家好，本章我們新增自定義訊息轉換器。有問題可以聯絡我mr_beany@163.com。另求各路大神指點，感謝

一：訊息轉換器能幹什麼？

不知道大家有沒有遇到過這種情況：後臺介面返回一個例項，當你需要使用某個屬性的值時，你還要判斷一下值是否為null；介面返回一堆屬性值為null的屬性等

ok，訊息轉換器可以幫你解決這個問題

二：新增fastjson依賴

開啟pom.xml，找到<dependencies></dependencies>標籤，在標籤中新增fastjson依賴

<dependency>
   <groupId>com.alibaba</groupId>
   <artifactId>fastjson</artifactId>
   <version>1.2.22</version>
</dependency>複製程式碼

然後滑鼠右鍵選擇Maven→Reimport進行依賴下載

三：建立配置檔案

在資料夾configurer中建立WebConfigurer

package com.example.demo.core.configurer;

import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter4;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;

/**
 * @author 張瑤
 * @Description:
 * @time 2018/4/19 10:42
 */
@Configuration
public class WebConfigurer extends WebMvcConfigurationSupport {

    /**
     * 修改自定義訊息轉換器
     * @param converters
     */
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        FastJsonHttpMessageConverter4 converter = new FastJsonHttpMessageConverter4();
        converter.setSupportedMediaTypes(getSupportedMediaTypes());
        FastJsonConfig config = new FastJsonConfig();
        config.setSerializerFeatures(
            // String null -> ""
            SerializerFeature.WriteNullStringAsEmpty,
            // Number null -> 0
            SerializerFeature.WriteNullNumberAsZero,
            //禁止迴圈引用
            SerializerFeature.DisableCircularReferenceDetect
        );
        converter.setFastJsonConfig(config);
        converter.setDefaultCharset(Charset.forName("UTF-8"));
        converters.add(converter);
    }

    private List<MediaType> getSupportedMediaTypes() {
        List<MediaType> supportedMediaTypes = new ArrayList<>();
        supportedMediaTypes.add(MediaType.APPLICATION_JSON);
        supportedMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
        supportedMediaTypes.add(MediaType.APPLICATION_ATOM_XML);
        supportedMediaTypes.add(MediaType.APPLICATION_FORM_URLENCODED);
        supportedMediaTypes.add(MediaType.APPLICATION_OCTET_STREAM);
        supportedMediaTypes.add(MediaType.APPLICATION_PDF);
        supportedMediaTypes.add(MediaType.APPLICATION_RSS_XML);
        supportedMediaTypes.add(MediaType.APPLICATION_XHTML_XML);
        supportedMediaTypes.add(MediaType.APPLICATION_XML);
        supportedMediaTypes.add(MediaType.IMAGE_GIF);
        supportedMediaTypes.add(MediaType.IMAGE_JPEG);
        supportedMediaTypes.add(MediaType.IMAGE_PNG);
        supportedMediaTypes.add(MediaType.TEXT_EVENT_STREAM);
        supportedMediaTypes.add(MediaType.TEXT_HTML);
        supportedMediaTypes.add(MediaType.TEXT_MARKDOWN);
        supportedMediaTypes.add(MediaType.TEXT_PLAIN);
        supportedMediaTypes.add(MediaType.TEXT_XML);
        return supportedMediaTypes;
    }
}複製程式碼

其中

config.setSerializerFeatures()複製程式碼

方法中可以新增多個配置，以下列舉出幾個常用配置，更多配置請自行百度

WriteNullListAsEmpty  ：List欄位如果為null,輸出為[],而非null
WriteNullStringAsEmpty ： 字元型別欄位如果為null,輸出為"",而非null
DisableCircularReferenceDetect ：消除對同一物件迴圈引用的問題，預設為false（如果不配置有可能會進入死迴圈）
WriteNullBooleanAsFalse：Boolean欄位如果為null,輸出為false,而非null
WriteMapNullValue：是否輸出值為null的欄位,預設為false複製程式碼

四：資料庫中新增測試資料

INSERT INTO `user_info` VALUES ('1', '1');
INSERT INTO `user_info` VALUES ('2', null);複製程式碼

五：測試

查詢條件id為2

未配置轉換器時，查詢結果為

{
    "code": 200,
    "msg": "success",
    "data": {
        "id": 2,
        "userName": null
    }
}複製程式碼

配置轉換器之後，查詢結果為

{
    "code": 200,
    "data": {
        "id": 2,
        "userName": ""   //這裡已經變為"",而不是null
    },
    "msg": "success"
}複製程式碼

專案地址

碼雲地址： gitee.com/beany/mySpr…

GitHub地址： github.com/MyBeany/myS…

寫文章不易，如對您有幫助，請幫忙點下star從零搭建自己的SpringBoot後臺框架(四)

結尾

springboot新增自定義訊息轉換器已完成，後續功能接下來陸續更新，有問題可以聯絡我mr_beany@163.com。另求各路大神指點，感謝大家。


相關文章