該系列其它文章

注：此係列基於Gson 2.4。

本次的主要內容：

• 欄位過濾的幾種方法
  
  • 基於@Expose註解
  • 基於版本
  • 基於訪問修飾符
  • 基於策略（作者最常用）
• POJO與JSON的欄位對映規則

一、欄位過濾的幾種方法

欄位過濾Gson中比較常用的技巧，特別是在Android中，在處理業務邏輯時可能需要在設定的POJO中加入一些欄位，但顯然在序列化的過程中是不需要的，並且如果序列化還可能帶來一個問題就是 迴圈引用 ，那麼在用Gson序列化之前為不防止這樣的事件情發生，你不得不作另外的處理。

以一個商品分類Category 為例。

{
  "id": 1,
  "name
 
": "電腦",
  "children": [
    {
      "id": 100,
      "name": "筆記本"
    },
    {
      "id": 101,
      "name": "桌上型電腦"
    }
  ]
}

一個大分類，可以有很多小分類，那麼顯然我們在設計Category類時Category本身既可以是大分類，也可以是小分類。

public class Category {
    public int id;
    public String name;
    public List<Category> children;
}
 

但是為了處理業務，我們還需要在子分類中儲存父分類，最終會變成下面的情況

public class Category {
    public int id;
    public String name;
    public List<Category> children;
    //因業務需要增加，但並不需要序列化
    public Category parent; 
}

但是上面的parent欄位是因業務需要增加的，那麼在序列化是並不需要，所以在序列化時就必須將其排除，那麼在Gson中如何排除符合條件的欄位呢?下面提供4種方法，大家可根據需要自行選擇合適的方式。

1.1 基於@Expose註解

@Expose提供了兩個屬性，且都有預設值，開發者可以根據需要設定不同的值。

@Expose 註解從名字上就可以看出是暴露的意思，所以該註解是用於對外暴露欄位的。可是我們以前用Gson的時候也沒有@Expose 註解還不是照樣正確的序列化為JSON了麼?是的，所以該註解在使用new Gson() 時是不會發生作用。畢竟最常用的API要最簡單，所以該註解必須和GsonBuilder配合使用。

使用方法： 簡單說來就是需要匯出的欄位上加上@Expose 註解，不匯出的欄位不加。注意是不匯出的不加。

@Expose //
@Expose(deserialize = true,serialize = true) //序列化和反序列化都都生效
@Expose(deserialize = true,serialize = false) //反序列化時生效
@Expose(deserialize = false,serialize = true) //序列化時生效
@Expose(deserialize = false,serialize = false) // 和不寫一樣

注：根據上面的圖片可以得出，所有值為true的屬性都是可以不寫的。

拿上面的例子來說就是

public class Category {
    @Expose public int id;
    @Expose public String name;
    @Expose public List<Category> children;
    //不需要序列化,所以不加 @Expose 註解，
    //等價於 @Expose(deserialize = false,serialize = false)
    public Category parent; 
}

在使用Gson時也不能只是簡單的new Gson()了。

Gson gson = new GsonBuilder()
        .excludeFieldsWithoutExposeAnnotation()
        .create();
gson.toJson(category);

1.2 基於版本

Gson在對基於版本的欄位匯出提供了兩個註解 @Since 和 @Until,和GsonBuilder.setVersion(Double)配合使用。@Since 和 @Until都接收一個Double值。

使用方法：當前版本(GsonBuilder中設定的版本) 大於等於Since的值時該欄位匯出，小於Until的值時該該欄位匯出。

class SinceUntilSample {
    @Since(4)
    public String since;
    @Until(5)
    public String until;
}

public void sineUtilTest(double version){
        SinceUntilSample sinceUntilSample = new SinceUntilSample();
        sinceUntilSample.since = "since";
        sinceUntilSample.until = "until";
        Gson gson = new GsonBuilder().setVersion(version).create();
        System.out.println(gson.toJson(sinceUntilSample));
}
//當version <4時，結果：{"until":"until"}
//當version >=4 && version <5時，結果：{"since":"since","until":"until"}
//當version >=5時，結果：{"since":"since"}

