生成实现接口的JAXB类

Question

我当前正在使用JAXB生成Java类，以解组XML。 现在，我想创建一个与第一个非常相似的新模式，并让生成的类实现相同的接口。

举例来说，我有两个模式文件，它们定义带有类似标签的XML：

成人版

<?xml version="1.0" encoding="UTF-8"?>
<xs:element name="Person">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="Name" type="xs:string" />
      <xs:element name="Age" type="xs:integer" />
      <xs:element name="Job" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
</xs:element>

小子

<?xml version="1.0" encoding="UTF-8"?>
<xs:element name="Person">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="Name" type="xs:string" />
      <xs:element name="Age" type="xs:integer" />
      <xs:element name="School" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
</xs:element>

我想使用JAXB和XJC生成两个类文件：

public class Adult implements Person {
    ...
    public String getName() { ... }
    public int getAge() { ... }
    public String getJob { ... }
}

public class Kid implements Person {
    ...
    public String getName() { ... }
    public int getAge() { ... }
    public String getSchool { ... }
}

Person接口定义了getName()和getAge()方法。

我看过一些映射接口的文档 ，但这似乎仅适用于已经具有要映射到DOM的Java类的情况。

另外，我尝试使用此外部插件，但似乎不起作用。 这是我的xjb绑定文件：

<jxb:bindings version="1.0" 
  xmlns:jxb="http://java.sun.com/xml/ns/jaxb" 
  xmlns:xs="http://www.w3.org/2001/XMLSchema" 
  xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
  xmlns:ext="http://xml.w-wins.com/xjc-plugins/interfaces"
  jxb:extensionBindingPrefixes="xjc">

    <jxb:bindings schemaLocation="xsd/adult.xsd" node="xs:schema/xs:complexType[@name='Person']">
        <ext:interface>mypackage.Hello</ext:interface> 
    </jxb:bindings>

</jxb:bindings>

但这会产生以下错误：

$ java -cp "lib/activation.jar;lib/InterfacesXJCPlugin.jar;lib/jaxb1-impl.jar;lib/jaxb-api.jar;lib/jaxb-xjc.jar;lib/jsr173_1.0_api.jar" com.sun.tools.xjc.XJCFacade -p mypackage.myxml -extension -Xinterfaces xsd/adult.xsd -b binding.xjb
parsing a schema...
[ERROR] XPath evaluation of "xs:schema/xs:complexType[@name='Person']" results in empty target node
  line 8 of file:/C:/dev/jaxb/jaxb-ri/binding.xjb

Failed to parse a schema.

是否可以用JAXB生成一个实现接口的类？

更新资料

我尝试使用接口插入插件，但由于某种原因无法使其正常工作。 这就是我调用xjc的方式，就好像没有从类路径中获取插件jar一样：

$ java -cp "lib/xjc-if-ins.jar;lib/jaxb-xjc.jar" com.sun.tools.xjc.XJCFacade -p mypackage -extension -Xifins myschema.xsd -b binding.xjb

我收到错误：

unrecognized parameter -Xifins

有任何想法吗？

Answer 1

不幸的是，其他答案中提到的接口注入插件似乎不再受支持。 实际上，我很难找到要下载的JAR。

幸运的是， JAXB2 Basics插件提供了一种类似的机制，用于将接口添加到生成的JAXB存根（请参阅Inheritance plugin ）。

继承插件文档中有一个示例，显示了XML模式文件的外观。 但是，由于无法修改架构，因此可以使用外部绑定文件：

<?xml version="1.0"?>
<jxb:bindings version="1.0" 
  xmlns:jxb="http://java.sun.com/xml/ns/jaxb" 
  xmlns:xs="http://www.w3.org/2001/XMLSchema" 
  xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
  xmlns:inheritance="http://jaxb2-commons.dev.java.net/basic/inheritance"
  jxb:extensionBindingPrefixes="xjc">

    <jxb:bindings schemaLocation="xsd/adult.xsd">
      <jxb:bindings node="//xs:complexType[@name='Person']">
        <inheritance:implements>mypackage.Hello</inheritance:implements> 
      </jxb:bindings>
    </jxb:bindings>

</jxb:bindings>

JAXB2 Basics插件文档包括将插件与Ant和Maven一起使用的说明。 您也可以从命令行直接使用它，但是命令有点混乱（由于必须添加到类路径中的jar数量）：

