我正在尝试实现一些东西,用于将 java 对象的内容树写回 XML 文件(对象编组)(我知道有很多 API 可以做到这一点,但我需要),我想让用户根据他/她的需要重新排序标签,我知道使用 JAXB 之类的注释可能会解决这个问题,但我认为使用注释可能会导致很多痛苦。如果有人能提供任何好的方法,那将非常有帮助。
谢谢
我正在尝试实现一些东西,用于将 java 对象的内容树写回 XML 文件(对象编组)(我知道有很多 API 可以做到这一点,但我需要),我想让用户根据他/她的需要重新排序标签,我知道使用 JAXB 之类的注释可能会解决这个问题,但我认为使用注释可能会导致很多痛苦。如果有人能提供任何好的方法,那将非常有帮助。
谢谢
注意: 我是EclipseLink JAXB (MOXy)负责人,也是JAXB (JSR-222)专家组的成员。
在另一个答案中,我描述了用于指定元素顺序的标准 JAXB 机制。在这个答案中,我将解释如何使用 MOXy 的外部映射文档来解决您问题的这一部分:
我想让用户按照他/她的意愿重新排序标签,我知道使用像 JAXB 这样的注释可能会解决这个问题,但我认为使用注释可能会带来很多痛苦。
根
在Root
课程中,我使用@XmlType
注释来指定排序。
package forum11217734;
import javax.xml.bind.annotation.*;
@XmlRootElement
@XmlType(propOrder={"c", "b", "a"})
public class Root {
private String a;
private String b;
private String c;
public String getA() {
return a;
}
public void setA(String a) {
this.a = a;
}
public String getB() {
return b;
}
public void setB(String b) {
this.b = b;
}
public String getC() {
return c;
}
public void setC(String c) {
this.c = c;
}
}
jaxb.properties
要将 MOXy 指定为您的 JAXB 提供程序,您需要在与域模型相同的包中添加一个名为 jaxb.properties 的文件,其中包含以下条目(请参阅将EclipseLink MOXy 指定为您的 JAXB 提供程序):
javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory
绑定-acb.xml
MOXy 有一个外部映射文档扩展,允许您覆盖域模型上的映射(请参阅扩展 JAXB - 将元数据表示为 XML)。我们将使用此文档来指定另一个排序。
<?xml version="1.0"?>
<xml-bindings
xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/oxm"
package-name="forum11217734">
<java-types>
<java-type name="Root">
<xml-type prop-order="a c b"/>
</java-type>
</java-types>
</xml-bindings>
绑定-cab.xml
我们可以使用其他映射文档来提供替代排序。
<?xml version="1.0"?>
<xml-bindings
xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/oxm"
package-name="forum11217734">
<java-types>
<java-type name="Root">
<xml-type prop-order="c a b"/>
</java-type>
</java-types>
</xml-bindings>
演示
以下演示代码演示了如何在创建JAXBContext
. Root
我们将以三种不同的方式编组相同的实例。
package forum11217734;
import java.util.*;
import javax.xml.bind.*;
import org.eclipse.persistence.jaxb.JAXBContextFactory;
public class Demo {
public static void main(String[] args) throws Exception {
Root root = new Root();
root.setA("Foo");
root.setB("Bar");
root.setC("Baz");
// CBA
JAXBContext cbaContext = JAXBContext.newInstance(Root.class);
Marshaller cbaMarshaller = cbaContext.createMarshaller();
cbaMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
cbaMarshaller.marshal(root, System.out);
// ACB
Map<String, Object> acbProperties = new HashMap<String, Object>(1);
acbProperties.put(JAXBContextFactory.ECLIPSELINK_OXM_XML_KEY, "forum11217734/binding-acb.xml");
JAXBContext acbContext = JAXBContext.newInstance(new Class[] {Root.class}, acbProperties);
Marshaller acbMarshaller = acbContext.createMarshaller();
acbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
acbMarshaller.marshal(root, System.out);
// CAB
Map<String, Object> cabProperties = new HashMap<String, Object>(1);
cabProperties.put(JAXBContextFactory.ECLIPSELINK_OXM_XML_KEY, "forum11217734/binding-cab.xml");
JAXBContext cabContext = JAXBContext.newInstance(new Class[] {Root.class}, cabProperties);
Marshaller cabMarshaller = cabContext.createMarshaller();
cabMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
cabMarshaller.marshal(root, System.out);
}
}
输出
下面是运行演示代码的输出:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<c>Baz</c>
<b>Bar</b>
<a>Foo</a>
</root>
<?xml version="1.0" encoding="UTF-8"?>
<root>
<a>Foo</a>
<c>Baz</c>
<b>Bar</b>
</root>
<?xml version="1.0" encoding="UTF-8"?>
<root>
<c>Baz</c>
<a>Foo</a>
<b>Bar</b>
</root>
当内容被编组为 XML 时, JAXB (JSR-222)实现提供了几种不同的机制来指定 XML 元素的顺序。JAXB 在解组时不要求元素按顺序排列。
选项 #1 - @XmlType(propOrder={"c","b", "a"})
注释上的propOrder
属性@XmlType
允许您指定顺序。
根
package forum11217734;
import javax.xml.bind.annotation.*;
@XmlRootElement
@XmlType(propOrder={"c","b", "a"})
public class Root {
private String a;
private String b;
private String c;
public String getA() {
return a;
}
public void setA(String a) {
this.a = a;
}
public String getB() {
return b;
}
public void setB(String b) {
this.b = b;
}
public String getC() {
return c;
}
public void setC(String c) {
this.c = c;
}
}
输出
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root>
<c>Baz</c>
<b>Bar</b>
<a>Foo</a>
</root>
了解更多信息
选项 #2 - @XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
您还可以使用@XmlAccessorOrder
注释指定属性应按字母顺序编组。
根
package forum11217734;
import javax.xml.bind.annotation.*;
@XmlRootElement
@XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
public class Root {
private String a;
private String b;
private String c;
public String getA() {
return a;
}
public void setA(String a) {
this.a = a;
}
public String getB() {
return b;
}
public void setB(String b) {
this.b = b;
}
public String getC() {
return c;
}
public void setC(String c) {
this.c = c;
}
}
输出
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root>
<a>Foo</a>
<b>Bar</b>
<c>Baz</c>
</root>
演示代码
以下演示代码用于生成上述每个选项的输出。
package forum11217734;
import javax.xml.bind.*;
public class Demo {
public static void main(String[] args) throws Exception {
JAXBContext jc = JAXBContext.newInstance(Root.class);
Root root = new Root();
root.setA("Foo");
root.setB("Bar");
root.setC("Baz");
Marshaller marshaller = jc.createMarshaller();
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
marshaller.marshal(root, System.out);
}
}