Gson教程十(译):Exclusion Strategies

该文章翻译自Gson Tutorial Series系列教程。该篇主要阐述如何自定义Gson的排除策略(Exclusion Strategies)。

在之前发表的博客中,你已经学习了一些关于控制某些属性是否会被序列化和反序列化的技术。到目前为止,这还处于属性层级。你可以在同一时间改变序列化和反序列化的某一要素。在本篇博客,我们将探讨一种如何设置更多普遍规则的方式来空值属性的转换。

transient@Expose更牛逼的排除策略

你已经学习了transient以及@Expose了,它们可以改变序列化和反序列化过程中的单个属性。下面我们将探讨更加普遍的方法。Gson称它为ExclusionStrategies。当然,你需要通过GsonBuilder设置它。

在我们开始特定的实现之前,先创建一个测试模型。我们使用一个新的UserDate模型,它拥有一些属性:

public class UserDate {  
    private String _name;
    private String email;
    private boolean isDeveloper;
    private int age;
    private Date registerDate = new Date();
}

请注意属性的类型和名称。这将是非常重要的。假设我们需要排除所有类型为Date以及boolean的属性,使用ExclusionStrategies很容易做到。你可以通过GsonBuilder实现:

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.setExclusionStrategies(new ExclusionStrategy() {  
    @Override
    public boolean shouldSkipField(FieldAttributes f) {
        return false;
    }

    @Override
    public boolean shouldSkipClass(Class<?> incomingClass) {
        return incomingClass == Date.class || incomingClass == boolean.class;
    }
});
Gson gson = gsonBuilder.create();

UserDate user = new UserDate("Norman", "norman@futurestud.io", 26, true);  
String usersJson = gson.toJson(user); 

ExclusionStrategies类提供了两个重写方法。上面的例子我们使用了第二个方法。我们检查该类是否是Date或者boolean之一。如果该属性是其中之一的类型,那么该方法就会返回true,Gson将会忽略该属性。你可以在该方法中检查任意类。JSON结果将只包含字符串型和整型:

{
  "age": 26,
  "email": "norman@futurestud.io",
  "_name": "Norman"
}

另一个方法的排除功能基于属性的声明。例如,如果我们还想排除所有包含下划线_的属性,那么可以按如下代码:

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.setExclusionStrategies(new ExclusionStrategy() {  
    @Override
    public boolean shouldSkipField(FieldAttributes f) {
        return f.getName().contains("_");
    }

    @Override
    public boolean shouldSkipClass(Class<?> incomingClass) {
        return incomingClass == Date.class || incomingClass == boolean.class;
    }
});
Gson gson = gsonBuilder.create();

UserDate user = new UserDate("Norman", "norman@futurestud.io", 26, true);  
String usersJson = gson.toJson(user);  

JSON结果更短了:

{
  "age": 26,
  "email": "norman@futurestud.io"
}

你可以在各种各样不同的场景中运用排除策略。如果你拥有一些具有特殊序列化和反序列化排除的普遍的机制,这将会非常容易。请注意,你可以传递多钟排除策略到一个参数中。

如果你此刻还看不出来排除策略的重要之处,那也没关系!伴随着更加复杂的类型,我们的内容将会更加深入。一旦我们开始书写我们的自定义适配器,那么你将会看到确定值。非常幸运,通过排除策略你可以使Gson忽略任何类型

排除策略仅作用于序列化或者反序列化

在之前的篇幅中,我们为序列化和反序列化都申请了排除策略。如果你仅仅需要应用于二者之一,你可以使用下面的方法:

  • addSerializationExclusionStrategy()
  • addDeserializationExclusionStrategy().

这二者的效果和之前的setExclusionStrategies()是相同的。你同样可以传递和实现ExclusionStrategy对象给它们。

基于修饰词排除成员变量

正如我们之前解释的,所有使用transient修饰的成员变量在序列化和反序列化过程中都会被忽略。

GsonBuilder允许你改变这一行为。使用excludeFieldsWithModifiers()可以选择在序列化和反序列化过程中排除哪些被特定修饰词修饰的成员变量。该方法需要传递java.lang.reflect.Modifier类中的修饰词。

例如,你有下面的模型:

public class UserModifier {  
    private String name;
    private transient String email;
    private static boolean isDeveloper;
    private final int age;
}

如果你想排除所有finalstatic类型,但包括field,你需要按如下代码配置Gson:

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.excludeFieldsWithModifiers(Modifier.STATIC, Modifier.FINAL);  
Gson gson = gsonBuilder.create();

UserModifier user = new UserModifier("Norman", "norman@fs.io", 26, true);  
String usersJson = gson.toJson(user);

上面的代码将会创建如下JSON:

{
  "email": "norman@fs.io",
  "name": "Norman"
}

注意,Gson实例也会包含email域的,即使它被设置为transient。调用excludeFieldsWithModifiers()方法重写它的默认设置。我们仅仅传递了staticfinal,因此transient修饰词将不会被忽略。如果你想要包含所有域而不管修饰词,仅需要传递空列表参数给excludeFieldsWithModifiers()

排除没有被@Expose注解的域

最后,有一个选择我们没有多大兴趣,但会提示你所有的选项:excludeFieldsWithoutExposeAnnotation。正如它的名字所暗示的,它将会排除所有没有被@Expose注解的成员变量。

你可以强制你的应用程序模型必须每处都用@Expose注解了,这样可以使得开发者思考哪些域需要序列化和反序列化。

前瞻

在这篇博客,你已经学会了在更普遍的层面上排除属性。ExclusionStrategies提供了两种排除属性的选择。你可以通过类类型和属性名进行过滤。还有更多专业的排除策略。

在下一篇博客,我们将会探究如果JSON的结构没有遵循标准,Gson将会有多灵活。

推荐阅读更多精彩内容