GSON序列化存储在不同对象中的类型的多态对象

时间:2017-02-17 23:41:16

标签: java json serialization polymorphism gson

首先,我查看了其他一些answers for similar questions,但他们没有回答我的具体情况。

我正在解析包含正文和标题的JSON消息,其中标题存储正文的对象类型:

{
    "body": {
        "eventName": "someEventName"
    },
    "header": {
        "purpose": "event"
    }
}

在Java中,我使用以下类对此结构进行了建模:

public class Message {
    public Body body;
    public Header header;
}

public class Header {
    public String purpose; // Marks what child class the body of the message uses
}

public abstract class Body {
    // Child classes store additional fields
}

// Example implementation of the body class
public class EventBody extends Body {
    public String eventName; // Name of some event
}

在做了一些研究之后,我发现RuntimeTypeAdapterFactory通常用于解析/写入多态对象;但是,RutimeTypeAdapterFactory类依赖于存储在多态对象的基类中的类型(即Body)。但在这种情况下,情况并非如此 - 类型存储在另一个对象Header中。

解析这些对象的最佳方法是什么?我希望避免为紧凑性编写自定义Serializer / Deserializer,但如果有必要,我不介意编写它们。

1 个答案:

答案 0 :(得分:2)

我意识到要求一个不涉及自定义Serializer / Deserializer的解决方案有点荒谬,因为这正是他们将要使用的场景类型(我是我想我可以使用自定义TypeAdapterFactory,但使用Serializer / Deserializer更容易。)

无论如何,对于我的场景,Message类的自定义Serializer / Deserializer的组合似乎工作正常。由于我已经使用枚举来跟踪不同的消息目的及其字符串名称,因此我决定在该枚举中添加一个额外的字段来存储相应的正文类。

MessagePurpose枚举:

public enum MessagePurpose {
    EVENT("event", EventBody.class);

    public final String purposeName;
    public final Class bodyClass;

    MessagePurpose(String purposeName, Class classi) {
        this.purposeName = purposeName;
        bodyClass = classi;
    }
}

MessageSerializer:

public class MessageSerializer implements JsonSerializer<Message> {
    @Override
    public JsonElement serialize(Message message, Type type, JsonSerializationContext jsc) {
        if(message == null) {
            return null;
        }

        JsonObject messageObj = new JsonObject();

        // Get the class representing the body object from the purpose enum
        Class bodyClassType = message.getPurpose().bodyClass;
        messageObj.add("body", jsc.serialize(message.getBody(), bodyClassType));

        messageObj.add("header", jsc.serialize(message.getHeader(), Header.class));

        return messageObj;
    }
}

MessageDeserializer:

public class MessageDeserializer implements JsonDeserializer<Message> {
    @Override
    public Message deserialize(JsonElement je, Type type, JsonDeserializationContext jdc) throws JsonParseException {
        Header header = jdc.deserialize(je.getAsJsonObject().get("header"), Header.class);

        // Get the class representing the body object from the purpose enum
        Class bodyClassType = header.getPurpose().bodyClass;
        Body body = jdc.deserialize(je.getAsJsonObject().get("body"), bodyClassType);

        return new Message(body, header);
    }
}

测试的主要功能:

public static void main(String[] args) {
    GsonBuilder gb = new GsonBuilder();

    // Register the Message class since I need to access info in the header
    gb.registerTypeAdapter(Message.class, new MessageDeserializer());
    gb.registerTypeAdapter(Message.class, new MessageSerializer());

    Gson gson = gb.setPrettyPrinting().create();

    EventBody event = new EventBody(EventType.SOME_EVENT_NAME);

    String eventJson = gson.toJson(event.getAsMessage());
    System.out.println(eventJson);

    Message newEvent = gson.fromJson(eventJson);
    System.out.println("\nEvent type: " + ((EventBody) newEvent.getBody()).getEventName());
}

上面的测试类打印:

{
  "body": {
    "eventType": "someEventName"
  },
  "header": {
    "purpose": "event"
  }
}

Event Type: someEventName

此输出与我正在解析的Messages的JSON匹配,它似乎可以很好地反序列化不同类型的消息。