Gson 自定义实例创建器

在这篇文章中,我们将讨论自定义反序列化的另一个组件。 在过去的几篇文章中,我们探讨了如何自定义数据的序列化和反序列化。 在这两种情况下,我们都试图减轻服务器和客户端之间数据模型的差异。

在这篇文章中,我们将研究两个模型相同的情况,但客户端具有额外的(帮助)属性或在反序列化数据时需要调用的特定构造函数。


Gson 实例创建器

默认情况下,Gson 将始终创建 Java 模型的空实例,然后通过反射设置属性。 严格来说,我们在模型中创建的构造函数根本不被使用(由 Gson 使用)。 如果您的 Java 模型充当简单的数据持有者并且不提供进一步的逻辑或功能,则此行为没有缺点。

但是,如果我们的数据模型确实具有默认或动态设置的其他属性,则您必须进行一些黑客攻击才能绕过 Gson 对反射的使用。 幸运的是,Gson 也涵盖了该用例,并允许您使用 InstanceCreators 实现一个干净的解决方案。

假设服务器发送一个相当简单的 JSON:

{
  "age": 26,
  "email": "jiyik_onmpw@163.com",
  "isDeveloper": true,
  "name": "jiyik"
}    

我们的应用程序有一个等效的 Java 模型,Gson 可以映射它而无需任何进一步的定制。 但是,客户端模型中还有一个附加属性:Context。 Context 可能是将该 Java 对象存储在数据库中所必需的。 它不会随 JSON 一起提供,映射它也没有任何意义。 它只是我们 Java 应用程序中的一个助手。

因此,我们的 Java 模型中只有一个构造函数,它需要 Context 对象:

public class UserContext {  
    private String name;
    private String email;
    private boolean isDeveloper;
    private int age;

    // 附加属性,不属于数据模型的一部分
    private Context context;

    public UserContext(Context context) {
        this.context = context;
    }
}

如果我们将上述模型与 Gson 的默认行为一起使用,则在反序列化后 context 将始终为 null。 在 Gson 进行映射之前,我们需要一种调用构造函数并设置 context 的方法。 正是为了这个目的,Gson 提供了 InstanceCreators

声明自定义 InstanceCreators 的方式与自定义序列化程序非常相似。

String userSimpleJson = ...; // 来自服务器的 JSON,见上文

GsonBuilder gsonBuilder = new GsonBuilder();  
gsonBuilder.registerTypeAdapter(  
    UserContext.class, 
    new UserContextInstanceCreator(getApplicationContext())
);
Gson customGson = gsonBuilder.create();

UserContext customObject = customGson.fromJson(userSimpleJson, UserContext.class);  

我们正在使用一个自定义 Gson 实例并调用 registerTypeAdapter() 来添加一个新的实例创建器。 该方法需要两个参数。 首先,我们要调整的数据模型的类型。 其次,实例创建者的实现。

在我们的例子中,它是 UserContextInstanceCreator 类:

private class UserContextInstanceCreator implements InstanceCreator<UserContext> {  
    private Context context;

    public UserContextInstanceCreator(Context context) {
        this.context = context;
    }

    @Override
    public UserContext createInstance(Type type) {
        // create new object with our additional property
        UserContext userContext = new UserContext(context);

        // return it to gson for further usage
        return userContext;
    }
}

该类必须实现类型化的 InstanceCreator 接口并覆盖 createInstance(Type type) 方法。 UserContextInstanceCreator 的构造函数可以由我们自己定义。在这种情况下,我们希望将 Context 传递给每个模型,因此我们将其传递给 InstanceCreator 并将其存储在一个字段中。每当 Gson 创建 UserContext 模型的新实例时,实例创建者将调用 UserContext(context) 构造函数。

因此,UserContext 类的所有后续实例都将 Context 设置为我们传递给实例创建者的值。在常规 Java-JSON 映射期间,Gson 仍会使用反射来设置属性。

当然,大家可以在这里做很多其他的事情。除了 Context 之外,我们可能还需要传递许多其他附加参数。或者我们的构造函数做了一些初始化工作,需要执行。通过声明一个 InstanceCreator ,我们可以确保 Gson 实际上正在调用构造函数。如果大家有其他示例,请在评论中告诉我们!


总结

在这篇文章中,我们了解了自定义 InstanceCreators 是什么以及它们的用途。 设置非常简单,我们可以摆脱一些黑客攻击,使其与 Gson 的默认行为一起工作。 确保我们知道如何使用 InstanceCreators ,因为我们最终会需要它们。

免责声明:
1.本站所有内容由本站原创、网络转载、消息撰写、网友投稿等几部分组成。
2.本站原创文字内容若未经特别声明,则遵循协议CC3.0共享协议,转载请务必注明原文链接。
3.本站部分来源于网络转载的文章信息是出于传递更多信息之目的,不意味着赞同其观点。
4.本站所有源码与软件均为原作者提供,仅供学习和研究使用。
5.如您对本网站的相关版权有任何异议,或者认为侵犯了您的合法权益,请及时通知我们处理。
火焰兔 » Gson 自定义实例创建器