Gson - 基于字段值反序列化为特定对象类型

luk*_*eli 16 java json gson deserialization

我想基于type字段值将json对象反序列化为特定类型的对象(使用Gson库),例如:

[
    {
          "type": "type1",
          "id": "131481204101",
          "url": "http://something.com",
          "name": "BLAH BLAH",
          "icon": "SOME_STRING",
          "price": "FREE",
          "backgroundUrl": "SOME_STRING"
    },
    {
        ....
    }
]
Run Code Online (Sandbox Code Playgroud)

因此,type字段将具有不同(但已知)的值.基于该值,我需要将该json对象反序列化为适当的模型对象,例如:Type1Model,Type2Model等.我知道我可以在反序列化之前通过将其转换为JSONArray迭代来解决它并轻松解析应该反序列化的类型. .但我认为这是一种丑陋的方法,我正在寻找更好的方法.有什么建议?

Dev*_*rim 32

您可以JsonDeserializer在将Json值解析为Java实例时实现并使用它.我将尝试用一个代码来展示它,它会给你一个想法:

1)定义您的自定义JsonDeserializer类,它通过传入的json值的id属性创建不同的类实例:

class MyTypeModelDeserializer implements JsonDeserializer<MyBaseTypeModel> {

    @Override
    public MyBaseTypeModel deserialize(final JsonElement json, final Type typeOfT, final JsonDeserializationContext context)
            throws JsonParseException {

        JsonObject jsonObject = json.getAsJsonObject();

        JsonElement jsonType = jsonObject.get("type");
        String type = jsonType.getAsString();

        MyBaseTypeModel typeModel = null;     

        if("type1".equals(type)) {
            typeModel = new Type1Model();
        } else if("type2".equals(type)) {
            typeModel = new Type2Model();
        }
        // TODO : set properties of type model

        return typeModel;
    }
}
Run Code Online (Sandbox Code Playgroud)

2)为不同的java对象实例定义基类:

class  MyBaseTypeModel {
    private String type;
    // TODO : add other shared fields here
}
Run Code Online (Sandbox Code Playgroud)

3)定义扩展基类的java对象类的不同实例:

class Type1Model extends MyBaseTypeModel {
    // TODO: add specific fields for this class
}

class Type2Model extends MyBaseTypeModel {
    // TODO: add specific fields for this class
}
Run Code Online (Sandbox Code Playgroud)

4)在将json值解析为bean时使用这些类:

GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.registerTypeAdapter(MyBaseTypeModel.class, new MyTypeModelDeserializer());
Gson gson = gsonBuilder.create();

MyBaseTypeModel myTypeModel = gson.fromJson(myJsonString, MyBaseTypeModel.class);
Run Code Online (Sandbox Code Playgroud)

我现在无法测试它,但我希望你能得到这个想法.同时这个环节将是非常有益的.

  • 小技巧:您可以在`MyTypeModelDeserializer'中手动设置类型模型的属性,也可以调用`context.deserialize(json,TypeNModel.class)`来使用Gson对实际模型的默认反序列化.小心:不要将`MyBaseTypeModel.class`作为一个类型传递,因为这会导致无限的反序列化循环.如果为子类注册专用类型适配器,那么它们也将被`context.deserialize`调用调用. (18认同)

tir*_*r38 7

@ stephane-k的答案有效,但是有点混乱,可以加以改进(请参阅他的答案的注释)

https://github.com/google/gson/blob/master/extras/src/main/java/com/google/gson/typeadapters/RuntimeTypeAdapterFactory.java复制到您的项目中。(没关系;这些类旨在复制/粘贴https://github.com/google/gson/issues/845#issuecomment-217231315

设置模型继承:

// abstract is optional
abstract class BaseClass {
}

class Type1Model extends BaseClass {
}

class Type2Model extends BaseClass {
}
Run Code Online (Sandbox Code Playgroud)

设置GSON或更新现有的GSON:

RuntimeTypeAdapterFactory<BaseClass> typeAdapterFactory = RuntimeTypeAdapterFactory
        .of(BaseClass.class, "type")
        .registerSubtype(Type1Model.class, "type1")
        .registerSubtype(Type2Model.class, "type2");

Gson gson = new GsonBuilder().registerTypeAdapterFactory(typeAdapterFactory)
                .create();
Run Code Online (Sandbox Code Playgroud)

将JSON反序列化为基类:

String jsonString = ...
BaseClass baseInstance = gson.fromJson(jsonString, BaseClass.class);
Run Code Online (Sandbox Code Playgroud)

baseInstance将是Type1Model或的实例Type2Model

在这里,您可以编写接口代码或检查instanceof和cast。