java - 结合使用XML Schema和XML到JSON转换是否可行？

Question

我必须指定一个JSON数据结构；数据结构将成为接口描述的一部分，数据将由JavaScript处理。为数据传输设置了JSON。在其他项目中，我们使用XML而不是JSON，为此我使用了丰富的XML模式。不幸的是，我现在不能这样做。

我做了一些研究，发现JSON Schema。
但是，这仍然是草稿状态，这使我在这种情况下使用它感到有些不安。

我还遇到了this question，讨论了如何将XML映射到JSON。 org.json命名空间中的XML class中似乎有一个标准(？)转换。对于没有混合内容的XML文档来说，转换似乎很简单。

因此，我们的想法是使用XML Schema来描述数据结构，尽可能在服务器端使用我们现有的XML处理(编辑，转换，验证等)工具，并在交付XML DOM之前将其转换为JSON。数据发送给JSON使用者。

数据传输仅是单向的，我们不会使用混合内容的XML。

也许有人尝试过这个？从(概念上)应用于JSON文档时，对于客户端程序员来说，XML Schema的语义仍然足够清晰，从某种意义上说，这将是一种实用的方法吗？有什么特别的陷阱要注意吗？

Answer 1

如果我理解您的想法正确，那么您想将XML Schema用作数据交换的主要模型-XML以及JSON格式。

这个想法分为两个部分:

使用单一源来建模所有数据交换。

使用XML Schema作为此单一源。

单源模型

第一个想法将您带到MDD( Model-Driven Development)或MDA( Model-Driven Architecture)，它们在2002-2005年间大肆宣传。这是UML繁重的，由厂商驱动的炒作，但是幸存了不少合理的东西(例如 AndroMDA)。

通常，MDA是个好主意。只要您做“标准”的事情，它就可以出色地工作。但是，如果您要“自定义”，这可能是一场噩梦。

对于您的情况，我绝对会说单源模型很有意义。这是关于数据交换的。从根本上讲，这可以简化为非常简单的模型，这些模型仍然足以表达您所需的一切。

JSON就是一个例子。 JSON比XML还要简单，但功能仍然足够强大。它清楚地表明，只要您具有基本的原始类型，对象，数组和嵌套，就可以表达几乎所有内容。

这种“单一源模型”不一定必须是UML，它可以足够强大以涵盖所有潜在需求。

“单源模型”的主要问题是定制。您知道，90％的OOTB表现很好，但是10％的客户并没有获得想要的结果，因此必须进行自定义，然后才能努力。大多数生成工具都有某些“插件”。因此，如果您符合90％的要求，那么您很幸运，否则，您可能需要了解生成工具的毛茸茸的内部构造。

综上所述， 单源模型是的一个好主意，只要它满足所有需求，并且为所需的场景进行改编/应用所付出的努力并不比从头开始做更大。

XML模式作为模型

下一个问题是XML Schema是否适合作为单一源模型。

您可能听说过或使用了带有 JAXB(XJC)的 schema compiler。该编译器可以采用您的XML模式，然后生成带有JAXB批注的Java类。然后可以使用这些类将XML解组为Java对象或将这些对象组为XML。

和JSON:

JAXB Mapping to JSON

看起来您还可以从这些类中生成JSON模式(不过我自己还没有尝试过):

How to generate JSON schema from a JAXB annotated class?

因此XML Schema-first方法有效。您可以将其称为模式驱动的开发(我在此要求版权)。

我个人做了很多事情，架构优先为XJC编写了许多工具/插件。例如:

Hyperjaxb使基于模式的类可持久化与JPA。

Jsonix绝对是纯JavaScript的JAXB端口。

我的经验是，您可以做很多事情，而架构优先的事情，但是我也不得不说XML Schema是好的，但不是最好或最简单的模型。规范很复杂，如果您看一下架构派生的类，那么您可能会发现一些不适用于Java bean和属性的构造。例如， @XmlElementRef 是一个复杂且通常看起来很奇怪的结构-涵盖许多您可以轻松地在XML Schema中表达的情况是必要的。在我写的所有工具中，我总是不得不与这种构造的案例和更严峻的案例以及极端案例进行斗争。

如果保持XML Schema简单简洁，它可能会很漂亮。完美适合bean和属性的地图，易于理解和使用，并提供了许多工具支持。因此， XML Schema并不是建模或指定数据交换的最糟糕的选择。

但是它也可能变得像 hell 一样复杂。我看到了很多过度设计的模式，这些模式非常难以使用-收获很少。有时，架构设计人员只是不太了解XML Schema，有时却非常了解。上一次我帮助制定“XML Schema设计最佳实践”时，我们发现了60多个页面上的“有无”文档。因此很容易弄错XML模式。

但是，正如我上面所说，如果保持简单整洁，可能会很美。

有哪些选择？

好吧，您实际上可以使用Java代码作为模型源。带注释的POJO具有足够强大的表达能力和通用性，但使用起来仍然非常简单。您不是架构优先的，而是Java代码优先的，但是您仍然可以做所有相同的技巧。您可以根据带注释的类 generate an XML Schema。您可以使用 MOXy进行持久化(甚至更多)。您可以执行JSON just as well。

总结并回答您的问题:

是的，它很实用，并且众所周知可以很好地工作。

与模式优先方法一起还考虑了Java优先方法。

您具有用于获取XML-Objects-JSON-Persistence的工具。

有陷阱(请参见上文)。

希望这可以帮助。