it-swarm.com.de

Jackson deserialisiert sich nach Typ

Nehmen wir an, ich habe JSON des folgenden Formats:

{
    "type" : "Foo"
    "data" : {
        "object" : {
            "id" : "1"
            "fizz" : "bizz"
            ...
        },
        "metadata" : {
            ...
        },
        "owner" : {
            "name" : "John"
            ...
        }
    }
}

Ich versuche, benutzerdefinierte Deserializer zu vermeiden und die obige JSON (Wrapper.Java) in Java-POJOs zu deserialisieren. Das Feld "Typ" bestimmt die Deserialisierung "Objekt", d. type = foo bedeutet die Deserialisierung des Feldes "object" mit der Foo.Java. (Wenn Typ = Bar, verwenden Sie Bar.Java, um das Objektfeld zu deserialisieren.) Metadaten/Besitzer werden immer auf dieselbe Weise deserialisiert, wobei jeweils eine einfache Java-Klasse mit Kommentaren von Jackson verwendet wird. Gibt es eine Möglichkeit, dies mithilfe von Anmerkungen zu erreichen? Wenn nicht, wie kann dies mit einem benutzerdefinierten Deserializer durchgeführt werden?

7
John Baum

Nur Annotationen

Alternativ zum benutzerdefinierten Deserializer-Ansatz können Sie Folgendes für eine Nur-Annotations-Lösung haben (ähnlich der in Spunks Antwort beschriebenen, aber type als externe Eigenschaft ):

public abstract class AbstractData {

    private Owner owner;

    private Metadata metadata;

    // Getters and setters
}
public static final class FooData extends AbstractData {

    private Foo object;

    // Getters and setters
}
public static final class BarData extends AbstractData {

    private Bar object;

    // Getters and setters
}
public class Wrapper {

    private String type;

    @JsonTypeInfo(use = Id.NAME, property = "type", include = As.EXTERNAL_PROPERTY)
    @JsonSubTypes(value = { 
            @JsonSubTypes.Type(value = FooData.class, name = "Foo"),
            @JsonSubTypes.Type(value = BarData.class, name = "Bar") 
    })
    private AbstractData data;

    // Getters and setters
}

Bei diesem Ansatz wird @JsonTypeInfo festgelegt, um type als external-Eigenschaft zu verwenden , um die richtige Klasse für die Zuordnung der data-Eigenschaft zu bestimmen.

Das JSON-Dokument kann wie folgt deserialisiert werden:

ObjectMapper mapper = new ObjectMapper();
Wrapper wrapper = mapper.readValue(json, Wrapper.class);  
10
cassiomolin

Benutzerdefinierter Deserializer-Ansatz

Sie können einen benutzerdefinierten Deserializer verwenden, der die type-Eigenschaft überprüft, um die object-Eigenschaft in die am besten geeignete Klasse zu parsen.

Definieren Sie zunächst eine Schnittstelle, die von Foo und Bar Klassen implementiert wird:

public interface Model {

}
public class Foo implements Model {

    // Fields, getters and setters
}
public class Bar implements Model {

    // Fields, getters and setters
}

Definieren Sie dann Ihre Wrapper- und Data-Klassen:

public class Wrapper {

    private String type;

    private Data data;

    // Getters and setters
}
public class Data {

    @JsonDeserialize(using = ModelDeserializer.class)
    private Model object;

    private Metadata metadata;

    private Owner owner;

    // Getters and setters
}

Das Feld object ist mit @JsonDeserialize versehen und gibt den Deserializer an, der für die Eigenschaft object verwendet wird.

Der Deserialisierer ist wie folgt definiert:

public class ModelDeserializer extends JsonDeserializer<Model> {

    @Override
    public Model deserialize(JsonParser jp, DeserializationContext ctxt)
        throws IOException, JsonMappingException {

        // Get reference to ObjectCodec
        ObjectCodec codec = jp.getCodec();

        // Parse "object" node into Jackson's tree model
        JsonNode node = codec.readTree(jp);

        // Get value of the "type" property
        String type = ((Wrapper) jp.getParsingContext().getParent()
            .getCurrentValue()).getType();

        // Check the "type" property and map "object" to the suitable class
        switch (type) {

            case "Foo":
                return codec.treeToValue(node, Foo.class);

            case "Bar":
                return codec.treeToValue(node, Bar.class);

            default:
                throw new JsonMappingException(jp, 
                    "Invalid value for the \"type\" property");
        }
    }
}

Das JSON-Dokument kann wie folgt deserialisiert werden:

ObjectMapper mapper = new ObjectMapper();
Wrapper wrapper = mapper.readValue(json, Wrapper.class);  

Erwägen Sie alternativ zu diesem benutzerdefinierten Deserializer einen Annotations-Only-Ansatz .

7
cassiomolin

All dies kann durch Anmerkungen erfolgen.

Erstellen Sie eine abstrakte Superklasse mit den allgemeinen Feldern wie "Metadaten" und "Eigentümer" und deren Getter/Setter. Diese Klasse muss mit @JsonTypeInfo kommentiert werden. Es sollte so aussehen:

@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY, property = "type")

Mit dem Parameter property = "type" legen Sie fest, dass der Klassenbezeichner unter dem Feld Typ in Ihrem JSON-Dokument serialisiert wird.

Der Wert des Klassenbezeichners kann mit use angegeben werden. Id.CLASS verwendet den vollständig qualifizierten Java-Klassennamen. Sie können auch Id.MINIMAL_CLASS verwenden, einen abgekürzten Java-Klassennamen. Verwenden Sie Id.NAME, um eine eigene Kennung zu erhalten. In diesem Fall müssen Sie die Subtypen deklarieren:

