抑制JAXB生成的类的编译器警告

时间:2014-03-11 01:26:09

标签: java jaxb xjc annox jaxb2-annotate-plugin

这可能是这个问题的重复(Avoiding Compiler warnings on code generated by xjc),但由于我不太熟悉XJC / JAXB自定义绑定的特性,我可能会认为我可能误解了上述问题。

我的问题似乎很简单 - 如何在生成的JAXB类中添加@SuppressWarnings("all")注释?我们的项目有0个警告政策,在JAXB生成步骤之后,我们最终会发出350多个警告,这些警告只是可怕的噪音。

我希望XJC上有一个简单的标志,或者至少是提供此类信息的简单方法,但我找不到任何。

从我在旅行中看到的情况来看,人们会做以下其中一件事:

  1. @ lexicore的JAXB2 Annotate Plugin,根据示例,似乎可以完成这项工作,但是添加一个完整的框架和数百KB的代码只是为了向一堆类添加简单的注释?真??,
  2. 自定义JAXB绑定(我可能会弄错,但这看起来非常晦涩,而且我不确定是否有可能以这种方式执行此操作),
  3. 自定义ANT目标,它将执行搜索和替换后JAXB生成,
  4. Eclipse 4+似乎可以选择过滤掉所选项目的警告,但出于各种历史/遗留原因,我们仍然坚持使用Eclipse 3.7.2(Indigo),
  5. 自定义XJC插件,可以进行注释插入(如其中一位评论者所建议,请参阅here),
  6. 将所有生成的类放在JAR中,使JAR成为项目的依赖项,然后完全删除生成的代码。
  7. 以前,我们通过在单独的Eclipse项目中推送与XML相关的代码然后禁用项目上的警告/错误来解决这个问题。现在,作为代码整合/重构的一部分,我们已经重新调整了一些东西,不再拥有这种奢侈品。

    对于这样一个看似微不足道的问题,真的没有优雅的解决方案吗?任何反馈/想法都非常感谢。

    FWIW,我们的项目使用Ant作为构建系统。

2 个答案:

答案 0 :(得分:7)

您必须使用此插件:jaxb2-annotate-plugin

2个解决方案:

1 - 修改你的xsd并添加这种块

<xsd:element name="foobar" type="xsd:string">
    <xsd:annotation>
        <xsd:appinfo>
            <annox:annotate>@java.lang.SuppressWarnings("all")</annox:annotate>
        </xsd:appinfo>
    </xsd:annotation>
</xsd:element>

2 - 创建自定义绑定

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jaxb:bindings
    xmlns:jaxb="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:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:annox="http://annox.dev.java.net"
    xsi:schemaLocation="http://java.sun.com/xml/ns/jaxb http://java.sun.com/xml/ns/jaxb/bindingschema_2_0.xsd"
    jaxb:extensionBindingPrefixes="xjc annox"
    version="2.1">
    <jaxb:bindings schemaLocation="schema.xsd" node="/xs:schema">
        <annox:annotate target="class">@java.lang.SuppressWarnings("all")</annox:annotate>
    </jaxb:bindings>
</jaxb:bindings>

答案 1 :(得分:5)

免责声明:我是@ToYonos答案中提到的jaxb2-annotate-plugin的作者。

这不是一个独立的答案,而是@ToYonos答案的补充。

我想从问题中解决以下几点。

  
      
  1. 来自Atlassian的JAXB2 Basics框架/项目的Annox插件(根据示例,似乎可以完成工作但是添加一个整体   框架和数百KB的代码只是为了添加简单的注释   一堆课?真的?),
  2.   

我只需要添加一些注释:

  • 首先,这不是&#34; Atlassian&#34;&#34;框架/项目。我既不是员工,也不是Atlassian或Sun或Oracle的附属机构(尽管我是Sun / Oracle的正式撰稿人)。这是一个独立的开源项目,不是由任何公司驱动的。
  • 接下来,jaxb2-annotate-plugin已移至standalone project,它不再是JAXB2 Basics的一部分。它太大了,应该是一个独立的东西。
  • 关于&#34;一个完整的框架和数百KB的代码&#34;。
    • jaxb2-annotate-plugin不需要或在代码中添加任何运行时依赖项。如果注释具有运行时保留,那么您在运行时需要注释的类,但它应该是显而易见的。
    • jaxb2-annotate-plugin确实有许多编译时依赖项,如,用于解析Java语法中的注释。嗯,这是因为插件必须执行许多适度高级的操作,例如从Java语法解析注释并将它们转换为以添加到生成的代码中。我个人认为在编译时几百个文件根本就不是问题。

所以,从我的观点来看,@ Tooonos目前提供了一个合理的解决方法


现在,正确的修复如何?

  • 正确的解决方法是修复XJC。其他一切只是一种解决方法。
  • 此问题存在JAXB-1053问题。 Iaroslav正确地指出,只要必须支持1.6,就不能应用钻石修复。
  • 还必须更新CodeModel以支持Java 7+构造。
  • 您可以通过分叉并向XJC代码on GitHub提供PR来提供帮助。但是我不能说PR确实应用了。我的PR有三个in the pipeline,已经有一个月左右了。
  • 可以编写一个覆盖代码生成的XJC插件。这不容易,但可能。

正确的修复程序看起来不是一件容易的事,我选择了解决方法并暂时等待供应商修复。