Java（Gson）の@Exposeアノテーションを使ってJSONから特定のフィールドを除外する方法

Gsonライブラリが提供する@Exposeアノテーションを使用すると、シリアライズ（直列化）やデシリアライズ（逆直列化）の対象にフィールドを含めるか除外するかを細かく制御できます。このアノテーションはserializeとdeserializeという2つのboolean型パラメータを受け取ることができ、それぞれにtrueまたはfalseを指定します。

@ExposeアノテーションをGsonに反映させるには、通常のnew Gson()ではなく、GsonBuilderクラスを使ってGsonインスタンスを作成し、excludeFieldsWithoutExposeAnnotation()メソッドを呼び出す必要があります。このメソッドを呼び出すことで、@Exposeアノテーションが付与されていないすべてのフィールドが、シリアライズ・デシリアライズの対象から自動的に除外されるようになります。

構文

public GsonBuilder excludeFieldsWithoutExposeAnnotation()

コード例

以下の例では、Employeeクラスのnameとageフィールドには@Expose(serialize = true, deserialize = true)を付与し、salaryフィールドには@Expose(serialize = false, deserialize = false)を付与しています。その結果、excludeFieldsWithoutExposeAnnotation()を有効にしたGsonでは、salaryフィールドだけがJSON出力から除外されます。

import com.google.gson.*;
import com.google.gson.annotations.*;

public class JsonExcludeAnnotationTest {
   public static void main(String args[]) {
      Employee emp = new Employee("Raja", 28, 40000.00);

      // 通常のGsonインスタンス（@Exposeを無視）
      Gson gson = new GsonBuilder().setPrettyPrinting().create();
      String jsonStr = gson.toJson(emp);
      System.out.println(jsonStr);

      // @Exposeアノテーションを有効化したGsonインスタンス
      gson = new GsonBuilder().setPrettyPrinting()
             .excludeFieldsWithoutExposeAnnotation().create();
      jsonStr = gson.toJson(emp);
      System.out.println(jsonStr);
   }
}

// Employeeクラス
class Employee {
   @Expose(serialize = true, deserialize = true)
   public String name;

   @Expose(serialize = true, deserialize = true)
   public int age;

   @Expose(serialize = false, deserialize = false)
   public double salary;

   public Employee(String name, int age, double salary) {
      this.name = name;
      this.age = age;
      this.salary = salary;
   }
}

実行結果

1つ目の出力は通常のGsonによるもので、@Exposeアノテーションの設定に関わらずすべてのフィールドが出力されます。2つ目の出力はexcludeFieldsWithoutExposeAnnotation()を有効にした場合で、serialize = falseが指定されたsalaryフィールドが除外されていることが確認できます。

{
  "name": "Raja",
  "age": 28,
  "salary": 40000.0
}
{
  "name": "Raja",
  "age": 28
}

このように、@ExposeアノテーションとGsonBuilderの組み合わせを活用すれば、パスワードや給与などの機密性の高いデータをJSONに含めずに安全にオブジェクトを変換できます。