使用EclipseLink MOXy输出JSON时,如何输出null元素和属性

时间:2013-06-05 05:14:43

标签: java xml json eclipselink moxy

在我的XML中,我只输出一个元素,如果它有一个值,但是对JSON的要求是输出值,即使没有设置

即 XML

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

我希望JSON输出别名元素的其他元素,即使没有设置

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

但是我所能做的就是有一个方法,当我输出json将这些null元素设置为空字符串时,我会使用这个方法,这给了我

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

但这不是我想要的

尝试使用Denises回答更新

我在提出的解决方案中遇到了一些问题,首先是完整的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。

1 个答案:

答案 0 :(得分:1)

@XmlElement注释上有一个可以使用的选项可用于处理此问题。但是,如果设置了这个,那么您将在JSON中获得所需的内容,但是当值为null时,XML将添加xsi:nil属性。如果您希望JSON和XML之间存在不同的行为,则可以使用绑定文件,而不是在对象上添加注释。然后,您将创建具有不同绑定文件的2个JAXBContexts(或者具有绑定文件且没有绑定文件的文件)以指定不同的行为。

使用有关Alias.java的更新信息,您还需要清除prop-order(或者您可以根据需要列出所有元素和顺序,我刚刚在下面的oxm.xml示例中清除了它) 。此外,由于内容在oxm.xml中有一个@XmlValue注释用于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);