在 XSD 中声明不同类型的集合
Declare collection of varying types in XSD
我有一个 API 和 returns 一组 XML 对象,这些对象保证可以用抽象 class 表示,但是它们不能直接表示可作为列表访问,因为它们采用以下形式:
<Response Timestamp="2019-02-06T13:16:32">
<TypeA [xml attributes]...>
...
</TypeA>
<TypeB ...>
...
</TypeB>
... (Different repeating elements)
</Response>
由于公司惯例,我将使用 XSD 为该提要编写模型,该模型由 JaxB 解析以生成源文件。但是,除了将类型单独声明为集合的可能元素(出于明显的原因我不想这样做),我不知道如何处理这个并将响应的子元素作为一个集合。
XSD 回复。
<xs:complexType name="Response">
<xs:sequence>
<xs:element name="Types" type="model:AbstractType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
示例元素类型
public class TypeA extends AbstractType
{
//Generated source
}
我如何在 XSD 中指定任何扩展 AbstractType 的 TypeX 对象应该从响应进入类型集合?
很高兴提供任何必要的进一步信息,只要不是我不允许分享的信息。
看到 相关问题,但是它接受任何元素,并且限制是基于名称的,而为此我理想地想验证收集的元素是有效的 TypeX 对象。
假设您已将每个 TypeX 定义为 XSD 中的 AbstractType 扩展:
<xsd:complexType name="TypeX">
<xsd:complexContent>
<xsd:extension base="AbstractType">
...
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
那么你可以这样做:
1) XSD 选择,如果你真的想为每个 TypeX 使用不同的 XML 元素名称(不推荐,因为无论何时添加新的 AbstractType 子类型都需要修改 Response 类型):
<xs:complexType name="Response">
<xs:choice maxOccurs="unbounded">
<xs:element name="typeA" type="model:TypeA" />
<xs:element name="typeB" type="model:TypeB" />
</xs:sequence>
</xs:complexType>
2) XML 多态性(接近您的建议),虽然更改了 XML 形式,但更通用:
<xs:complexType name="Response">
<xs:sequence>
<xs:element name="something" type="model:AbstractType" minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
(根据 AbstractType 实际代表什么,将 'something' 替换为一些有意义的名称。)
xml 看起来像这样:
<Response Timestamp="2019-02-06T13:16:32" xmlns="...">
<something xsi:type="TypeA" [xml attributes]...>
...
</something>
<something xsi:type="TypeB" ...>
...
</something>
... (Different repeating elements)
</Response>
在这两种情况下,我建议您使用 JAXB RI extension for simpler/better binding mode (§ 3.1.6) 或等效扩展,它可以简化生成的代码并在必要时将生成的字段转换为复数形式。
然后Response中生成的代码class(注意复数形式):
List<AbstractType> somethings;
.
我有一个 API 和 returns 一组 XML 对象,这些对象保证可以用抽象 class 表示,但是它们不能直接表示可作为列表访问,因为它们采用以下形式:
<Response Timestamp="2019-02-06T13:16:32">
<TypeA [xml attributes]...>
...
</TypeA>
<TypeB ...>
...
</TypeB>
... (Different repeating elements)
</Response>
由于公司惯例,我将使用 XSD 为该提要编写模型,该模型由 JaxB 解析以生成源文件。但是,除了将类型单独声明为集合的可能元素(出于明显的原因我不想这样做),我不知道如何处理这个并将响应的子元素作为一个集合。
XSD 回复。
<xs:complexType name="Response">
<xs:sequence>
<xs:element name="Types" type="model:AbstractType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
示例元素类型
public class TypeA extends AbstractType
{
//Generated source
}
我如何在 XSD 中指定任何扩展 AbstractType 的 TypeX 对象应该从响应进入类型集合?
很高兴提供任何必要的进一步信息,只要不是我不允许分享的信息。
看到
假设您已将每个 TypeX 定义为 XSD 中的 AbstractType 扩展:
<xsd:complexType name="TypeX">
<xsd:complexContent>
<xsd:extension base="AbstractType">
...
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
那么你可以这样做:
1) XSD 选择,如果你真的想为每个 TypeX 使用不同的 XML 元素名称(不推荐,因为无论何时添加新的 AbstractType 子类型都需要修改 Response 类型):
<xs:complexType name="Response">
<xs:choice maxOccurs="unbounded">
<xs:element name="typeA" type="model:TypeA" />
<xs:element name="typeB" type="model:TypeB" />
</xs:sequence>
</xs:complexType>
2) XML 多态性(接近您的建议),虽然更改了 XML 形式,但更通用:
<xs:complexType name="Response">
<xs:sequence>
<xs:element name="something" type="model:AbstractType" minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
(根据 AbstractType 实际代表什么,将 'something' 替换为一些有意义的名称。)
xml 看起来像这样:
<Response Timestamp="2019-02-06T13:16:32" xmlns="...">
<something xsi:type="TypeA" [xml attributes]...>
...
</something>
<something xsi:type="TypeB" ...>
...
</something>
... (Different repeating elements)
</Response>
在这两种情况下,我建议您使用 JAXB RI extension for simpler/better binding mode (§ 3.1.6) 或等效扩展,它可以简化生成的代码并在必要时将生成的字段转换为复数形式。
然后Response中生成的代码class(注意复数形式):
List<AbstractType> somethings;
.