Как вывести нулевые элементы и атрибуты при выводе JSON с помощью EclipseLink MOXy

В моем XML я вывожу элемент только в том случае, если он имеет значение, но требование для JSON состоит в том, чтобы выводить значение, даже если оно не установлено

то есть XML

<alias-list>
<alias sort-name="Afghan">Afghany</alias>
</alias-list>

Я хотел бы, чтобы JSON выводил другие элементы элемента псевдонима, даже если они не установлены

i.e

   "aliases" : [ {
      sort-name : "Afghan"
      begin-date : null
      end-date : null
      value : "Afghany"
   } ]

но все, что я могу сделать, это иметь метод, который я использую при выводе json, чтобы установить эти нулевые элементы в пустую строку, это дает мне

   "aliases" : [ {
      sort-name : "Afghan"
      begin-date : ""
      end-date : ""
      value : "Afghany"
   } ]

но это не то, чего я хочу

Обновление с попыткой использовать ответ Дениса

Я столкнулся с несколькими проблемами с предлагаемым решением, во-первых, это полный класс Alias, который, я думаю, поможет (обратите внимание на классы, созданные автоматически с помощью JAXB, я столкнулся с этим до ElipseLink, и поскольку мой вывод Xml в порядке, я не особенно заинтересован изменить это)

//
// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, vhudson-jaxb-ri-2.1-792 
// See <a href="http://java.sun.com/xml/jaxb">http://java.sun.com/xml/jaxb</a> 
// Any modifications to this file will be lost upon recompilation of the source schema. 
// Generated on: 2013.06.04 at 02:00:21 PM BST 
//


package org.musicbrainz.mmd2;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.XmlValue;


/**
 * <p>Java class for anonymous complex type.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.
 * 
 * <pre>
 * &lt;complexType>
 *   &lt;complexContent>
 *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       &lt;attribute name="locale" type="{http://musicbrainz.org/ns/mmd-2.0#}def_iso-3166-2-code" />
 *       &lt;attribute name="sort-name" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
 *       &lt;attribute name="type" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
 *       &lt;attribute name="primary" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
 *       &lt;attribute name="begin-date" type="{http://musicbrainz.org/ns/mmd-2.0#}def_incomplete-date" />
 *       &lt;attribute name="end-date" type="{http://musicbrainz.org/ns/mmd-2.0#}def_incomplete-date" />
 *     &lt;/restriction>
 *   &lt;/complexContent>
 * &lt;/complexType>
 * </pre>
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
    "content"
})
@XmlRootElement(name = "alias")
public class Alias {

    @XmlValue
    protected String content;
    @XmlAttribute
    protected String locale;
    @XmlAttribute(name = "sort-name")
    @XmlSchemaType(name = "anySimpleType")
    protected String sortName;
    @XmlAttribute
    @XmlSchemaType(name = "anySimpleType")
    protected String type;
    @XmlAttribute
    @XmlSchemaType(name = "anySimpleType")
    protected String primary;
    @XmlAttribute(name = "begin-date")
    protected String beginDate;
    @XmlAttribute(name = "end-date")
    protected String endDate;

    /**
     * Gets the value of the content property.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getContent() {
        return content;
    }

    /**
     * Sets the value of the content property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     */
    public void setContent(String value) {
        this.content = value;
    }

    /**
     * Gets the value of the locale property.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getLocale() {
        return locale;
    }

    /**
     * Sets the value of the locale property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     */
    public void setLocale(String value) {
        this.locale = value;
    }

    /**
     * Gets the value of the sortName property.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getSortName() {
        return sortName;
    }

    /**
     * Sets the value of the sortName property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     */
    public void setSortName(String value) {
        this.sortName = value;
    }

    /**
     * Gets the value of the type property.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getType() {
        return type;
    }

    /**
     * Sets the value of the type property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     */
    public void setType(String value) {
        this.type = value;
    }

    /**
     * Gets the value of the primary property.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getPrimary() {
        return primary;
    }

    /**
     * Sets the value of the primary property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     */
    public void setPrimary(String value) {
        this.primary = value;
    }

    /**
     * Gets the value of the beginDate property.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getBeginDate() {
        return beginDate;
    }

    /**
     * Sets the value of the beginDate property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     */
    public void setBeginDate(String value) {
        this.beginDate = value;
    }

    /**
     * Gets the value of the endDate property.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getEndDate() {
        return endDate;
    }

    /**
     * Sets the value of the endDate property.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     */
    public void setEndDate(String value) {
        this.endDate = value;
    }

}

Когда я пробую решение для привязки json, я получаю

Exception Description: The property or field beginDate on the class org.musicbrainz.mmd2.Alias is required to be included in the propOrder element of the XmlType annotation.
 - with linked exception:
[Exception [EclipseLink-50013] (Eclipse Persistence Services - 2.5.0.v20130507-3faac2b): org.eclipse.persistence.exceptions.JAXBException
Exception Description: The property or field beginDate on the class org.musicbrainz.mmd2.Alias is required to be included in the propOrder element of the XmlType annotation.]
    at org.eclipse.persistence.jaxb.JAXBContext$TypeMappingInfoInput.createContextState(JAXBContext.java:1021)
    at org.eclipse.persistence.jaxb.JAXBContext.<init>(JAXBContext.java:174)
    at org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(JAXBContextFactory.java:165)
    at org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(JAXBContextFactory.java:152)
    at org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(JAXBContextFactory.java:112)
    at org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(JAXBContextFactory.java:102)
    at org.musicbrainz.search.servlet.mmd2.ResultsWriter.initJsonContext(ResultsWriter.java:100)
    ... 25 more

