从XJC输出中省略@XmlSeeAlso

时间:2011-08-17 11:55:53

标签: java jaxb xjc

目前,我正忙于使用XML消息传递的项目。我有一个通用模式,具有抽象类型和一些可重用的类型定义和元素。对于我正在处理的每种消息,都有一个单独的模式(具有不同的目标名称空间),用于导入常规模式。换句话说,它是一个两级层次结构。很简单。

这些模式中的每一个都用于生成Java类。每个模式对应一个包。代码生成由Maven JAXB 2.1插件处理。当我使用代码时,我为每种消息类型创建一个单独的JAXBContextJAXBContext是使用通用模式的包名称和特定消息类型的包名称创建的,因此上下文应该只能看到它必须处理的那些类。

令我惊讶的是,我注意到当我将XML文档解组为bean然后将这些文档封送回XML时,每个消息类型(= schema schema namespace)都有名称空间声明。想知道JAXB如何在上下文范围内获得该信息,我发现一些@XmlSeeAlso注释被放置在一些抽象类定义上。这会导致JAXB查找有关目标包之外的类的信息。

有没有办法避免生成@XmlSeeAlso注释?环顾四周,我发现这是JAXB 2.1的新功能。我可以切换到2.0的XJC插件,但我不确定这是否会产生不必要的副作用。另外,我希望将来继续关注新的JAXB版本。不需要的命名空间声明不是问题(XML仍然有效),但是一旦添加了更多的消息类型,将会引起混淆。此外,这清楚地表明我的JAXB上下文加载了比我想象的更多的类,并且基本上是相互重复的。我可以使用包含所有内容的一个上下文,但我已经围绕这种分离建立了自己的API。

感谢阅读和提供的任何答案。

2 个答案:

答案 0 :(得分:4)

使用父模式和子模式的单独编译。

如果单独编译父模式(在上下文中不包括子模式),@XmlSeeAlso注释和{@link ChildType}将仅引用该模式及其父模式中的JAXB类。这实现了父/子模式的明确分离。

使用 maven-jaxb2-plugin ,这可以通过限制包含的模式来实现。假设您在 src / xsd 文件夹中有模式 A.xsd B.xsd ,其中 B.xsd 导入具有不同命名空间的 A.xsd 。要仅生成父( A.xsd ),请使用以下配置:

<plugin>
  <groupId>org.jvnet.jaxb2.maven2</groupId>
  <artifactId>maven-jaxb2-plugin</artifactId>
  <version>0.8.2</version>
  <executions>
    <execution>
      <goals>
        <goal>generate</goal>
      </goals>
      <configuration>
        <schemaDirectory>${project.basedir}/src/xsd</schemaDirectory>
        <schemaIncludes>
          <include>A.xsd</include>
        </schemaIncludes>
        <episode>true</episode>
      </configuration>
    </execution>
  </executions>
</plugin>

这将为 A.xsd 生成JAXB类,而不会引用子模式 B.xsd 中的元素。

由于<episode>true</episode>,它还会生成 META-INF / sun-jaxb.episode 文件,您可以在generate the child schemas时参考该文件。

或者,当您生成子模式时(再次为每个模式使用单独的编译),如果您不想使用 episode 方式,则可以删除父包。您可以使用 maven-clean-plugin maven-antrun-plugin 删除子代的额外父包。我在剧集时遇到了一些麻烦 - 为孩子们生成了一个额外的ObjectFactory课程 - 所以我用这种方式来实现我想要的结构。

需要注意的另一件事是生成的类中的JAXBElement<? extends ParentType>引用。如果你进行单独的编译,XJC将不知道可能的替换组(如果我没有弄错......),并且可能只生成ParentType引用。因此,如果您需要JAXBElement引用,请将<jaxb:property generateElementProperty="true" />属性添加到您的架构或该引用的绑定。

答案 1 :(得分:1)

我有同样的问题,我认为没有一个简单的答案。我找到了com.sun.tools.xjc.generator.bean.BeanGenerator类的源代码,该类似乎负责生成java源代码(jaxb-xjc-2.1.4.jar)。从第496行开始的代码如下所示:

     if(model.options.target.isLaterThan(SpecVersion.V2_1)) {
        // @XmlSeeAlso
        Iterator<CClassInfo> subclasses = cc.target.listSubclasses();
        if(subclasses.hasNext()) {
            XmlSeeAlsoWriter saw = cc.implClass.annotate2(XmlSeeAlsoWriter.class);
            while (subclasses.hasNext()) {
                CClassInfo s = subclasses.next();
                saw.value(getClazz(s).implRef);
            }
        }
    }

XMLSeeAlso注释似乎是硬编码的,不是可选的或可配置的(至少使用JAXB 2.1.4)。

相关问题