Fastjson JSONField
Fastjson JSONField
1. JSONField 介紹
注意:1、若屬性是私有的,必須有set*方法。否則無法反序列化。
package com.alibaba.fastjson.annotation; public @interface JSONField { // 配置序列化和反序列化的顺序,1.1.42版本之后才支持 int ordinal() default 0; // 指定字段的名称 String name() default ""; // 指定字段的格式,对日期格式有用 String format() default ""; // 是否序列化 boolean serialize() default true; // 是否反序列化 boolean deserialize() default true; }
2. JSONField設定方式
FieldInfo可以設定在getter/setter方法或欄位上。例如:
2.1 設定在getter/setter上
public class A { private int id; @JSONField(name="ID") public int getId() {return id;} @JSONField(name="ID") public void setId(int value) {this.id = id;} }
public class A {
@JSONField(name="ID")
private int id;
public int getId() {return id;}
public void setId(int value) {this.id = id;}
}
public class A {
// 配置date序列化和反序列使用yyyyMMdd日期格式
@JSONField(format="yyyyMMdd")
public Date date;
}
預設fastjson序列化一個java bean,是根據fieldName的字母序來序列化的,你可以透過ordinal指定欄位的順序。這個特性需要1.1.42以上版本。
public static class VO {
@JSONField(ordinal = 3)
private int f0;
@JSONField(ordinal = 2)
private int f1;
@JSONField(ordinal = 1)
private int f2;
}
6. 使用serializeUsing制定属性的序列化类
在fastjson 1.2.16版本之後,JSONField支援新的客製化配置serializeUsing,可以單獨對某一個類別的某個屬性自訂序列化,例如:
public static class Model { @JSONField(serializeUsing = ModelValueSerializer.class) public int value; } public static class ModelValueSerializer implements ObjectSerializer { @Override public void write(JSONSerializer serializer, Object object, Object fieldName, Type fieldType, int features) throws IOException { Integer value = (Integer) object; String text = value + "元"; serializer.write(text); } }
測試程式碼
Model model = new Model(); model.value = 100; String json = JSON.toJSONString(model); Assert.assertEquals("{\"value\":\"100元\"}", json);#
7、JSONField alternateNames
在fastjson在1.2.21版本中提供了一個借鑒自gson的特性,支援反序列化時使用多個不同的欄位名稱,使用的方式是設定JSONField的alternateNames。
Demo
public static class Model { public int id; @JSONField(alternateNames = {"user", "person"}) public String name; } String jsonVal0 = "{\"id\":5001,\"name\":\"Jobs\"}"; String jsonVal1 = "{\"id\":5382,\"user\":\"Mary\"}"; String jsonVal2 = "{\"id\":2341,\"person\":\"Bob\"}"; Model obj0 = JSON.parseObject(jsonVal0, Model.class); assertEquals(5001, obj0.id); assertEquals("Jobs", obj0.name); Model obj1 = JSON.parseObject(jsonVal1, Model.class); assertEquals(5382, obj1.id); assertEquals("Mary", obj1.name); Model obj2 = JSON.parseObject(jsonVal2, Model.class); assertEquals(2341, obj2.id); assertEquals("Bob", obj2.name);
8、JSONField jsonDirect
在fastjson-1.2.12版本中,JSONField支持一個新的配置項目jsonDirect,它的用途是:當你有一個字段是字符串類型,裡面是json格式數據,你希望直接輸入,而不是經過轉義之後再輸出。
Model
import com.alibaba.fastjson.annotation.JSONField; public static class Model { public int id; @JSONField(jsonDirect=true) public String value; }
#Usage
Model model = new Model(); model.id = 1001; model.value = "{}"; String json = JSON.toJSONString(model); Assert.assertEquals("{\"id\":1001,\"value\":{}}", json);