Gson - 从序列化中排除字段
默认情况下,GSON 从序列化/反序列化过程中排除瞬态和静态字段。让我们看一下下面的例子。
例子
在 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}
使用带有修饰符的排除字段
GsonBuilder 使用从序列化/反序列化过程中排除的 FieldsWithModifiers() 方法提供对排除具有特定修饰符的字段的控制。请参阅以下示例。
例子
在 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"}