Gson-excluded-serialization

提供:Dev Guides
移動先:案内検索

Gson-シリアル化からフィールドを除外する

デフォルトでは、GSONは、シリアル化/逆シリアル化プロセスから一時フィールドと静的フィールドを除外します。 次の例を見てみましょう。

C:\> GSON_WORKSPACEに GsonTester という名前のJavaクラスファイルを作成します。

*_File-GsonTester.java_*
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class GsonTester {
   public static void main(String args[]) {

      GsonBuilder builder = new GsonBuilder();
      Gson gson = builder.create();

      Student student = new Student();
      student.setRollNo(1);
      student.setName("Mahesh Kumar");
      student.setVerified(true);
      student.setId(1);
      student.className = "VI";

      String jsonString = gson.toJson(student);
      System.out.println(jsonString);
   }
}

class Student {
   private int rollNo;
   private String name;
   private boolean verified;
   private transient int id;
   public static String className;

   public int getRollNo() {
      return rollNo;
   }

   public void setRollNo(int rollNo) {
      this.rollNo = rollNo;
   }

   public String getName() {
      return name;
   }

   public void setName(String name) {
      this.name = name;
   }

   public void setVerified(boolean verified) {
      this.verified = verified;
   }

   public boolean isVerified() {
      return verified;
   }

   public int getId() {
      return id;
   }

   public void setId(int id) {
      this.id = id;
   }
}

結果を検証する

次のように javac コンパイラを使用してクラスをコンパイルします-

C:\GSON_WORKSPACE>javac GsonTester.java

今すぐ GsonTester を実行して結果を確認します-

C:\GSON_WORKSPACE>java GsonTester

出力を確認する

{"rollNo":1,"name":"Mahesh Kumar","verified":true}

excludeFieldsWithModifiersの使用

GsonBuilderは、シリアル化/逆シリアル化プロセスからexcludeFieldsWithModifiers()メソッドを使用して、特定の修飾子を持つフィールドを除外する制御を提供します。 次の例を見てください。

C:\> GSON_WORKSPACEにGsonTesterという名前のJavaクラスファイルを作成します。

*_File-GsonTester.java_*
import java.lang.reflect.Modifier;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class GsonTester {
   public static void main(String args[]) {

      GsonBuilder builder = new GsonBuilder();
      builder.excludeFieldsWithModifiers(Modifier.TRANSIENT);
      Gson gson = builder.create();

      Student student = new Student();
      student.setRollNo(1);
      student.setName("Mahesh Kumar");
      student.setVerified(true);
      student.setId(1);
      student.className = "VI";

      String jsonString = gson.toJson(student);
      System.out.println(jsonString);
   }
}

class Student {
   private int rollNo;
   private String name;
   private boolean verified;
   private transient int id;
   public static String className;

   public int getRollNo() {
      return rollNo;
   }

   public void setRollNo(int rollNo) {
      this.rollNo = rollNo;
   }

   public String getName() {
      return name;
   }

   public void setName(String name) {
      this.name = name;
   }

   public void setVerified(boolean verified) {
      this.verified = verified;
   }

   public boolean isVerified() {
      return verified;
   }

   public int getId() {
      return id;
   }

   public void setId(int id) {
      this.id = id;
   }
}

結果を検証する

次のように javac コンパイラを使用してクラスをコンパイルします-

C:\GSON_WORKSPACE>javac GsonTester.java

今すぐ GsonTester を実行して結果を確認します-

C:\GSON_WORKSPACE>java GsonTester

出力を確認する

{"rollNo":1,"name":"Mahesh Kumar","verified":true,"className":"VI"}

@Exposeアノテーションの使用

Gsonは @ Expose 注釈を提供して、スコープに基づいてクラスのJsonシリアル化/逆シリアル化を制御します。 @ Expose をサポートする変数を持つ次のクラスを検討してください。 このクラスでは、 name および rollno 変数がシリアル化のために公開されます。 次に、* GsonBuilder.excludeFieldsWithoutExposeAnnotation()*メソッドを使用して、公開された変数のみがシリアル化/逆シリアル化されることを示しました。 次の例を見てください。

C:\> GSON_WORKSPACEに GsonTester という名前のJavaクラスファイルを作成します。

*_File-GsonTester.java_*
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.annotations.Expose;

public class GsonTester {
   public static void main(String args[]) {

      GsonBuilder builder = new GsonBuilder();
      builder.excludeFieldsWithoutExposeAnnotation();
      Gson gson = builder.create();

      Student student = new Student();
      student.setRollNo(1);
      student.setName("Mahesh Kumar");
      student.setVerified(true);
      student.setId(1);
      student.className = "VI";

      String jsonString = gson.toJson(student);
      System.out.println(jsonString);
   }
}
class Student {
   @Expose
   private int rollNo;

   @Expose
   private String name;
   private boolean verified;
   private int id;
   public static String className;

   public int getRollNo() {
      return rollNo;
   }
   public void setRollNo(int rollNo) {
      this.rollNo = rollNo;
   }
   public String getName() {
      return name;
   }
   public void setName(String name) {
      this.name = name;
   }
   public void setVerified(boolean verified) {
      this.verified = verified;
   }
   public boolean isVerified() {
      return verified;
   }
   public int getId() {
      return id;
   }
   public void setId(int id) {
      this.id = id;
   }
}

結果を検証する

次のように javac コンパイラを使用してクラスをコンパイルします-

C:\GSON_WORKSPACE>javac GsonTester.java

今すぐ GsonTester を実行して結果を確認します-

C:\GSON_WORKSPACE>java GsonTester

出力を確認する

{"rollNo":1,"name":"Mahesh Kumar"}