从 JAXB 和 Jersey 生成更多类似 json 的 json答案

【问题标题】：Generating more json like json from JAXB and Jersey从 JAXB 和 Jersey 生成更多类似 json 的 json
【发布时间】：2012-05-22 09:12:27
【问题描述】：

我使用使用 JAXB 创建的数据模型，从中我可以直接生成 XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\
<metadata xmlns="http://musicbrainz.org/ns/mmd-2.0#" xmlns:ext="http://musicbrainz.org/ns/ext#-2.0">
<artist-list offset="0" count="1">
   <artist ext:score="100" type="Group" id="4302e264-1cf0-4d1f-aca7-2a6f89e34b36">       
       <name>Farming Incident</name>
       <ipi-list>
          <ipi>1001</ipi>
       </ipi-list>
   </artist>
</artist-list>
</metadata>

在 Jersey 的帮助下，还可以使用自然表示法生成 JSon

"artist-list":
    {"offset":0,
     "count":1,
     "artist":[
         {"score":"100",
          "type":"Group",
          "id":"4302e264-1cf0-4d1faca7-2a6f89e34b36",
          "name":"Farming Incident",
          "ipi-list":
              {
                  "ipi":[
                       "1001"
                    ]
             }
          }]
     }

Xml 很好，json 几乎很好，除了因为 Json 直接支持具有 ipi-list 和 Artist-list 等元素的数组似乎不是很 json，是否可以从我的模型生成更多类似于 json 的 json？

应要求提供的其他信息 json 是从此 MMD 模式生成的 http://svn.musicbrainz.org/mmd-schema/trunk/brainz-mmd2-jaxb/src/main/resources/musicbrainz_mmd-2.0.xsd 使用 JAXB 和 Jersey ，看 http://svn.musicbrainz.org/search_server/trunk/servlet/src/main/java/org/musicbrainz/search/servlet/mmd2/ResultsWriter.java 和 http://svn.musicbrainz.org/search_server/trunk/servlet/src/main/java/org/musicbrainz/search/servlet/mmd2/ArtistWriter.java

关键是我希望能够以最小的麻烦从一个模式生成 Json 和 XML，但显然 Json 看起来不正确，所以我正在寻找一种改进它的方法（我真的不自己有json的经验）

【问题讨论】：

您的模型最初是注解的 java 类还是 JAXB 模式？
您的输出似乎有点奇怪。您能否展示如何对类进行注释以及如何转换为 XML/JSON？
这正是你所拥有的：对于每个对象，你都有它的所有属性等等。如果您不喜欢它 - 在现有 JAXB 注释之上创建自己的注释，以生成带有 JSON 特定注释的自定义 JSON。
我已经更新了问题
不只是另一个 XmlElement ，但 XmlElementWrapper 听起来很有趣

标签： java json jaxb jersey

【解决方案1】：

注意：我是EclipseLink JAXB (MOXy) 的负责人，也是JAXB (JSR-222) 专家组的成员。

您可以利用 EclipseLink JAXB (MOXy) 中的 JSON 绑定和外部映射文档来支持您的用例。

外部映射文件 (oxml.xml)

您可以使用 MOXy 中的 @XmlPath(".") 扩展来展平对象模型的某些部分。指定"." 的路径告诉 MOXy 将引用的对象包含在父节点中。

<?xml version="1.0"?>
<xml-bindings
    xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/oxm"
    package-name="forum10699038">
    <java-types>
        <java-type name="Metadata">
            <java-attributes>
                <xml-element java-attribute="artistList" xml-path="."/>
            </java-attributes>
        </java-type>
        <java-type name="Artist">
            <java-attributes>
                <xml-element java-attribute="ipiList" xml-path="."/>
            </java-attributes>
        </java-type>
    </java-types>
</xml-bindings>

jaxb.properties

要将 MOXy 指定为您的 JAXB 提供程序，您需要在与您的域模型相同的包中添加一个名为 jaxb.properties 的文件，并使用以下条目。

javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory

演示

下面的代码从您的 XML 文档填充对象模型，然后编组为 JSON。它演示了如何利用外部映射文件并将 MOXy 置于 JSON 模式。

package forum10699038;

import java.io.File;
import java.util.*;
import javax.xml.bind.*;

import org.eclipse.persistence.jaxb.JAXBContextProperties;

public class Demo {

    public static void main(String[] args) throws Exception {
        // READ FROM XML
        JAXBContext jcXML = JAXBContext.newInstance(Metadata.class);

        File xml = new File("src/forum10699038/input.xml");
        Unmarshaller unmarshaller = jcXML.createUnmarshaller();
        Metadata metadata = (Metadata) unmarshaller.unmarshal(xml);

        // WRITE TO JSON
        Map<String, Object> properties = new HashMap<String, Object>(3);
        properties.put(JAXBContextProperties.OXM_METADATA_SOURCE, "forum10699038/oxm.xml");
        properties.put(JAXBContextProperties.MEDIA_TYPE, "application/json");
        properties.put(JAXBContextProperties.JSON_INCLUDE_ROOT, false);
        JAXBContext jcJSON = JAXBContext.newInstance(new Class[] {Metadata.class}, properties);

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

}

输出

{
   "artist" : [ {
      "id" : "4302e264-1cf0-4d1f-aca7-2a6f89e34b36",
      "type" : "Group",
      "score" : "100",
      "name" : "Farming Incident",
      "ipi" : [ "1001" ]
   } ]
}

MOXy 和泽西岛

您可以在 JAXB-RS 环境（例如 Jersey）中轻松使用 MOXy 作为 JSON 提供程序：

http://blog.bdoughan.com/2012/05/moxy-as-your-jax-rs-json-provider.html

其他文件

以下是我创建的文件版本，以确保一切正常。

input.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<metadata xmlns="http://musicbrainz.org/ns/mmd-2.0#" xmlns:ext="http://musicbrainz.org/ns/ext#-2.0">
    <artist-list offset="0" count="1">
        <artist ext:score="100" type="Group"
            id="4302e264-1cf0-4d1f-aca7-2a6f89e34b36">
            <name>Farming Incident</name>
            <ipi-list>
                <ipi>1001</ipi>
            </ipi-list>
        </artist>
    </artist-list>
</metadata>

元数据

package forum10699038;

import javax.xml.bind.annotation.*;

@XmlRootElement
public class Metadata {

    @XmlElement(name="artist-list")
    ArtistList artistList;

}

艺术家名单

package forum10699038;

import java.util.List;

public class ArtistList {

    private List<Artist> artist;

}

艺术家

package forum10699038;

import javax.xml.bind.annotation.*;

@XmlType(propOrder={"name", "ipiList"})
public class Artist {

    @XmlAttribute
    private String id;

    @XmlAttribute
    private String type;

    @XmlAttribute(namespace="http://musicbrainz.org/ns/ext#-2.0")
    private String score;

    @XmlElement(name="ipi-list")
    private IPIList ipiList;

    private String name;

}

IPList

package forum10699038;

import java.util.List;

public class IPIList {

