如何使用JAXB XJC从外部XSD文件生成类

Question

我有两个项目：

/src/main/resources/schema.xsd pom.xml

B / src / main / gen pom.xml

我想在B项目中生成来自XSD的类，它存在于A Project中

在B项目的pom.xml中我有：

<dependencies>
    <dependency>
        <groupId>test</groupId>
        <artifactId>A</artifactId>
        <version>${project.version}</version>
    </dependency>
</dependencies>
<build>
    <plugins>
       <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>jaxb2-maven-plugin</artifactId>
        <executions>
            <execution>
                <id>xjc</id>
                <goals>
                    <goal>xjc</goal>
                </goals>
            </execution>
            </executions>
            <configuration>
                <schemaDirectory>src/main/resources</schemaDirectory>
                <outputDirectory>src/main/gen</outputDirectory>
            </configuration>
        </plugin>
    </plugins>

</build>

但是在类路径中找不到xsd文件：

无法在项目B上执行目标org.codehaus.mojo：jaxb2-maven-plugin：1.5：xjc（xjc）：未找到任何模式

如何使用其他项目的xsd？

Answer 1

我的maven-jaxb2-plugin支持单独的模式编译 。

这个怎么做：

• 添加您的神器a作为插曲。
• 如果将a.xsd导入b.xsd ，则在编译b时必须使此架构可用于JAXB：
  • 一种方法是使用Maven依赖插件从工件a提取a.xsd 。
  • 另一种方法是使用目录文件将a.xsd的位置重写为工件a

例如，请参阅此测试项目 。

项目a完全不引人注目。 只需编译模式a.xsd 。

项目b更有趣。 让我们来看看。

pom.xml ：

        <plugin>
            <groupId>org.jvnet.jaxb2.maven2</groupId>
            <artifactId>maven-jaxb2-plugin</artifactId>
            <configuration>
                <catalog>src/main/resources/catalog.cat</catalog>
                <episodes>
                    <episode>
                        <groupId>org.jvnet.jaxb2.maven2</groupId>
                        <artifactId>maven-jaxb2-plugin-tests-MAVEN_JAXB2_PLUGIN-82-a</artifactId>
                    </episode>
                </episodes>
            </configuration>
        </plugin>

配置说使用工件a作为剧集。 因此，当JAXB / XJC满足在a编译的类时，它将重用它们而不是生成新的类。

顺便说一句，您可以使用useDependenciesAsEpisodes而不是配置单个剧集。 在这种情况下，所有依赖关系都将被视为剧集，非常方便（配置较少）。

配置还说要使用目录文件 ：

REWRITE_SYSTEM "http://www.ab.org" "maven:org.jvnet.jaxb2.maven2:maven-jaxb2-plugin-tests-MAVEN_JAXB2_PLUGIN-82-a:jar::!"

这指示JAXB / XJC重写从http://www.ab.org开始的所有模式URL，以maven:org.jvnet.jaxb2.maven2:maven-jaxb2-plugin-tests-MAVEN_JAXB2_PLUGIN-82-a:jar::!开头maven:org.jvnet.jaxb2.maven2:maven-jaxb2-plugin-tests-MAVEN_JAXB2_PLUGIN-82-a:jar::! 代替。 后者将被处理的maven-jaxb2-plugin和最终解决在资源a 。

让我们仔细看看。 模式b.xsd 导入http://www.ab.org/a.xsd ：

<import namespace="urn:a" schemaLocation="http://www.ab.org/a.xsd"/>

这将被重写为maven:org.jvnet.jaxb2.maven2:maven-jaxb2-plugin-tests-MAVEN_JAXB2_PLUGIN-82-a:jar::!/a.xsd将解析为JAR中的a.xsd项目a 。 因此，最后，JAXB / XJC将能够从a的JAR工件中读取此模式。

您还可以使用PUBLIC而不是REWRITE_SYSTEM来引用每个名称空间URI的a.xsd而不是模式位置（这在逻辑上更好）：

PUBLIC "urn:a" "maven:org.jvnet.jaxb2.maven2:maven-jaxb2-plugin-tests-MAVEN_JAXB2_PLUGIN-82-a:jar::!/a.xsd"

但是，如果在xs:import有schemaLocation ，则JAXB / XJC中存在一个错误 。

这可以在当下工作：

<xsd:import namespace="urn:a"/>

目前这不起作用：

<xsd:import namespace="urn:a" schemaLocation="a.xsd"/>

我已向Oracle发送了拉取请求 ，该请求修复了该请求 ，但尚未应用。

上面的解释适用于maven-jaxb2-plugin ，适用于0.10.0及更高版本。

您最初的问题是来自Codehaus的jaxb2-maven-plugin ，它是一个不同的Maven插件。 这个插件没有我上面描述的所有功能，但至少剧集应该通过参数工作。 目录也必须有效，但我相信， jaxb2-maven-plugin不支持在Maven工件中解析模式。 您可以使用maven-dependency-plugin从工件a提取a.xsd 。

免责声明：我是maven-jaxb2-plugin 。

审核人员注意：我不打算推​​广/宣传我的插件，我只想提出问题的解决方案。 而且我的项目似乎提供了最好/最优雅和完整的解决方案。

Answer 2

此配置的问题是<schemaDirectory>需要File名/路径。 关于File的事情是它在文件系统上查找文件，从当前工作目录中搜索。 在这种情况下项目根。 但是项目A的资源不在项目B的src/main/resources中。它是一个类路径资源，其中（当在maven中构建时）， src/main/resources甚至不再存在。

我从来没有尝试过使用jaxb2-maven-plugin ，所以我不确定它是否可行。

但是使用maven-jaxb2-plugin ，它允许从Maven工件编译模式 。 你可能会这样

<plugin>
    <groupId>org.jvnet.jaxb2.maven2</groupId>
    <artifactId>maven-jaxb2-plugin</artifactId>
    <version>0.9.0</version>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <schemas>
            <schema>
                <dependencyResource>
                    <groupId>projecta.groupid</groupId>
                    <artifactId>project-a</artifactId>
                    <version>${project.version}</version>
                    <resource>/schema.xsd</resource>
                </dependencyResource>
            </schema>
        </schemas>
        <generateDirectory>src/main/gen/</generateDirectory>
        <generatePackage>mypackage</generatePackage> 
    </configuration>
</plugin>

在这种情况下，它的资源（schema.xsd）位于项目A的src/main/resources中。该插件将生成类文件到mypackage包并获取src/main/gen

Answer 3

我们也可以在pom.xml文件中使用如下

        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>jaxb2-maven-plugin</artifactId>
            <version>1.5</version>
            <executions>
                <execution>
                    <id>id1</id>
                    <goals>
                        <goal>xjc</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>src/main/java</outputDirectory>
                        <clearOutputDir>false</clearOutputDir>
                        <packageName>com.subu.xsd.model</packageName>
                        <schemaDirectory>src/main/java/schemadir</schemaDirectory>
                        <schemaFiles>XYZ.xsd</schemaFiles>
                    </configuration>
                </execution>
            </executions>
        </plugin>