java -jar jaxb-xjc.jar 
     -classpath jaxb2-basics-0.5.3.jar,jaxb2-basics-runtime-0.5.3.jar,
                jaxb2-basics-tools-0.5.3.jar,commons-beanutils-0.5.3.jar,
                commons-lang.jar,commons-logging.jar
     -p mypackage.myxml -extension -Xinheritance xsd/adult.xsd -b binding.xjb

JAXB2 Basics插件提供了许多其他实用程序，您可能还会发现它们有用（例如，自动生成equals，hashCode和toString方法）。

Answer 2

对于您的情况，这可能有些过分，但是我已经使用AspectJ做到了这一点（我们已经在该项目上使用了方面，因此我们已经有了依赖关系和公开性）。

您可以按照以下方式声明一个方面：

public aspect MyAspect
{
    declare parents: 
        com.foo.generated.Adult
    implements com.foo.Person;

    declare parents: 
        com.foo.generated.Kid
    implements com.foo.Person;
}

它将接口com.foo.Person添加到com.foo.generated.Adult和com.foo.generated.Kid类中

可能出于您的目的而过度使用，但这对我们有用。

Answer 3

对我有用的答案是Jim Hurne的使用JAXB2 Basics插件的示例。 但是他链接的文档似乎不再可用，因此仅供参考，这是我配置Maven插件的方式：

        <plugin>
            <groupId>org.jvnet.jaxb2.maven2</groupId>
            <artifactId>maven-jaxb2-plugin</artifactId>
            <version>0.8.2</version>
            <executions>
                <execution>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                    </execution>
            </executions>
            <configuration>
                <extension>true</extension>
                <args>
                    <arg>-Xinheritance</arg>
                </args>
                <bindingDirectory>src/main/resources/xjb</bindingDirectory>
                <bindingIncludes>
                    <include>**.xml</include> <!-- This Should reference the binding files you use to configure the inheritance -->
                </bindingIncludes>
                <schemaDirectory>src/main/resources/xsd</schemaDirectory>
                <generateDirectory>${project.build.directory}/generated-sources/jaxb</generateDirectory>
                <generatePackage>mypackage</generatePackage>
                <plugins>
                    <plugin>
                        <groupId>org.jvnet.jaxb2_commons</groupId>
                        <artifactId>jaxb2-basics</artifactId>
                        <version>0.5.3</version>
                    </plugin>
                </plugins>
            </configuration>
        </plugin>

Answer 4

对于这种简单情况，无需使用JAXB RI供应商扩展 xjc：superInterface定制即可使用第3方插件即可实现。 应当注意，这种方法将导致所有生成的类都实现该接口。

绑定文件示例：

<jxb:bindings version="1.0" 
  xmlns:jxb="http://java.sun.com/xml/ns/jaxb" 
  xmlns:xs="http://www.w3.org/2001/XMLSchema" 
  xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc" 
  jxb:extensionBindingPrefixes="xjc">
    <jxb:bindings schemaLocation="adult.xsd" node="/xs:schema">
    <jxb:globalBindings>
        <xjc:superInterface name="com.example.model.Person"/>
    </jxb:globalBindings>
    </jxb:bindings>
</jxb:bindings>

然后，您只需要运行xjc即可指定绑定文件并设置-extension标志。 比引入JAXB2Basics更快/更简单！

最初，我怀疑这是否可以按照文档所述进行工作：

通过自定义，您可以指定Java接口的标准名称，该名称将用作所有生成的接口的根接口。 除非您使用globalBindings generateValueClass =“ false”开关专门生成接口，否则此定制无效。

但是，当我尝试使用与上述绑定类似的绑定（未指定generateValueClass =“ false”并生成类而不是接口）时，它给了我所需的输出-我所有生成的类都实现了公共接口。

Answer 5

在我的情况下，通过java -jar进行的命令行调用有效：

java -jar $somepath/jaxb-xjc.jar -classpath $somepath/xjc-if-ins.jar my.xsd -d $destdir -b $bindingconfig -p $desiredpackage -extension -Xifins

但是，执行xjc蚂蚁任务时，该错误仍然存​​在。 给出的错误消息令人不安，因为在我看来，真正的原因是ant试图加载的类文件中的版本号错误（请参见下面的stacktrace）。 仅当您将以下内容添加到ANT_OPTS时，才会出现此正确的错误消息： -Dcom.sun.tools.xjc.Options.findServices=true