@JsonTypeInfo(use = Id.NAME, include = As.PROPERTY, property = "type")
@JsonSubTypes({
    @JsonSubTypes.Type(value = Foo.class, name = "Foo"),
    @JsonSubTypes.Type(value = Bar.class, name = "Bar")
})

Implementieren Sie Ihre Klassen Foo und Bar, indem Sie die abstrakte Oberklasse erweitern.

Jackson's ObjectMapper verwendet das zusätzliche Feld "type" des JSON-Dokuments für die Serialisierung und Deserialisierung. Z.B. Wenn Sie eine JSON-Zeichenfolge in eine Superklassenreferenz deserialisieren, wird sie der entsprechenden Unterklasse angehören:

ObjectMapper om = new ObjectMapper();
AbstractBase x = om.readValue(json, AbstractBase.class);
// x will be instanceof Foo or Bar


Vollständiger Codebeispiel (Ich habe öffentliche Felder als Abkürzung verwendet, um keine Eingabe/Eingabe schreiben zu müssen):

package test;

import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.annotation.JsonTypeInfo.As;

import Java.io.IOException;

import com.fasterxml.jackson.annotation.JsonSubTypes;

@JsonTypeInfo(use = Id.NAME, include = As.PROPERTY, property = "type")
@JsonSubTypes({
    @JsonSubTypes.Type(value = Foo.class, name = "Foo"),
    @JsonSubTypes.Type(value = Bar.class, name = "Bar")
})
public abstract class AbstractBase {

    public MetaData metaData;
    public Owner owner;
    @Override
    public String toString() {
        return "metaData=" + metaData + "; owner=" + owner;
    }

    public static void main(String[] args) throws IOException {

        // Common fields
        Owner owner = new Owner();
        owner.name = "Richard";
        MetaData metaData = new MetaData();
        metaData.data = "Some data";

        // Foo
        Foo foo = new Foo();
        foo.owner = owner;
        foo.metaData = metaData;
        CustomObject customObject = new CustomObject();
        customObject.id = 20l;
        customObject.fizz = "Example";
        Data data = new Data();
        data.object = customObject;
        foo.data = data;
        System.out.println("Foo: " + foo);

        // Bar
        Bar bar = new Bar();
        bar.owner = owner;
        bar.metaData = metaData;
        bar.data = "A String in Bar";

        ObjectMapper om = new ObjectMapper();

        // Test Foo:
        String foojson = om.writeValueAsString(foo);
        System.out.println(foojson);
        AbstractBase fooDeserialised = om.readValue(foojson, AbstractBase.class);
        System.out.println(fooDeserialised);

        // Test Bar:
        String barjson = om.writeValueAsString(bar);
        System.out.println(barjson);
        AbstractBase barDeserialised = om.readValue(barjson, AbstractBase.class);
        System.out.println(barDeserialised);

    }

}

class Foo extends AbstractBase {
    public Data data;
    @Override
    public String toString() {
        return "Foo[" + super.toString() + "; data=" + data + ']';
    }
}

class Bar extends AbstractBase {
    public String data;
    public String toString() {
        return "Bar[" + super.toString() + "; data=" + data + ']';
    }
}


class Data {
    public CustomObject object;
    @Override
    public String toString() {
        return "Data[object=" + object + ']';
    }
}

class CustomObject {
    public long id;
    public String fizz;
    @Override
    public String toString() {
        return "CustomObject[id=" + id + "; fizz=" + fizz + ']';
    }
}

class MetaData {
    public String data;
    @Override
    public String toString() {
        return "MetaData[data=" + data + ']';
    }
}

class Owner {
    public String name;
    @Override
    public String toString() {
        return "Owner[name=" + name + ']';
    }
}
6
Spunc

Ich denke es ist ziemlich unkompliziert. Sie verfügen wahrscheinlich über eine Superklasse mit Eigenschaften für metadata und owner. Statt sie wirklich generisch zu machen, können Sie anstelle der Superklasse T verwenden. Grundsätzlich müssen Sie jedoch den Namen der Klasse anhand der tatsächlichen JSON-Zeichenfolge parsen, die in Ihrem Beispiel in etwa so aussehen würde:

int start = jsonString.indexOf("type");
int end = jsonString.indexOf("data");
Class actualClass = Class.forName(jsonString.substring(start + 4, end - 2)); // that of course, is approximate - based on how you format JSON

und der allgemeine Code könnte so aussehen:

public static <T> T deserialize(String xml, Object obj)
        throws JAXBException {

    T result = null;

    try {

        int start = jsonString.indexOf("type");
        int end = jsonString.indexOf("data");
        Class actualClass = Class.forName(jsonString.substring(start + 4, end - 2)); 

        JAXBContextFactory factory = JAXBContextFactory.getInstance();
        JAXBContext jaxbContext = factory.getJaxBContext(actualClass);

        Unmarshaller jaxbUnmarshaller = jaxbContext.createUnmarshaller();

        // this will create Java object
        try (StringReader reader = new StringReader(xml)) {
            result = (T) jaxbUnmarshaller.unmarshal(reader);
        }

    } catch (JAXBException e) {
        log.error(String
                .format("Exception while deserialising the object[JAXBException] %s\n\r%s",
                        e.getMessage()));
    }

    return result;
}
1
Renats Stozkovs