要扩展上面的“使用 JAXB”注释,
在 Windows "%java_home%\bin\xjc" -p [your namespace] [xsd_file].xsd
中
例如,"%java_home%\bin\xjc" -p com.mycompany.quickbooks.obj quickbooks.xsd
稍等一下,如果您有一个格式良好的 XSD 文件,您将获得一些格式良好的 Java 类
JAXB 完全符合您的要求。从 1.6 开始,它内置在 JRE/JDK 中
如果您想在 5 分钟内开始将 Java 编码到 XML 和 XML 到 Java,请尝试简单 XML 序列化。不要花时间学习 JAXB API http://simple.sourceforge.net/download/stream/doc/tutorial/tutorial.php
但是,如果您真的热衷于学习 JAXB,这里有一个很好的教程 http://blogs.oracle.com/teera/entry/jaxb_for_simple_java_xml
教程内容:
用于简单 Java-XML 序列化的 JAXB
在 Java 中有多种方法可以进行 XML 序列化。如果您想对解析和序列化进行细粒度控制,您可以使用 SAX、DOM 或 Stax 以获得更好的性能。然而,我经常想做的是 POJO 和 XML 之间的简单映射。但是,手动创建 Java 类来进行 XML 事件解析并非易事。我最近发现 JAXB 是一种快速方便的 Java-XML 映射或序列化。
JAXB 包含很多有用的特性,您可以在此处查看参考实现。 Kohsuke's Blog 也是了解有关 JAXB 的更多信息的好资源。对于这篇博文,我将向您展示如何使用 JAXB 进行简单的 Java-XML 序列化。
POJO 转 XML
假设我有一个 Item Java 对象。我想将 Item 对象序列化为 XML 格式。我首先要做的是使用 javax.xml.bind.annotation.* 包中的一些 XML 注释来注释这个 POJO。参见 Item.java 的代码清单 1
从代码
@XmlRootElement(name="Item") 表示我想成为根元素。
@XmlType(propOrder = {"name", "price"}) 表示我希望元素在 XML 输出中排列的顺序。
@XmlAttribute(name="id", ...) 表示 id 是根元素的属性。
@XmlElement(....) 表示我希望价格和名称成为 Item 中的元素。
我的 Item.java
已准备就绪。然后我可以继续创建用于编组项的 JAXB 脚本。
//creating Item data object
Item item = new Item();
item.setId(2);
item.setName("Foo");
item.setPrice(200);
.....
JAXBContext context = JAXBContext.newInstance(item.getClass());
Marshaller marshaller = context.createMarshaller();
//I want to save the output file to item.xml
marshaller.marshal(item, new FileWriter("item.xml"));
有关完整的代码清单,请参阅代码清单 2 main.java
。将创建输出代码清单 3 item.xml
文件。它看起来像这样:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns1:item ns1:id="2" xmlns:ns1="http://blogs.sun.com/teera/ns/item">
<ns1:itemName>Foo</ns1:itemName>
<ns1:price>200</ns1:price>
</ns1:item>
容易吧?您也可以通过简单地更改 marshal(...) 方法的参数(如
...
JAXBContext context = JAXBContext.newInstance(item.getClass());
Marshaller marshaller = context.createMarshaller();
// save xml output to the OutputStream instance
marshaller.marshal(item, <java.io.OutputStream instance>);
...
JAXBContext context = JAXBContext.newInstance(item.getClass());
Marshaller marshaller = context.createMarshaller();
StringWriter sw = new StringWriter();
//save to StringWriter, you can then call sw.toString() to get java.lang.String
marshaller.marshal(item, sw);
XML 到 POJO
让我们颠倒这个过程。假设我现在有一段 XML 字符串数据,我想把它变成 Item.java 对象。 XML 数据(代码清单 3)看起来像
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns1:item ns1:id="2" xmlns:ns1="http://blogs.sun.com/teera/ns/item">
<ns1:itemName>Bar</ns1:itemName>
<ns1:price>80</ns1:price>
</ns1:item>
然后我可以将这个 xml 代码解组为 Item 对象
...
ByteArrayInputStream xmlContentBytes = new ByteArrayInputStream (xmlContent.getBytes());
JAXBContext context = JAXBContext.newInstance(Item.getClass());
Unmarshaller unmarshaller = context.createUnmarshaller();
//note: setting schema to null will turn validator off
unmarshaller.setSchema(null);
Object xmlObject = Item.getClass().cast(unmarshaller.unmarshal(xmlContentBytes));
return xmlObject;
...
有关完整的代码清单,请参见代码清单 2 (main.java)。 XML 源可以来自 Stream 和文件的多种形式。同样,唯一的区别是方法参数:
...
unmarshaller.unmarshal(new File("Item.xml")); // reading from file
...
// inputStream is an instance of java.io.InputStream, reading from stream
unmarshaller.unmarshal(inputStream);
使用 XML 模式进行验证
我想在这里提到的最后一件事是在解组到 Java 对象之前使用模式验证输入 XML。我创建了一个名为 item.xsd 的 XML 模式文件。有关完整的代码清单,请参阅代码清单 4 (Item.xsd)。现在我要做的是注册这个模式进行验证。
...
Schema schema = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI)
.newSchema(new File("Item.xsd"));
unmarshaller.setSchema(schema); //register item.xsd shcema for validation
...
当我尝试将 XML 数据解组到 POJO 时,如果输入的 XML 不符合模式,则会捕获异常。有关完整的代码清单,请参阅代码清单 5 (invalid_item.xml)。
javax.xml.bind.UnmarshalException
- with linked exception:
javax.xml.bind.JAXBException caught: null
[org.xml.sax.SAXParseException: cvc-datatype-valid.1.2.1: 'item1' is
not a valid value for 'integer'.]
在这里,我将“id”属性更改为字符串而不是整数。
如果 XML 输入对模式有效,则 XML 数据将成功解组到 Item.java 对象。
使用 Eclipse IDE:-
将 xsd 复制到一个新的/现有的项目中。确保您的类路径中有 JAXB 所需的 JAR。你可以在这里下载一个。右键单击 XSD 文件 -> 生成 -> JAXB 类。
最简单的方法是使用命令行。只需输入 .xsd 文件的目录:
xjc myFile.xsd.
所以,java 会生成所有的 Pojos。
Maven 可以用于此目的,您需要添加一些依赖项并清理您的应用程序。您将在目标文件夹中自动创建所有类。
只需将它们从目标复制到所需位置,这是我用来从 xsd
文件创建分类的 pom.xml
:
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jaxb2-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>xjc</goal>
</goals>
</execution>
</executions>
<configuration>
<schemaDirectory>src/main/webapp/schemas/</schemaDirectory>
</configuration>
</plugin>
只需将您的 xsd 文件放在 src/main/webapp/schemas/
下,maven 就会在编译时找到它们。
No XSD files found. Please check your plugin configuration.
最好的选择是%java_home%\bin\xjc -p [your namespace] [xsd_file].xsd
。
如果我们可以选择在这里进行逆向工程,我还有一个问题。如果可以,我们可以从 pojo 类生成 xsd 吗?
如果您不介意使用外部库,我过去曾使用 Castor 来执行此操作。
JAXB 限制。
我在 JAXB 上工作,我认为它是处理 XML 和 Java 对象之间数据的好方法。积极的方面是它在运行时的性能和对数据的控制方面得到了证明并且更好。通过良好地使用内置工具或脚本,它将消除大量编码工作。
我发现配置部分不是一个直接的任务,并且花了几个小时来设置开发环境。
然而,由于我面临一个愚蠢的限制,我放弃了这个解决方案。我的 XML 模式定义 ( XSD ) 有一个名为“值”的属性/元素,我必须按原样使用 XSD。这个非常小的约束迫使我的绑定步骤 XJC 失败,并出现错误“已使用属性‘值’”。
这是由于 JAXB 实现,绑定过程尝试通过向每个类添加少量属性(其中一个是值属性)来从 XSD 创建 Java 对象。当它处理我的 XSD 时,它抱怨已经有一个具有该名称的属性。
JAXB 的 XJC 不是对此的可能答案吗?我正在努力实现同样的目标。但仍处于“尝试”阶段。偶然发现了XJC,所以想到了分享。
谈到 JAXB 限制,当不同属性具有相同名称时,一个解决方案是将内联 jaxb 自定义添加到 xsd:
+
. .有约束力的声明。 .
或外部自定义...
您可以在以下位置查看更多信息:http://jaxb.java.net/tutorial/section_5_3-Overriding-Names.html