Gson - 排除序列化欄位

---

---

預設情況下，GSON 會從序列化/反序列化過程中排除 transient 和 static 欄位。讓我們來看下面的例子。

示例

在 C:\>GSON_WORKSPACE 中建立一個名為 GsonTester 的 Java 類檔案。

檔案 − 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 類檔案。

檔案 − 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 類檔案。

檔案 − 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"}