Json 是一種文本形式的數據交換格式,比 xml 更爲輕量。Json 的解析和生成的方式不少,在 Android 平臺上最經常使用的類庫有 Gson 和 FastJson 兩種,這裏要介紹的是 Gsonjava
Gson 的 GitHub 主頁點擊這裏:git
https://github.com/google/gsongithub
Gson的基本用法json
Gson對象數組
在進行序列化與反序列操做前,須要先實例化一個 com .google.gson.Gson 對象,獲取 Gson 對象的方法有兩種服務器
//經過構造函數來獲取
Gson gson = new Gson();
//經過 GsonBuilder 來獲取,能夠進行多項特殊配置
Gson gson = new GsonBuilder().create();
利用 Gson 能夠很方便地生成 Json 字符串,經過使用 addProperty 的四個重載方法ide
public static void main(String[] args) {
JsonObject jsonObject = new JsonObject();
jsonObject.addProperty("String", "leavesC");
jsonObject.addProperty("Number_Integer", 23);
jsonObject.addProperty("Number_Double", 22.9);
jsonObject.addProperty("Boolean", true);
jsonObject.addProperty("Char", 'c');
System.out.println();
System.out.println(jsonObject);
}
addProperty 方法底層調用的是 add(String property, JsonElement value) 方法,即將基本數據類型轉化爲了 JsonElement 對象,JsonElement 是一個抽象類,而 JsonObject 繼承了 JsonElement ,所以咱們能夠經過 JsonObject 本身來構建一個 JsonElement函數
public static void main(String[] args) {
JsonObject jsonObject = new JsonObject();
jsonObject.addProperty("String", "leavesC");
jsonObject.addProperty("Number", 23);
jsonObject.addProperty("Number", 22.9);
jsonObject.addProperty("Boolean", true);
jsonObject.addProperty("Char", 'c');
JsonObject jsonElement = new JsonObject();
jsonElement.addProperty("Boolean", false);
jsonElement.addProperty("Double", 25.9);
jsonElement.addProperty("Char", 'c');
jsonObject.add("JsonElement", jsonElement);
System.out.println();
System.out.println(jsonObject);
}
Json與數組、List的轉化ui
Json數組 與 字符串數組this
public static void main(String[] args) {
//Json數組 轉爲 字符串數組
Gson gson = new Gson();
String jsonArray = "[\"https://github.com/leavesC\",\"https://www.jianshu.com/u/9df45b87cfdf\",\"Java\",\"Kotlin\",\"Git\",\"GitHub\"]";
String[] strings = gson.fromJson(jsonArray, String[].class);
System.out.println("Json數組 轉爲 字符串數組: ");
for (String string : strings) {
System.out.println(string);
}
//字符串數組 轉爲 Json數組
jsonArray = gson.toJson(jsonArray, new TypeToken<String>() {
}.getType());
System.out.println("\n字符串數組 轉爲 Json數組: ");
System.out.println(jsonArray);
}
Json數組 與 List
public static void main(String[] args) {
//Json數組 轉爲 List
Gson gson = new Gson();
String jsonArray = "[\"https://github.com/leavesC\",\"https://www.jianshu.com/u/9df45b87cfdf\",\"Java\",\"Kotlin\",\"Git\",\"GitHub\"]";
List<String> stringList = gson.fromJson(jsonArray, new TypeToken<List<String>>() {
}.getType());
System.out.println("\nJson數組 轉爲 List: ");
for (String string : stringList) {
System.out.println(string);
}
//List 轉爲 Json數組
jsonArray = gson.toJson(stringList, new TypeToken<List<String>>() {
}.getType());
System.out.println("\nList 轉爲 Json數組: ");
System.out.println(jsonArray);
}
Gson 也提供了 toJson() 和 fromJson() 兩個方法用於轉化 Model 與 Json,前者實現了序列化,後者實現了反序列化。首先,聲明一個 User 類
/**
* 做者:chenZY
* 時間:2018/3/17 18:32
* 描述:https://github.com/leavesC
*/
public class User {
private String name;
private int age;
private boolean sex;
public User(String name, int age, boolean sex) {
this.name = name;
this.age = age;
this.sex = sex;
}
@Override
public String toString() {
return "User{" +
"name='" + name + '\'' +
", age=" + age +
", sex=" + sex +
'}';
}
}
序列化的方法很簡單,調用 gson 對象的 toJson 方法,傳入要序列化的對象
public static void main(String[] args) {
//序列化
User user = new User("leavesC", 24, true);
Gson gson = new Gson();
System.out.println();
System.out.println(gson.toJson(user));
}
反序化的方式也相似
public static void main(String[] args) {
//反序列化
String userJson = "{\"name\":\"leavesC\",\"age\":24,\"sex\":true}";
Gson gson = new Gson();
User user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
}
屬性重命名
繼續使用上一節聲明的 User 類,根據 User 類聲明的各個屬性名,移動端的開發者但願接口返回的數據格式便是以下這樣的
{"name":"leavesC","age":24,"sex":true}
若是沒有和服務器端溝通好或者是 API 改版了,接口返回的數據格式多是這樣的
{"Name":"leavesC","age":24,"sex":true}
{"userName":"leavesC","age":24,"sex":true}
若是繼續使用上一節介紹的方法,那無疑會解析出錯。例如
public static void main(String[] args) {
//反序列化
String userJson = "{\"userName\":\"leavesC\",\"age\":24,\"sex\":true}";
Gson gson = new Gson();
User user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
}
name 屬性值解析不到,因此爲 null
此時爲了兼顧多種格式的數據,就須要使用 SerializedName 註解。根據 SerializedName 的聲明來看,SerializedName 包含兩個屬性值,一個是字符串,一個是字符串數組,而字符串數組含有默認值
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
public @interface SerializedName {
String value();
String[] alternate() default {};
}
SerializedName 的做用是爲了在序列化或反序列化時,指導 Gson 若是將原有的屬性名和其它特殊狀況下的屬性名聯繫起來。
例如,修改 User 類,爲 name 聲明 SerializedName 註解,註解值爲 userName
/**
* 做者:chenZY
* 時間:2018/3/17 18:32
* 描述:https://github.com/leavesC
*/
public class User {
@SerializedName("userName")
private String name;
private int age;
private boolean sex;
}
在序列時,Json 格式就會相應改變
public static void main(String[] args) {
//序列化
User user = new User("leavesC", 24, true);
Gson gson = new Gson();
System.out.println();
System.out.println(gson.toJson(user));
}
在反序列化時也同樣,可以解析到正確的屬性值
public static void main(String[] args) {
//反序列化
String userJson = "{\"userName\":\"leavesC\",\"age\":24,\"sex\":true}";
Gson gson = new Gson();
User user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
}
還有個問題沒解決,爲了應對多種屬性名不一致的狀況,難道咱們要聲明多個 User 類嗎?這顯然是不現實的,因此還須要爲 User 類設置多個備選屬性名,這就須要用到 SerializedName 註解的另外一個屬性值 alternate 了。
/**
* 做者:chenZY
* 時間:2018/3/17 18:32
* 描述:https://github.com/leavesC
*/
public class User {
@SerializedName(value = "userName", alternate = {"user_name", "Name"})
private String name;
private int age;
private boolean sex;
}
如下幾種狀況都可以被正確的反序列化
public static void main(String[] args) {
//反序列化
Gson gson = new Gson();
String userJson = "{\"userName\":\"leavesC\",\"age\":24,\"sex\":true}";
User user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
userJson = "{\"user_name\":\"leavesC\",\"age\":24,\"sex\":true}";
user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
userJson = "{\"Name\":\"leavesC\",\"age\":24,\"sex\":true}";
user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
}
字段過濾
有時候並非全部的字段都須要進行系列化和反序列化,所以須要對某些字段進行排除,有四種方法能夠來實現這種需求。
基於@Expose註解
Expose 註解包含兩個屬性值,且均聲明瞭默認值。Expose 的含義即爲「暴露」,即用於對外暴露字段,serialize 用於指定是否進行序列化,deserialize 用於指定是否進行反序列化。若是字段不聲明 Expose 註解,則意味着不進行序列化和反序列化操做,至關於兩個屬性值均爲 false 。此外,Expose 註解須要和 GsonBuilder 構建的 Gson 對象一塊兒使用才能生效。
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface Expose {
boolean serialize() default true;
boolean deserialize() default true;
}
Expose 註解的註解值聲明狀況有四種
@Expose(serialize = true, deserialize = true) //序列化和反序列化都生效
@Expose(serialize = false, deserialize = true) //序列化時不生效,反序列化時生效
@Expose(serialize = true, deserialize = false) //序列化時生效,反序列化時不生效
@Expose(serialize = false, deserialize = false) //序列化和反序列化都不生效,和不寫註解同樣
如今來看個例子,修改 User 類
/**
* 做者:chenZY
* 時間:2018/3/17 18:32
* 描述:https://github.com/leavesC
*/
public class User {
@Expose(serialize = true, deserialize = true) //序列化和反序列化都生效
private String a;
@Expose(serialize = false, deserialize = true) //序列化時不生效,反序列化時生效
private String b;
@Expose(serialize = true, deserialize = false) //序列化時生效,反序列化時不生效
private String c;
@Expose(serialize = false, deserialize = false) //序列化和反序列化都不生效,和不寫註解同樣
private String d;
private String e;
public User(String a, String b, String c, String d, String e) {
this.a = a;
this.b = b;
this.c = c;
this.d = d;
this.e = e;
}
@Override
public String toString() {
return "User{" +
"a='" + a + '\'' +
", b='" + b + '\'' +
", c='" + c + '\'' +
", d='" + d + '\'' +
", e='" + e + '\'' +
'}';
}
}
按照如上的註解值,只有聲明瞭 Expose 註解且 serialize 值爲 true 的字段才能被序列化,只有聲明瞭 Expose 註解且 deserialize 值爲 true 的字段才能被反序列化
public static void main(String[] args) {
Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
User user = new User("A", "B", "C", "D", "E");
System.out.println();
System.out.println(gson.toJson(user));
String json = "{\"a\":\"A\",\"b\":\"B\",\"c\":\"C\",\"d\":\"D\",\"e\":\"E\"}";
user = gson.fromJson(json, User.class);
System.out.println();
System.out.println(user.toString());
}
Gson 提供了 @Since 和 @Until 兩個註解基於版本對字段進行過濾,@Since 和 @Until 都包含一個 Double 屬性值,用於設置版本號。Since 的意思是「自……開始」,Until 的意思是「到……爲止」,同樣要和 GsonBuilder 配合使用。
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.TYPE})
public @interface Since {
double value();
}
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.TYPE})
public @interface Until {
double value();
}
當版本( GsonBuilder 設置的版本) 大於或等於 Since 屬性值或小於 Until 屬性值時字段會進行序列化和反序列化操做,而沒有聲明註解的字段都會加入序列化和反序列操做。
如今來看個例子,修改 User 類
/**
* 做者:chenZY
* 時間:2018/3/17 18:32
* 描述:https://github.com/leavesC
*/
public class User {
@Since(1.4)
private String a;
@Since(1.6)
private String b;
@Since(1.8)
private String c;
@Until(1.6)
private String d;
@Until(2.0)
private String e;
public User(String a, String b, String c, String d, String e) {
this.a = a;
this.b = b;
this.c = c;
this.d = d;
this.e = e;
}
@Override
public String toString() {
return "User{" +
"a='" + a + '\'' +
", b='" + b + '\'' +
", c='" + c + '\'' +
", d='" + d + '\'' +
", e='" + e + '\'' +
'}';
}
}
public static void main(String[] args) {
Gson gson = new GsonBuilder().setVersion(1.6).create();
User user = new User("A", "B", "C", "D", "E");
System.out.println();
System.out.println(gson.toJson(user));
String json = "{\"a\":\"A\",\"b\":\"B\",\"c\":\"C\",\"d\":\"D\",\"e\":\"E\"}";
user = gson.fromJson(json, User.class);
System.out.println();
System.out.println(user.toString());
}
訪問修飾符由 java.lang.reflect.Modifier 提供 int 類型的定義,而 GsonBuilder 對象的 excludeFieldsWithModifiers方法接收一個 int 類型可變參數,指定不進行序列化和反序列化操做的訪問修飾符字段。看個例子
/**
* 做者:chenZY
* 時間:2018/3/17 18:32
* 描述:https://github.com/leavesC
*/
public class ModifierSample {
public String publicField = "public";
protected String protectedField = "protected";
private String privateField = "private";
String defaultField = "default";
final String finalField = "final";
static String staticField = "static";
}
public static void main(String[] args) {
Gson gson = new GsonBuilder().excludeFieldsWithModifiers(Modifier.PRIVATE, Modifier.STATIC).create();
ModifierSample modifierSample = new ModifierSample();
System.out.println(gson.toJson(modifierSample));
}
GsonBuilder 類包含 setExclusionStrategies(ExclusionStrategy... strategies)方法用於傳入不定長參數的策略方法,用於直接排除指定字段名或者指定字段類型。看個例子
/**
* 做者:chenZY
* 時間:2018/3/17 18:32
* 描述:https://github.com/leavesC
*/
public class Strategies {
private String stringField;
private int intField;
private double doubleField;
public Strategies(String stringField, int intField, double doubleField) {
this.stringField = stringField;
this.intField = intField;
this.doubleField = doubleField;
}
@Override
public String toString() {
return "Strategies{" +
"stringField='" + stringField + '\'' +
", intField=" + intField +
", doubleField=" + doubleField +
'}';
}
}
public static void main(String[] args) {
Gson gson = new GsonBuilder().setExclusionStrategies(new ExclusionStrategy() {
@Override
public boolean shouldSkipField(FieldAttributes fieldAttributes) {
//排除指定字段名
return fieldAttributes.getName().equals("intField");
}
@Override
public boolean shouldSkipClass(Class<?> aClass) {
//排除指定字段類型
return aClass.getName().equals(double.class.getName());
}
}).create();
Strategies strategies = new Strategies("stringField", 111, 11.22);
System.out.println();
System.out.println(gson.toJson(strategies));
String json = "{\"stringField\":\"stringField\",\"intField\":111,\"doubleField\":11.22}";
strategies = gson.fromJson(json, Strategies.class);
System.out.println();
System.out.println(strategies);
}
字段名爲 "intField" 和字段類型爲 double 的字段都會被排除掉
setExclusionStrategies 方法在序列化和反序列化時都會生效,若是隻是想指定其中一種狀況下的排除策略或分別指定排除策略,能夠改成使用如下兩個方法
addSerializationExclusionStrategy(ExclusionStrategy strategy);
addDeserializationExclusionStrategy(ExclusionStrategy strategy);
個性化設置
輸出 null
對於 Gson 而言,在序列化時若是某個屬性值爲 null 的話,那麼在序列化時該字段不會參與進來,若是想要顯示輸出該字段的話,能夠經過 GsonBuilder 進行配置
/**
* 做者:chenZY
* 時間:2018/3/17 18:32
* 描述:https://github.com/leavesC
*/
public class Strategies {
private String stringField;
private int intField;
private double doubleField;
}
public static void main(String[] args) {
Gson gson = new GsonBuilder()
.serializeNulls() //輸出null
.create();
Strategies strategies = new Strategies(null, 24, 22.333);
System.out.println();
System.out.println(gson.toJson(strategies));
}
默認的序列化後的 Josn 字符串並不太直觀,能夠選擇格式化輸出
public static void main(String[] args) {
Gson gson = new GsonBuilder()
.serializeNulls() //輸出null
.setPrettyPrinting()//格式化輸出
.create();
Strategies strategies = new Strategies(null, 24, 22.333);
System.out.println();
System.out.println(gson.toJson(strategies));
}
格式化時間
Gson 也能夠對時間值進行格式化
/**
* 做者:chenZY
* 時間:2018/3/17 18:32
* 描述:https://github.com/leavesC
*/
public class Strategies {
private Date date;
private Date date2;
public Strategies(Date date, Date date2) {
this.date = date;
this.date2 = date2;
}
@Override
public String toString() {
SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss:SSS", Locale.CHINA);
return "Strategies{" +
"date=" + simpleDateFormat.format(date) +
", date2=" + simpleDateFormat.format(date2) +
'}';
}
}
public static void main(String[] args) {
Gson gson = new GsonBuilder()
.setPrettyPrinting()//格式化輸出
.setDateFormat("yyyy-MM-dd HH:mm:ss:SSS")//格式
化時間
.create();
Date date = new Date();
Strategies strategies = new Strategies(date, new Date(date.getTime() + 1000000));
System.out.println();
System.out.println(gson.toJson(strategies));
String json = "{\n" +
" \"date\": \"2018-03-17 19:38:50:033\",\n" +
" \"date2\": \"2018-03-17 19:55:30:033\"\n" +
"}";
System.out.println();
System.out.println(gson.fromJson(json, Strategies.class));
}
TypeAdapter
TypeAdapter 是一個泛型抽象類,用於接管某種類型的序列化和反序列化過程,包含兩個抽象方法,分別用於自定義序列化和反序列化過程
public abstract void write(JsonWriter var1, T var2) throws IOException;
public abstract T read(JsonReader var1) throws IOException;
下面看個簡單的例子
/**
* 做者:chenZY
* 時間:2018/3/17 18:32
* 描述:https://github.com/leavesC
*/
public class User {
private String name;
private int age;
private boolean sex;
public User() {
}
public User(String name, int age, boolean sex) {
this.name = name;
this.age = age;
this.sex = sex;
}
@Override
public String toString() {
return "User{" +
"name='" + name + '\'' +
", age=" + age +
", sex=" + sex +
'}';
}
}
定義 TypeAdapter 的子類 UserTypeAdapter 來接管 User 類的序列化和反序列化過程。
這裏設定當 User 類序列化時 Json 中的Key值都是大寫字母開頭,反序列化時支持「name」和「Name」兩種不一樣的 Json 風格
public class UserTypeAdapter extends TypeAdapter<User> {
@Override
public void write(JsonWriter jsonWriter, User user) throws IOException {
//流式序列化成對象開始
jsonWriter.beginObject();
//將Json的Key值都指定爲大寫字母開頭
jsonWriter.name("Name").value(user.getName());
jsonWriter.name("Age").value(user.getAge());
jsonWriter.name("Sex").value(user.isSex());
//流式序列化結束
jsonWriter.endObject();
}
@Override
public User read(JsonReader jsonReader) throws IOException {
User user = new User();
//流式反序列化開始
jsonReader.beginObject();
while (jsonReader.hasNext()) {
switch (jsonReader.nextName()) {
//首字母大小寫均合法
case "name":
case "Name":
user.setName(jsonReader.nextString());
break;
case "age":
user.setAge(jsonReader.nextInt());
break;
case "sex":
user.setSex(jsonReader.nextBoolean());
break;
}
}
//流式反序列化結束
jsonReader.endObject();
return user;
}
}
public static void main(String[] args) {
Gson gson = new GsonBuilder().registerTypeAdapter(User.class, new UserTypeAdapter()).create();
User user = new User("leavesC", 24, true);
System.out.println();
System.out.println(gson.toJson(user));
String json = "{\"Name\":\"leavesC\",\"age\":24,\"sex\":true}";
user = gson.fromJson(json, User.class);
System.out.println();
System.out.println(user);
}
能夠看到 User 類按照預約義的策略來完成序列化和反序列化了
JsonSerializer 和 JsonDeserializer
TypeAdapter 將序列化和反序列操做都接管了過來,其實 Gson 還提供了只接管序列化過程的接口,即 JsonSerializer。看個例子
public static void main(String[] args) {
Gson gson = new GsonBuilder().registerTypeAdapter(User.class, new JsonSerializer<User>() {
@Override
public JsonElement serialize(User user, Type type, JsonSerializationContext jsonSerializationContext) {
JsonObject jsonObject = new JsonObject();
jsonObject.addProperty("NameHi", user.getName());
jsonObject.addProperty("Sex", user.isSex());
jsonObject.addProperty("Age", user.getAge());
return jsonObject;
}
}).create();
User user = new User("leavesC", 24, true);
System.out.println();
System.out.println(gson.toJson(user));
}
相對應的,JsonDeserializer 接口提供了反序列化的接口
public static void main(String[] args) {
Gson gson = new GsonBuilder().registerTypeAdapter(User.class, new JsonDeserializer<User>() {
@Override
public User deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException {
JsonObject jsonObject = jsonElement.getAsJsonObject();
String name = null;
//同時支持 userName 和 name 兩種狀況
if (jsonObject.has("userName")) {
name = jsonObject.get("userName").getAsString();
} else if (jsonObject.has("name")) {
name = jsonObject.get("name").getAsString();
}
int age = jsonObject.get("age").getAsInt();
boolean sex = jsonObject.get("sex").getAsBoolean();
return new User(name, age, sex);
}
}).create();
String json = "{\"userName\":\"leavesC\",\"sex\":true,\"age\":24}";
User user = gson.fromJson(json, User.class);
System.out.println();
System.out.println(user);
json = "{\"name\":\"leavesC\",\"sex\":true,\"age\":24}";
user = gson.fromJson(json, User.class);
System.out.println();
System.out.println(user);
}
這裏有個比較麻煩的地方,那就是在使用 TypeAdapter 、JsonSerializer 和 JsonDeserializer 時,總須要調用 registerTypeAdapter 方法進行註冊,那有沒有更簡單的註冊方法呢?
有的,Gosn 還提供了另外一個註解 @JsonAdapter 用於進行簡單的聲明。相似於這樣,聲明瞭 User 類的序列化或反序列化操做由 UserTypeAdapter 完成,註解的優先級高於 registerTypeAdapter 方法
@JsonAdapter(UserTypeAdapter.class)
public class User {
}
TypeAdapterFactory
TypeAdapterFactory 是用於建立 TypeAdapter 的工廠類,經過參數 TypeToken 來查找肯定對應的 TypeAdapter,若是沒有就返回 null 並由 Gson 默認的處理方法來進行序列化和反序列化操做,不然就由用戶預約義的 TypeAdapter 來進行處理
Gson gson = new GsonBuilder().registerTypeAdapterFactory(new TypeAdapterFactory() {
@Override
public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> typeToken) {
//若是 Gson 須要與 User 類相關的 TypeAdapter ,則返回咱們本身定義的 TypeAdapter 對象
if (typeToken.getType().getTypeName().equals(User.class.getTypeName())) {
return (TypeAdapter<T>) new UserTypeAdapter();
}
//找不到則返回null
return null;
}
}).create();
總結
這一篇文章好像寫得太長了一點?Gson 的知識點介紹到這裏也差很少了,之後若是還發現新內容的話我會繼續補充,如今就先這樣啦。
個人簡書地址以下所示:
https://www.jianshu.com/u/9df45b87cfdf
個人github地址以下所示:
https://github.com/leavesC