Сериализация EclipseLink MOXy JSON

У меня есть образец класса:

class Zoo {
    public Collection<? extends Animal> animals;
}

При сериализации с MOXy я получаю:

{
    "bird": [
        {
            "name": "bird-1",
            "wingSpan": "6 feets",
            "preferredFood": "food-1"
        }
    ],
    "cat": [
        {
            "name": "cat-1",
            "favoriteToy": "toy-1"
        }
    ],
    "dog": [
        {
            "name": "dog-1",
            "breed": "bread-1",
            "leashColor": "black"
        }
    ]
}

Почему он использует индикаторы массива "[]", в то время как птицы, кот и собака не являются массивами? Во-вторых, есть ли способ избавиться от "птицы", "кошки" и "собаки"?

Другими словами, я пытаюсь добраться до:

{
        {
            "name": "bird-1",
            "wingSpan": "6 feets",
            "preferredFood": "food-1"
        }
    ,
        {
            "name": "cat-1",
            "favoriteToy": "toy-1"
        }
    ,
        {
            "name": "dog-1",
            "breed": "bread-1",
            "leashColor": "black"
        }
}

Спасибо, Behzad

Ответ 1

ВОПРОС № 1

Почему это использует индикаторы массива "[]", в то время как птица, кошка и собака а не массивы?

Чтобы получить это представление JSON, вы сопоставили свою модель с аннотацией @XmlElementRef, которая сообщает JAXB использовать значение аннотации @XmlRootElement в качестве индикатора наследования. С привязкой MOXy JSON они становятся ключами. Мы делаем значение этих ключей массивами JSON, так как клавиши не могут повторяться.

Зоопарк

В вашей модели у вас есть аннотация @XmlElementRef в вашем поле/свойство animals.

import java.util.Collection;
import javax.xml.bind.annotation.XmlElementRef;

class Zoo {
    @XmlElementRef
    public Collection<? extends Animal> animals;
}

Animal

import javax.xml.bind.annotation.*;

@XmlAccessorType(XmlAccessType.FIELD)
@XmlSeeAlso({Bird.class, Cat.class, Dog.class})
public abstract class Animal {

    private String name;

}

Птица

В каждом из ваших подклассов есть аннотация @XmlRootElement.

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class Bird extends Animal {

    private String wingSpan;
    private String preferredFood;

}

input.json/выход

{
   "bird" : [ {
      "name" : "bird-1",
      "wingSpan" : "6 feets",
      "preferredFood" : "food-1"
   } ],
   "cat" : [ {
      "name" : "cat-1",
      "favoriteToy" : "toy-1"
   } ],
   "dog" : [ {
      "name" : "dog-1",
      "breed" : "bread-1",
      "leashColor" : "black"
   } ]
}

Дополнительная информация


ВОПРОС# 2

Во-вторых, есть ли способ избавиться от "птицы", "кошки" и "собаки"?

Вам понадобится какой-то индикатор наследования для представления различных подклассов.

ВАРИАНТ # 1 - @XmlDescriminatorNode/@XmlDescriminatorValue

Здесь я делаю это с помощью MOXy @XmlDescriminatorNode/@XmlDescriminatorValue аннотаций.

Зоопарк

import java.util.Collection;

class Zoo {
    public Collection<? extends Animal> animals;
}

Animal

import javax.xml.bind.annotation.*;
import org.eclipse.persistence.oxm.annotations.XmlDiscriminatorNode;

@XmlAccessorType(XmlAccessType.FIELD)
@XmlSeeAlso({Bird.class, Cat.class, Dog.class})
@XmlDiscriminatorNode("@type")
public abstract class Animal {

    private String name;

}

Птица

import org.eclipse.persistence.oxm.annotations.XmlDiscriminatorValue;

@XmlDiscriminatorValue("bird")
public class Bird extends Animal {

    private String wingSpan;
    private String preferredFood;

}

input.json/выход

{
   "animals" : [ {
      "type" : "bird",
      "name" : "bird-1",
      "wingSpan" : "6 feets",
      "preferredFood" : "food-1"
   }, {
      "type" : "cat",
      "name" : "cat-1",
      "favoriteToy" : "toy-1"
   }, {
      "type" : "dog",
      "name" : "dog-1",
      "breed" : "bread-1",
      "leashColor" : "black"
   } ]
}

Дополнительная информация

ВАРИАНТ # 2 - @XmlClassExtractor

ClassExtractor (AnimalExtractor)

Вы можете написать код, который определит соответствующий подкласс на основе содержимого JSON.

import org.eclipse.persistence.descriptors.ClassExtractor;
import org.eclipse.persistence.sessions.*;

public class AnimalExtractor extends ClassExtractor {

    @Override
    public Class extractClassFromRow(Record record, Session session) {
        if(null != record.get("@wingSpan") || null != record.get("@preferredFood")) {
            return Bird.class;
        } else if(null != record.get("@favoriteToy")) {
            return Cat.class;
        } else {
            return Dog.class;
        }
    }

}

Animal

Аннотация @XmlClassExtractor используется для указания ClassExtractor.

import javax.xml.bind.annotation.*;
import org.eclipse.persistence.oxm.annotations.XmlClassExtractor;

@XmlAccessorType(XmlAccessType.FIELD)
@XmlSeeAlso({Bird.class, Cat.class, Dog.class})
@XmlClassExtractor(AnimalExtractor.class)
public abstract class Animal {

    private String name;

}

Птица

Из-за того, как MOXy обрабатывает аннотации @XmlElement и @XmlAttribute, любой из данных, которые вы хотите сделать доступными для ClassExtractor, должен быть аннотирован с помощью @XmlAttribute.

import javax.xml.bind.annotation.XmlAttribute;

public class Bird extends Animal {

    @XmlAttribute
    private String wingSpan;

    @XmlAttribute
    private String preferredFood;

}

input.json/выход

{
   "animals" : [ {
      "wingSpan" : "6 feets",
      "preferredFood" : "food-1",
      "name" : "bird-1"
   }, {
      "favoriteToy" : "toy-1",
      "name" : "cat-1"
   }, {
      "breed" : "bread-1",
      "leashColor" : "black",
      "name" : "dog-1"
   } ]
}

Дополнительная информация


DEMO CODE

Следующий демо-код может использоваться с обоими описанными выше отображениями.

import java.util.*;
import javax.xml.bind.*;
import javax.xml.transform.stream.StreamSource;
import org.eclipse.persistence.jaxb.JAXBContextProperties;

public class Demo {

    public static void main(String[] args) throws Exception {
        Map<String, Object> properties = new HashMap<String, Object>();
        properties.put(JAXBContextProperties.MEDIA_TYPE, "application/json");
        properties.put(JAXBContextProperties.JSON_INCLUDE_ROOT, false);
        JAXBContext jc = JAXBContext.newInstance(new Class[] {Zoo.class}, properties);

        Unmarshaller unmarshaller = jc.createUnmarshaller();
        StreamSource json = new StreamSource("src/forum14210676/input.json");
        Zoo zoo = unmarshaller.unmarshal(json, Zoo.class).getValue();

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(zoo, System.out);
    }

}