[xjc] java.lang.UnsupportedClassVersionError: Bad version number in .class file
[xjc]     at java.lang.ClassLoader.defineClass1(Native Method)
[xjc]     at java.lang.ClassLoader.defineClass(ClassLoader.java:620)
[xjc]     at org.apache.tools.ant.AntClassLoader.defineClassFromData(AntClassLoader.java:1134)
[xjc]     at org.apache.tools.ant.AntClassLoader.getClassFromStream(AntClassLoader.java:1320)
[xjc]     at org.apache.tools.ant.AntClassLoader.findClassInComponents(AntClassLoader.java:1376)
[xjc]     at org.apache.tools.ant.AntClassLoader.findClass(AntClassLoader.java:1336)
[xjc]     at org.apache.tools.ant.AntClassLoader.loadClass(AntClassLoader.java:1074)
[xjc]     at java.lang.ClassLoader.loadClass(ClassLoader.java:299)
[xjc]     at java.lang.ClassLoader.loadClass(ClassLoader.java:251)
[xjc]     at com.sun.tools.xjc.Options.findServices(Options.java:936)
[xjc]     at com.sun.tools.xjc.Options.getAllPlugins(Options.java:336)
[xjc]     at com.sun.tools.xjc.Options.parseArgument(Options.java:632)
[xjc]     at com.sun.tools.xjc.Options.parseArguments(Options.java:742)
[xjc]     at com.sun.tools.xjc.XJC2Task._doXJC(XJC2Task.java:444)
[xjc]     at com.sun.tools.xjc.XJC2Task.doXJC(XJC2Task.java:434)
[xjc]     at com.sun.tools.xjc.XJC2Task.execute(XJC2Task.java:369)
[xjc]     at com.sun.istack.tools.ProtectedTask.execute(ProtectedTask.java:55)
[xjc]     at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:291)
[xjc]     at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
[xjc]     at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
[xjc]     at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
[xjc]     at java.lang.reflect.Method.invoke(Method.java:585)
[xjc]     at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:106)
[xjc]     at org.apache.tools.ant.Task.perform(Task.java:348)
[xjc]     at org.apache.tools.ant.Target.execute(Target.java:390)
[xjc]     at org.apache.tools.ant.Target.performTasks(Target.java:411)
[xjc]     at org.apache.tools.ant.Project.executeSortedTargets(Project.java:1360)
[xjc]     at org.apache.tools.ant.Project.executeTarget(Project.java:1329)
[xjc]     at org.apache.tools.ant.helper.DefaultExecutor.executeTargets(DefaultExecutor.java:41)
[xjc]     at org.apache.tools.ant.Project.executeTargets(Project.java:1212)
[xjc]     at org.apache.tools.ant.Main.runBuild(Main.java:801)
[xjc]     at org.apache.tools.ant.Main.startAnt(Main.java:218)
[xjc]     at org.apache.tools.ant.launch.Launcher.run(Launcher.java:280)
[xjc]     at org.apache.tools.ant.launch.Launcher.main(Launcher.java:109)
[xjc]
[xjc] failure in the XJC task. Use the Ant -verbose switch for more details

Answer 6

对于那些希望为更复杂的架构构建JAXB数据绑定文件的人-最新的开源XML工具-CAM Editor v2.2现在支持此功能。

您可以访问资源和下载站点，以获取逐步指南，并查看该工具页面顶部的下载部分。

http://www.cameditor.org/#JAXB_Bindings

请享用。

Answer 7

interface-insertion插件的文档建议以下内容

[要从命令行使用接口插入插件调用xjc，您可以编写：

java -cp $JAXB_HOME/share/lib/xjc-if-ins.jar -extension -Xifins schema

]

我猜您正在调用错误类的主要方法-com.sun.tools.xjc.XJCFacade。 您可能应该使用确切的语法重试。

这是另一个讨论类似问题的论坛上的链接。 http://forums.java.net/jive/message.jspa?messageID=220686

• 我本来可以将其发布为评论，但是我没有足够的观点发表评论。

Answer 8

某种描述的XJC插件可以解决您的问题，这只是找到一个可行的问题。 对于他们来说，最好的来源是：

https://jaxb2-commons.dev.java.net/

特别是，这一个：

https://jaxb2-commons.dev.java.net/interface-insertion/