迹忆客 专注技术分享

当前位置:主页 > 学无止境 > 编程语言 >

Gson Builder - 排除策略

作者:迹忆客 最近更新:2022/06/18 浏览次数:

在之前的文章中,我们介绍了一些控制哪些模型属性被(反)序列化的技术。 到目前为止,这一直是在属性层面。 我们可以一次更改一个元素的(反)序列化。 在这篇文章中,我们将研究一种设置更通用规则来控制哪些属性被转换的方法。

使用排除策略超越 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();
}

请特别注意属性类型及其命名。 马上就会变得很重要。 假设我们要踢出所有属性,它们是 Dateboolean 类型。 我们可以使用 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);  

ExclusionStrategy 类有两个可以覆盖的方法。 我们在上面的例子中只使用了第二个选项。 我们检查了类是 Date 类型还是 boolean 类型。 如果该属性属于任一类型,则该函数将返回 true,而 Gson 将忽略它。 我们可以在此方法中进行任何类检查。 生成的 JSON 将仅包含 string 和 int 类型:

{
  "age": 26,
  "email": "jiyik_onmpw@163.com",
  "_name": "jiyik"
}

另一种方法提供了根据声明排除属性的选项。 例如,如果我们想要排除所有包含下划线 _ 的属性,除了上述规则,我们可以使用以下代码:

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": "jiyik_onmpw@163.com"
}

我们可以将排除策略用于许多不同的场景。 如果有一些特定(反)序列化排除的通用系统,它会变得更加容易。 请注意,我们可以将多个排除策略作为参数传递。

如果我们目前没有看到排除策略的意义,那没关系! 我们很快就会更深入地介绍更复杂的类型。 一旦我们开始编写自定义适配器,那么肯定会看到它的价值。 幸运的是,通过排除策略,我们可以将 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;
}

如果我们想排除所有最终类型和静态类型的字段,但包括 transient 字段,则需要使用 GsonBuilder 配置 Gson,如下所示:

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

UserModifier user = new UserModifier("jiyik", "jiyik_onmpw@163.com", 26, true);  
String usersJson = gson.toJson(user);  

上面的代码将创建这个 JSON:

{
  "email": "jiyik_onmpw@163.com",
  "name": "jiyik"
}

请注意 Gson 实例如何包含 email 字段,即使它是暂时的。 调用 excludeFieldsWithModifiers() 方法会覆盖默认设置。 我们只传递了 staticfinal,因此不会忽略 transient 修饰符。 如果我们希望包含所有字段,无论修饰符如何,只需将一个空列表传递给 excludeFieldsWithModifiers()


排除没有 @Expose 的字段

最后,我们不是很喜欢的一个选项,但会提到为我们提供所有选项:excludeFieldsWithoutExposeAnnotation()。 正如方法名称所表示的,这不包括所有没有 @Expose 注解的字段。

我们可以强制应用程序模型在任何地方都有 @Expose 注解,并确保开发人员考虑哪个字段被(反)序列化。

除非注明转载,本站文章均为原创或翻译,欢迎转载,转载请以链接形式注明出处

本文地址:

扫一扫阅读全部技术教程

社交账号
  • https://www.github.com/onmpw
  • qq:1244347461

热门文章

教程更新

热门标签

扫码一下
查看教程更方便