[英]Generate java Array instead of Collection type with Jaxb from xsd
[英]Java XSD - using a custom collection type
我正在使用 jaxb2 maven 插件將我的 XSD 定義的對象轉換為 Java 類。 我的目標是將 XSD 中的列表類型元素(例如xs:choice unbound
)設置為 LinkedList 而不是使用默認的 ArrayList 類型。 我正在使用 jaxb-xew-plugin 版本 1.10。 這是我的相關代碼:
<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema jaxb:version="2.0"
xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
xmlns:xew="http://github.com/jaxb-xew-plugin"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
jaxb:extensionBindingPrefixes="xew"
elementFormDefault="qualified">
<xs:element name="TEST">
<xs:complexType>
<xs:annotation>
<xs:appinfo>
<xew:xew collection="java.util.LinkedList"
collectionInterface="java.util.List"
instantiate="lazy"
plural="true"/>
</xs:appinfo>
</xs:annotation>
<xs:choice>
<xs:element name="action" type="xs:token" minOccurs="0" maxOccurs="unbounded">
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
<build>
<resources>
<resource>
<directory>src/main/xsd</directory>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jaxb2-maven-plugin</artifactId>
<version>2.5.0</version>
<executions>
<execution>
<id>xjc</id>
<phase>generate-sources</phase>
<goals>
<goal>xjc</goal>
</goals>
<configuration>
<sources>src/main/xsd</sources>
<packageName>com.tug.data.model.gen</packageName>
<verbose>true</verbose>
<clearOutputDir>false</clearOutputDir>
<extension>true</extension>
<arguments>
<argument>-Xsetters</argument>
<argument>-Xxew</argument>
<argument>-Xfluent-api</argument>
<argument>-Xjaxbindex</argument>
<argument>-Xequals</argument>
<argument>-XhashCode</argument>
<argument>-XtoString</argument>
<argument>-Xcopyable</argument>
<argument>-Xmergeable</argument>
</arguments>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>com.github.jaxb-xew-plugin</groupId>
<artifactId>jaxb-xew-plugin</artifactId>
<version>1.10</version>
</dependency>
<dependency>
<groupId>net.java.dev.jaxb2-commons</groupId>
<artifactId>jaxb-fluent-api</artifactId>
<version>2.1.8</version>
</dependency>
<dependency>
<groupId>org.jvnet.jaxb2_commons</groupId>
<artifactId>jaxb2-basics</artifactId>
<version>0.12.0</version>
</dependency>
</dependencies>
</plugin>
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
"action"
})
@XmlRootElement(name = "TEST")
public class TEST implements Cloneable, CopyTo2, Equals2, HashCode2, MergeFrom2, ToString2
{
@XmlElement(required = true)
protected List<Action> action;
public List<Action> getAction() {
if (action == null) {
action = new ArrayList<Action>(); // <--- **This should have been LinkedList**
}
return this.action;
}
如您所見, ArrayList
類型仍在出現,而不是LinkedList
。 實際上似乎xew
參數和命令被完全忽略了......我沒有收到任何錯誤
我已經嘗試了許多變體,幾乎在我邏輯上想到的每個位置組合中復制和粘貼xs:annotation
簡介。 我得到的唯一錯誤是在這里:
<xs:element name="TEST">
<xs:complexType>
<xs:choice>
<xs:element name="action" type="xs:token" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<xew:xew collection="java.util.LinkedList"
collectionInterface="java.util.List"
instantiate="lazy"
plural="true"/>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
此組合導致: com.sun.istack.SAXParseException2: compiler was unable to honor this xew customization. It is attached to a wrong place, or its inconsistent with other bindings.
com.sun.istack.SAXParseException2: compiler was unable to honor this xew customization. It is attached to a wrong place, or its inconsistent with other bindings.
您是否看到任何丟失的步驟會導致我的自定義集合覆蓋不會被選中?
我附上了 Maven 調試輸出,要瀏覽很多東西,我沒有在那里找到任何提示。 mvn-debug.log
從 XSD 生成 Java 對象時,是否有另一種使用自定義 List 類型的方法?
(PS。我在 jaxb-xew-plugin 的 github 部分交叉發布了這個,但是我意識到最后一次提交是在 2 年前,所以它可能是一個休眠項目。在 SOF 社區中發帖尋求幫助)
您必須自定義 JAXB 綁定。 所以在你的項目目錄中,比如src/main/xjb
,創建一個這樣的文件(注意collectionType
):
<bindings version="2.0" xmlns="http://java.sun.com/xml/ns/jaxb">
<globalBindings collectionType="java.util.Linkedlist"/>
</bindings>
這將全局自定義 Java 類型(針對所有模式中的所有元素)。
如果您只想為特定元素(例如您的案例中的action
元素)進行自定義,請改為像這樣指定元素的架構位置和 XPath(例如,假設 xsd 是src/main/xsd
文件夾):
<bindings version="2.0" xmlns="http://java.sun.com/xml/ns/jaxb" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<bindings schemaLocation="../xsd/schema.xsd" node="//xs:element[@name='action']">
<property collectionType="java.util.LinkedList" />
</bindings>
</bindings>
然后在 POM 中的 jaxb2 maven 插件配置中使用它:
...
<configuration>
<sources>src/main/xsd</sources>
<xjbSources>
<xjbSource>src/main/xjb</xjbSource>
</xjbSources>
...
</configuration>
...
XML 模式沒有被修改,並且保持平台/語言獨立,因為它應該是。
在您提供的 XSD 范圍內,自定義確實有意義。 您需要了解 Xew 插件的作用:如果類型 A 有一些像我們示例中的類型 TEST 那樣復雜的字段,那么我們有一個“matroska”A→TEST→List,在這種情況下,插件會嘗試從其中刪除類型 TEST該模型。 現在您在示例中只提供了 TEST,這只是故事的一半,插件在這種情況下不做任何事情。 您還需要提供另一種使用 TEST 的類型 A,例如:
<xs:element name="A">
<xs:complexType>
<xs:sequence>
<xs:element ref="TEST">
<xs:annotation>
<xs:appinfo>
<xew:xew collection="java.util.LinkedList"
collectionInterface="java.util.List"
instantiate="lazy"
plural="true"/>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="TEST">
<xs:complexType>
<xs:sequence>
<xs:element name="action" type="xs:token" minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
</xs:element>
這就是插件開啟的地方。 您將在輸出中看到:
[INFO] Modifications:
[INFO] Replacing field [TEST com.tug.data.model.gen.A#test]
[INFO] 1 modification(s) to original code.
[INFO]
[INFO] Deletions:
[INFO] Removing class com.tug.data.model.gen.TEST from package com.tug.data.model.gen
[INFO] Removing factory method [com.tug.data.model.gen.TEST#createTEST()] from com.tug.data.model.gen.ObjectFactory
[INFO] 2 deletion(s) from original code.
結果類將是(我刪除了無關的人員):
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
"tests"
})
@XmlRootElement(name = "A")
public class A implements Cloneable, CopyTo2, Equals2, HashCode2, MergeFrom2, ToString2
{
@XmlElementWrapper(name = "TEST", required = true)
@XmlElement(name = "action")
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
protected List<String> tests;
public List<String> getTESTS() {
if (tests == null) {
tests = new LinkedList<String>();
}
return tests;
}
public void setTESTS(List<String> tests) {
this.tests = tests;
}
public A withTESTS(String... values) {
if (values!= null) {
for (String value: values) {
getTESTS().add(value);
}
}
return this;
}
public A withTESTS(Collection<String> values) {
if (values!= null) {
getTESTS().addAll(values);
}
return this;
}
public A withTESTS(List<String> tests) {
setTESTS(tests);
return this;
}
...
}
這就是LinkedList
彈出的地方。
所以插件不會修改 TEST 類型。 基本上,該政策將是“刪除或不理會它”。 如果要自己自定義類型 TEST ,則需要使用原生JAXB 自定義 collectionType :
<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema jaxb:version="2.0"
xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<xs:element name="TEST">
<xs:complexType>
<xs:sequence>
<xs:element name="action" type="xs:token" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<jaxb:property collectionType="java.util.LinkedList" />
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.