如何强制架构编译的类将特定类扩展到架构之外

Question

以下情况需要帮助： 用户可以生成自己的数据结构，这些数据结构存储为 JAXB 就绪的 XSD 源，如下所示：

<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="Group" type="Group"/>
  <xs:element name="Parameter" type="Parameter"/>

  <xs:complexType name="Group">
    <xs:sequence>
      <xs:element name="caption" type="xs:string" minOccurs="0"/>
      <xs:element name="parameters" type="Parameter" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="Parameter">
    <xs:sequence>
      <xs:element name="key" type="xs:string" minOccurs="0"/>
      <xs:element name="group" type="Group" minOccurs="0"/>
      <xs:element name="value" type="xs:string" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

新的或修改后的模式出现后，模式编译器会自动解析它，生成 Java 源，编译并打包到用户 jar 中：

  SchemaCompiler sc = XJC.createSchemaCompiler();
  // Input source for schema
  InputSource is = new InputSource(new StringInputStream(objectPackage.getObjectSchema()));
  // Parse
  sc.parseSchema(is);
  S2JJAXBModel model = sc.bind();
  // Generate source
  JCodeModel jCodeModel = model.generateCode(null, null);
  jCodeModel.build(packageSourceDirectory);
  // Compile and package 
  // ......

一切都很好，直到决定所有用户生成的类都必须扩展一个特定的已知类，例如 UserRootObject：

package user.abc;
public class Group extends com.mycompany.xml.UserRootObject {
  //
}

并且

package user.abc;
public class Parameter extends com.mycompany.xml.UserRootObject {
  //
}

一切都是动态的，我不能强迫用户修改他们的模式文件，但我可以在之前转换它们代码生成。 看起来我有两个选项来引入 UserRootObject：以某种方式通过 JCodeModel 或在构建 Java 源之前以某种方式转换模式文件。

Answer 1

XJC 有一个用于此目的的扩展

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
           xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
           jaxb:extensionBindingPrefixes="xjc"
           jaxb:version="2.0">

    <xs:annotation>
       <xs:appinfo>
          <jaxb:globalBindings>
           <xjc:superClass name="com.mycompany.xml.UserRootObject"/>
          </jaxb:globalBindings>
       </xs:appinfo>
    </xs:annotation>
.
.
.
</xs:schema>

有关详细信息，请参阅：

• http:// jaxb.java.net/nonav/2.0.2/docs/vendorCustomizations.html

模式注释也可以通过外部绑定文件提供。有关示例，请参阅：

• 如何自定义 JAXB 生成方式复数方法名称？

Answer 2

非常感谢 D.Shawley 指出 JSR 222 中的正确部分。这是最终的解决方案，可能对其他人有帮助并节省时间。
原始模式必须按如下方式进行转换：

    <xs:schema version="1.0" 
               xmlns:xs="http://www.w3.org/2001/XMLSchema" 
               xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" 
               jaxb:version="2.0" >

      <xs:element name="Group" type="Group"/>
      <xs:element name="Parameter" type="Parameter"/>


      <xs:complexType name="Group">
        <xs:complexContent>
          <xs:extension base="UserRootObject">
            <xs:sequence>
            <!-- params -->
            </xs:sequence>
          </xs:extension>
        </xs:complexContent>
      </xs:complexType>

      <xs:complexType name="Parameter">
        <xs:complexContent>
          <xs:extension base="UserRootObject">
            <xs:sequence>
            <!-- params -->
            </xs:sequence>
          </xs:extension>
        </xs:complexContent>
      </xs:complexType>

      <xs:complexType name="UserRootObject">
        <xs:annotation>
          <xs:appinfo>
            <jaxb:class name="UserRootObject" implClass="com.mycompany.xml.UserRootObject"/>
          </xs:appinfo>
        </xs:annotation>
      </xs:complexType>
    </xs:schema>

可以通过 org.w3c.dom.Document 接口轻松执行转换。

Answer 3

我不认为使用 JAXB 本身有一种简单的方法可以做到这一点。有许多不为人所知的可用自定义选项 - 请阅读 JSR222 第 7 节 详细信息。

如果您对输入模式有一定的控制，那么您可能需要考虑使用 XSLT 来转换模式。我相信这可以通过使用 javax.xml.transform.dom.DOMResult 实例作为转换的目标并将输出用作 DOM 树（例如，调用 getNode( ) 结果）作为 parseSchema 的输入。一个基本的转换是将： 替换

<xs:complexType name="foo">
  <!-- CONTENTS -->
</xs:complexType>

为：

<xs:complexType name="foo">
  <xs:complexContent>
    <xs:extension base="UserRootObject">
      <!-- CONTENTS -->
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

当然，这仅适用于简单的情况。如果您的模式文件中已经具有继承，那么您将必须在 XSLT 中进行一些过滤，仅将此转换应用于尚未扩展的类型。

Answer 4

这是一个有点老的话题，但只是为了记录：

您可以使用 jaxb2 继承插件来做到这一点。像这样：

<xs:complexType name="...">
  <xs:annotation>
    <xs:appinfo>
      <inheritance:extends>
         com.mycompany.xml.UserRootObject
      </inheritance:extends>
    </xs:appinfo>
  </xs:annotation>
  <!-- ... -->
</xs:complexType>

参见这里的示例 http:// /vistaofjavahorizo​​n.blogspot.com/2014/07/how-to-have-prefer-java-class.html

网上有更多示例。