Затем я отредактировал Alias.java, чтобы добавить beginDate в propOrder, но это дало эту ошибку. Это правда — содержимое аннотируется @XmlValue, но я не понимаю, почему это проблема.

Exception Description: The property or field beginDate must be an attribute because another field or property is annotated with XmlValue.]
    at org.eclipse.persistence.jaxb.JAXBContext$TypeMappingInfoInput.createContextState(JAXBContext.java:1021)
    at org.eclipse.persistence.jaxb.JAXBContext.<init>(JAXBContext.java:174)
    at org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(JAXBContextFactory.java:165)
    at org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(JAXBContextFactory.java:152)
    at org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(JAXBContextFactory.java:112)
    at org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(JAXBContextFactory.java:102)
    at org.musicbrainz.search.servlet.mmd2.ResultsWriter.initJsonContext(ResultsWriter.java:100)
    ... 30 more

К сожалению, я не могу использовать параметр @XmlElement, потому что beginDate — это атрибут, а не элемент, и у него уже есть аннотация @XmlAttribute, и это, похоже, не поддерживает значение nillable.


person Paul Taylor    schedule 05.06.2013    source источник


Ответы (1)


В аннотации @XmlElement есть параметр nillable, который вы можете использовать для обработки этого. Однако, если это установлено, вы получите то, что хотите, в JSON, но XML добавит атрибут xsi: nil, когда значение равно null. Если вам нужно другое поведение между JSON и XML, вы можете использовать файл привязок вместо добавления аннотации к вашему объекту. Затем вы создадите 2 JAXBContexts с разными файлами привязок (или один с файлом привязок и один без него), чтобы указать другое поведение.

С обновленной информацией о Alias.java вам также может понадобиться очистить проп-порядок (или вы можете перечислить все элементы и расположить их по своему усмотрению, я только что очистил его в примере oxm.xml ниже). Кроме того, поскольку контент имеет аннотацию @XmlValue в oxm.xml для привязки JSON, его можно изменить, чтобы вместо этого он обрабатывался как обычный элемент (и назовите его значение или как вы хотите его назвать).

Пример аннотации

public class Alias{

  @XmlElement(name="begin-date", nillable= true)
  public String beginDate;
}

Пример файла привязок (oxm.xml)

<xml-bindings xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/oxm" package-name="mypackage.test">
    <java-types>
       <java-type name="Alias">
          <xml-type prop-order=""/>
          <java-attributes>
             <xml-element java-attribute="beginDate" name="begin-date" nillable="true"/>
             <xml-element java-attribute="content" name="value"/>
          </java-attributes>
        </java-type>
    </java-types>
</xml-bindings>

Чтобы создать JAXBContext с файлом привязок, выполните следующие действия.

Map<String, Object> props = new HashMap<String, Object>();
StreamSource ss = new StreamSource(new File("pathtobindings/oxm.xml"));
props.put(JAXBContextProperties.OXM_METADATA_SOURCE, ss);
JAXBContext contextWithBindings = JAXBContext.newInstance(myClasses, props);
person Denise    schedule 05.06.2013
comment
спасибо, но, к сожалению, я не могу заставить ваше решение работать на меня, я добавил свой прогресс в вопрос. - person Paul Taylor; 06.06.2013
comment
Я обновил свой ответ. В oxm.xml я добавил prop-order=, чтобы очистить правильный порядок (или вы можете добавить все элементы в нужном вам порядке). Кроме того, я добавил элемент xml для содержимого, чтобы он рассматривался как другой элемент, а не имел аннотацию @XmlValue. - person Denise; 06.06.2013
comment
Таким образом, изменение состоит в том, чтобы установить prop_order= в oxml.xml, но это просто дает мне «Описание исключения: свойство или поле beginDate должно быть атрибутом, поскольку другое поле или свойство аннотировано XmlValue». ошибка сразу. Обратите внимание, что beginDate — это атрибут, а не элемент, и поскольку у нас уже есть аннотация XmlValue в классе Alias, мы не можем изменить XmlAttribute на атрибут XmlElement. - person Paul Taylor; 06.06.2013
comment
Другая часть изменения заключается в добавлении ‹xml-element java-attribute=content name=value/› (значение может быть любым, которое вы хотите видеть в JSON), чтобы обрабатывать контент как обычный элемент в JSON, а не обрабатывать его. например, наличие аннотации @XmlValue, и это должно избежать упомянутого вами исключения. - person Denise; 06.06.2013
comment
Ах, спасибо, извините, я думал, вы просто повторяете ответ на мой другой вопрос stackoverflow.com/questions/16931910/, и поскольку я использовал альтернативное решение, которое вы дали, я не видел в нем необходимости. Я не совсем понимаю это, но теперь оно работает :) - person Paul Taylor; 07.06.2013