    private List<String> ipi;

}

包裹信息

@XmlSchema( 
    namespace = "http://musicbrainz.org/ns/mmd-2.0#", 
    elementFormDefault = XmlNsForm.QUALIFIED,
    xmlns={
        @XmlNs(prefix="", namespaceURI = "http://musicbrainz.org/ns/mmd-2.0#")
    }
) 
@XmlAccessorType(XmlAccessType.FIELD)
package forum10699038;

import javax.xml.bind.annotation.*;

【讨论】：

感谢这个非常详细的回复，对不起，我应该早点回复，但不太明白它是否会做我想要的。我已经有一个使用 XSD 中的 vanilla JAXB 创建的对象模型，我可以将此对象模型与 Moxy 一起使用来生成我想要的 Json，还是必须使用 Moxy 创建另一个单独的对象模型才能构建 Json？
@PaulTaylor - 您可以将您的对象模型与 MOXy 一起使用。我为答案创建了一个来展示它的外观。
标记为正确，是否可以在代码而不是文件中指定 javax.xml.bind.context.factory，因为我只想在输出 json 时使用 Moxy 而不是在输出 xml 时（因为那里那里没问题，不要改变任何东西）
@PaulTaylor - 如果您使用 MOXyJsonProvider 类，则 MOXy 将用于 JSON 绑定，另一个 JAXB 提供程序将用于 XML（请参阅 blog.bdoughan.com/2012/05/…）。由于 MOXy 实现了 JAXB (JSR-222) 规范，因此您也可以放心地将它用于您的 XML。仅供参考，WebLogic 切换到 MOXy 作为默认 JAXB 提供程序：blog.bdoughan.com/2011/12/…
我正在按照您的示例进行操作，因此不使用 MoxyJsonProvider（或 JAX-RS），我的 Xml 输出已经在生产中，所以我真的宁愿不做任何可以改变任何中的 xml 输出的事情方式，所以没有办法在两者之间指定 javax.xml.bind.context.factory.programmatically 。 Moxy 在 Maven 中也可用。

【解决方案2】：

Jersey 创建的 JSON 是网站上提供的该模型的精确 JSOON 表示。您在这里面临的问题是该网站提供了一个笨拙的数据模型，而不是该框架没有做正确的事情。

为什么此服务返回艺术家列表类型的对象，而不是返回艺术家列表？为什么服务也有一个 ipi-list 对象？您应该问的真正问题应该是，应该如何对其建模以更好地与所有技术一起使用。

【讨论】：

我理解你的一般观点，但你必须考虑这个模型是从 xml 模式生成的，我看不出在 xml 中我如何在没有 ipilist 对象的情况下拥有多个 ipi 对象。即应该有一个模型可以生成合理的 xml 和 json

【解决方案3】：

我个人不太喜欢注释。有用纯代码生成 JSON/XML 的习惯。 :)

以Jackson为例（Gson也类似）：

mapper = new ObjectMapper();
JsonNode root = mapper.createObjectNode();

JsonNode artist = mapper.createObjectNode();
artist.put("score", "100");
root.put("artist-list", artist);

ArrayNode ipiList = mapper.createArrayNode();
ipi.add("1001");
artist.put("ipi-list", ipiList);

表面上看起来可能需要做很多工作。但对我来说，这是将 JSON 映射到对象的非常清晰的方法。基本上在实体类中拥有 toJson() 方法是我的惯常做法。这是一个例子：https://github.com/richardzcode/metrics/blob/master/src/main/java/com/rz/metrics/core/entities

这只是我。

对于 JAXB，我认为您需要如下注释您的实体：

@XmlElement(name = "ipi-list")
private List<Ipi> ipi;

【讨论】：

是的，工作量很大，这意味着每次对象模型更改时，我都必须更新代码的 json 部分。我宁愿使用模型本身，让其他东西处理转换为 xml 或 json

【解决方案4】：

我认为您在 ipiList 中看到的问题是由于 Jersey 用于映射到 JSON 的底层库中的单元素数组/列表存在问题。

以下博客文章（不是我的）展示了配置 Jersey 的一种方法，并且 cmets 链接到替代（可能更简单）的方法以使 JSON 表示对数组正确：

http://tugdualgrall.blogspot.co.uk/2011/09/jax-rs-jersey-and-single-element-arrays.html

【讨论】：

【解决方案5】：

我设法解决了 Jersey json 库中的 JSON 数组和原始字段“错误”。秘密成分是前面提到的 JSONConfiguration 和 ContextResolver 魔术。请参阅我的以下帖子，它有一个完整的代码示例，自定义的 ContextResolver 和 rest Application 类乍一看可能有点模糊。

How to serialize Java primitives using Jersey REST

用于零或单元素 Java 列表的 json 数组
不带引号字符的原始整数或布尔字段

【讨论】：