注：當一個欄位被同時註解時，需兩者同時滿足條件。

1.3 基於訪問修飾符

什麼是修飾符? public、static 、final、private、protected 這些就是，所以這種方式也是比較特殊的。
使用方式：

class ModifierSample {
    final String finalField = "final";
    static String staticField = "static";
    public String publicField = "public";
    protected String protectedField = "protected";
    String defaultField = "default";
    private String privateField = "private";
}

使用GsonBuilder.excludeFieldsWithModifiers構建gson,支援int形的可變引數，值由java.lang.reflect.Modifier提供，下面的程式排除了privateField 、 finalField 和staticField 三個欄位。

ModifierSample modifierSample = new ModifierSample();
Gson gson = new GsonBuilder()
        .excludeFieldsWithModifiers(Modifier.FINAL, Modifier.STATIC, Modifier.PRIVATE)
        .create();
System.out.println(gson.toJson(modifierSample));

// 結果：{"publicField":"public","protectedField":"protected","defaultField":"default"}

到此為止，Gson提供的所有註解就還有一個@JsonAdapter沒有介紹了，而@JsonAdapter將和TypeAdapter將作為該系列第4篇也是最後一篇文章的主要內容。

1.4 基於策略（自定義規則）

上面介紹的了3種排除欄位的方法，說實話我除了@Expose以外，其它的都是隻在Demo用上過，用得最多的就是馬上要介紹的自定義規則，好處是功能強大、靈活，缺點是相比其它3種方法稍麻煩一點，但也僅僅只是想對其它3種稍麻煩一點而已。

基於策略是利用Gson提供的ExclusionStrategy介面，同樣需要使用GsonBuilder,相關API 2個，分別是addSerializationExclusionStrategy 和addDeserializationExclusionStrategy 分別針對序列化和反序化時。這裡以序列化為例。

例如：

Gson gson = new GsonBuilder()
        .addSerializationExclusionStrategy(new ExclusionStrategy() {
            @Override
            public boolean shouldSkipField(FieldAttributes f) {
                // 這裡作判斷，決定要不要排除該欄位,return true為排除
                if ("finalField".equals(f.getName())) return true; //按欄位名排除
                Expose expose = f.getAnnotation(Expose.class); 
                if (expose != null && expose.deserialize() == false) return true; //按註解排除
                return false;
            }
            @Override
            public boolean shouldSkipClass(Class<?> clazz) {
                // 直接排除某個類 ，return true為排除
                return (clazz == int.class || clazz == Integer.class);
            }
        })
        .create();

有沒有很強大?

二、 POJO與JSON的欄位對映規則

之前在你真的會用Gson嗎?Gson使用指南（二） 屬性重新命名時 介紹了@SerializedName這個註解的使用，本節的內容與上一次差不多的，但既然叫對映規則那麼說的自然是有規律的情況。
還是之前User的例子，已經去除所有註解：

User user = new User("怪盜kidou", 24);
user.emailAddress = "[email protected]";

GsonBuilder提供了FieldNamingStrategy介面和setFieldNamingPolicy和setFieldNamingStrategy 兩個方法。

2.1 預設實現

GsonBuilder.setFieldNamingPolicy 方法與Gson提供的另一個列舉類FieldNamingPolicy配合使用，該列舉類提供了5種實現方式分別為：

2.2 自定義實現

GsonBuilder.setFieldNamingStrategy 方法需要與Gson提供的FieldNamingStrategy介面配合使用，用於實現將POJO的欄位與JSON的欄位相對應。上面的FieldNamingPolicy實際上也實現了FieldNamingStrategy介面，也就是說FieldNamingPolicy也可以使用setFieldNamingStrategy方法。

用法：

Gson gson = new GsonBuilder()
        .setFieldNamingStrategy(new FieldNamingStrategy() {
            @Override
            public String translateName(Field f) {
                //實現自己的規則
                return null;
            }
        })
        .create();

注意： @SerializedName註解擁有最高優先順序，在加有@SerializedName註解的欄位上FieldNamingStrategy不生效！