關於json序列化(javaBean轉Json的細節處理)

Posted on by

json序列化(javaBean轉Json的細節)

Java對象在轉json的時候，如果對象裡面有屬性值為null的話，那麼在json序列化的時候要不要序列出來呢？對比以下json轉換方式

三種常見的json jar序列化

fastjson

阿裡巴巴提供的fastjson，當用json轉換實體類時

  • –無get開頭的方法，將找不到序列器。
  • –如果有get開頭的方法，但是無此get方法後面的字段，也找不到序列器[元數據一體化的項目落到此坑]。
  • –證明它與get開頭的方法有關。
  • –fastJson在轉換java對象為json的時候，fastjson默認轉換是不序列化null值對應的key的。
//當字段為基本數據類型時，例如當字段類型為int類型時：
private int start;
private int limit;
// 我如果不set值的時候，會序列化為下面這樣
"limit":0,"start":0

默認為都是0瞭，而我的目標是如果不設置值的時候，它們不會出現。

我是簡單地通過把他們的類型改為Integer瞭。應該有其它通過自定義序列化行為的方式來解決，暫不研究。

但是如果想把null對應的key序列化出來呢？

那就要仔細看看fastjson轉換java對象為json的時候的入參瞭：也就是這個方法：

JSONObject.toJSONString(Object object, SerializerFeature... features)

Fastjson的SerializerFeature序列化屬性：

  • QuoteFieldNames：輸出key時是否使用雙引號,默認為true
  • WriteMapNullValue：是否輸出值為null的字段,默認為false
  • WriteNullNumberAsZero：數值字段如果為null,輸出為0,而非null
  • WriteNullListAsEmpty：List字段如果為null,輸出為[],而非null
  • WriteNullStringAsEmpty：字符類型字段如果為null,輸出為”“,而非null
  • WriteNullBooleanAsFalse：Boolean字段如果為null,輸出為false,而非null

結合上面，SerializerFeature… features是個數組，那麼我們可以傳入我們想要的參數，比如想序列化null，案例如下：

public static void main(String[] args) {
AutoPartsSearchRequest request = new AutoPartsSearchRequest();
request.setKeywords("123");
request.setSortingField("234242");
String str = JSONObject.toJSONString(request, SerializerFeature.WriteMapNullValue);
System.out.println(str);
}

Jackson

java開源的Jackson類，也與get開頭的方法有關【同上】。

jackson默認是序列化null對應的key的，也就是說不管你對象屬性有沒有值，在轉換json的時候都會被序列化出來
public static void main(String[] args) throws JsonGenerationException, JsonMappingException, IOException {
AutoPartsSearchRequest request = new AutoPartsSearchRequest();
request.setKeywords("123");
request.setSortingField("234242");
ObjectMapper mapper = new ObjectMapper();
String str = mapper.writeValueAsString(request);
System.out.println(str);
//輸出結果(此處就不格式化瞭)：{"sortingField":"234242","partsClassifyId":null,"partsSubClassifyId":null,"sortingDirection":null:......
}

同理，想要不序列化null也是可以的，具體如下：

實體上 

@JsonInclude(Include.NON_NULL)
 
//將該標記放在屬性上，如果該屬性為NULL則不參與序列化
//如果放在類上邊,那對這個類的全部屬性起作用
//Include.Include.ALWAYS 默認
//Include.NON_DEFAULT 屬性為默認值不序列化
//Include.NON_EMPTY 屬性為 空（“”） 或者為 NULL 都不序列化
//Include.NON_NULL 屬性為NULL 不序列化

  

代碼上

ObjectMapper mapper = new ObjectMapper(); 
mapper.setSerializationInclusion(Include.NON_NULL);
 
//通過該方法對mapper對象進行設置，所有序列化的對象都將按改規則進行系列化
//Include.Include.ALWAYS 默認
//Include.NON_DEFAULT 屬性為默認值不序列化
//Include.NON_EMPTY 屬性為 空（“”） 或者為 NULL 都不序列化
//Include.NON_NULL 屬性為NULL 不序列化

註意：隻對VO起作用，Map List不起作用，另外jackson還能過濾掉你設置的屬性，具體的就各位自己去研究源碼瞭

Gson

Google提供的Gson，該gson序列化隻與屬性(字段)有關，與get開頭的方法無關。

gson和fastjson一樣，默認是不序列化null值對應的key的，具體案例如下： 

public static void main(String[] args) throws JsonGenerationException, JsonMappingException, IOException {
AutoPartsSearchRequest request = new AutoPartsSearchRequest();
request.setKeywords("123");
request.setSortingField("234242");
Gson g = new GsonBuilder().create();
String str = g.toJson(request);
System.out.println(str);
//輸出結果：{"sortingField":"234242","keywords":"123"}
}

若是想序列化null值對應的key，隻需要將以上創建代碼改成以下代碼就行：

Gson g = new GsonBuilder().serializeNulls().create();

json序列化的處理

在json的數據處理過程中，最讓人無奈的就是json serializable的問題，遇到的多瞭，慢慢就總結瞭一點經驗。

還是要從最基礎的說起

正如上面所說的

  • 在將dict, list等python對象編碼成json字符串的時候就要用到json.dumps()而將json字符串解碼為python 對象時用的是json.loads()
  •  至於其他的基礎知識查文檔都可以看到，我主要說一下遇到問題怎麼解決。
class JSONEncoder(json.JSONEncoder):
    """ solve the problem that ObjectId and datetime can't serializable"""
    def default(self, o):
        if isinstance(o, ObjectId):
            return str(o)
        if isinstance(o, datetime):
            return o.isoformat()
        if isinstance(o, UUID):
            return o.hex
        return json.JSONEncoder.default(self, o)

直接將遇到的不能轉換的類型分裝成一個類，尤其是在mongodb的數據處理中，經常能碰到objectid ,datetime,uuid的轉換錯誤，以後要是遇到別的繼續添加就是。

其中ObjectId要從bson引入。

from bson import ObjectId

datetime也要引入也有可能遇到NoneType的情況

NoneType要從types引入

from types import NoneType

UUID要從uuid引入

from uuid import UUID

接下來就是在處理的函數中調用這個類即可。

比如說我們有一個python_dict，想要將其轉化為json_str

json_str= json.dumps(python_dict,cls=JSONEncoder,indent=4)

其中參數cls 是我們自己封裝的類，indent參數一個數字，也可以不加，在這加的原因後面會提到。

如果我們想要讓打印出來的json_str具有醒目的格式，indent則會很有用，至於具體的數字是多少，隨你設定，設置為4是因為和python的縮進是一致的，看起來舒服而已。

如果想要在前端頁面中顯示出來json的樣式。

有兩種方式：

  • 在前端使用js實現在將數據存入數據庫之前我們就將數據轉換為標準的 json 字符串，直接在頁面調用即可。
  • 比如在flask中，直接使用<pre>標簽即可。
<pre>{{json_str}}</pre>

這樣顯示出來的就是標準的json樣式瞭，對於內容一目瞭然。

補充：

其中有一個比較坑的地方。其實到這一步的時候我們該做的都已經做瞭，講道理來說應該沒什麼問題瞭。但是在實踐的過程中我發現頁面展示出來的結果中文格式還是不正確。是'\u***\u**'這樣的unicode編碼。回到數據庫查看發現數據在存的時候就存的是unciode的編碼。

最後查看json_str的格式，發現確實是unicode的編碼，這樣當然不會顯示正確瞭。

所以最後一步再加上

json_str = json_str.encode('utf-8')

將json字符串以'utf-8'進行編碼。

這樣問題就完美的得到瞭解決。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：