EasyGSON: The filtering and exclusion strategy explanation of JSON data in the Java class library
EasyGSON: The filtering and exclusion strategy explanation of JSON data in the Java class library
Overview:
In Java development, processing JSON data is a very common task.EasyGson is a convenient and easy -to -use Java class library that is used to convert Java objects to JSON format or converts JSON data into Java objects.When performing JSON data conversion, sometimes the data is required to filter or exclude certain fields to meet specific needs.This article will introduce the JSON data filtering and exclusion strategies in Easygson, and how to use the Java code example to achieve it.
Filter field:
EasyGson provides a simple and flexible method to filter specific fields so that it does not appear in JSON data.You can control the display or hiding of the field by using annotations in the Java object.The following is an example:
class Person {
@Expose
private String name;
@Expose
private int age;
private String address;
// omit the creation function and getter/setter method
}
In the above examples, both the Name and Age fields use @Expose annotations, which means that they will be included in JSON data.The address field does not use @Expose annotations, so it will be excluded from JSON data.
When using EasyGson to convert the Person object to JSON data, it will only include name and Age fields:
Person person = new Person("Alice", 25, "New York");
Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
String json = gson.toJson(person);
System.out.println(json);
Output results:
json
{"name":"Alice","age":25}
It can be seen that the address field is successfully excluded.
Eliminate strategy:
In addition to the above annotations, EasyGSON also supports more advanced filtering needs by registering a strategy.The following is an example:
class Person {
private String name;
private int age;
private String address;
// omit the creation function and getter/setter method
}
class PersonExclusionStrategy implements ExclusionStrategy {
@Override
public boolean shouldSkipField(FieldAttributes field) {
return field.getDeclaringClass() == Person.class && field.getName().equals("address");
}
@Override
public boolean shouldSkipClass(Class<?> clazz) {
return false;
}
}
In the above example, we created a PersoneXClusionStrategy class to implement the ExclusionStrategy interface. The interface defines two methods: ShouldSkipfield and ShouldSkipClass.The ShouldSkipfield method determines which fields should be skipped, and the ShouldskipClass method determines which classes should be skipped.
In order to use PersonexclusionStrategy, we need to register this strategy in GsonBuilder and create a GSON object, as shown below:
Person person = new Person("Alice", 25, "New York");
Gson gson = new GsonBuilder().setExclusionStrategies(new PersonExclusionStrategy()).create();
String json = gson.toJson(person);
System.out.println(json);
Output results:
json
{"name":"Alice","age":25}
Here, we created a GSON object and registered the PersonexclusionStrategy strategy.When the Person object is JSON data, the Address field is excluded.
Summarize:
By using the annotation or exclusion strategy provided by EasyGSON, you can easily realize the filtering and exclusion function of JSON data.The annotation method is simple and intuitive, suitable for simple scenarios; and eliminating strategies are more flexible and can meet more complicated needs.According to specific business needs, developers can choose the appropriate way to use EasyGSON for processing JSON data.
