如何抑制特定目录或文件（例如生成的代码）的 Java 警告

Question

我正在使用一个解析器生成器，它创建了一些难看的代码。 因此，我的 Eclipse 项目有几十个来自生成的源文件的警告。 我知道我可以使用 @SuppressWarning 注释来抑制特定元素中的特定警告，但是当解析器生成器再次运行时，我手动添加的任何注释都将丢失。 有没有办法配置 Eclipse 以抑制特定文件或目录的警告？

Answer 1

从版本 3.8 M6 开始，Eclipse（确切地说：JDT）为此提供了内置功能。 它可以通过项目的构建路径进行配置：项目属性> Java 构建路径 > 编译器> 来源

此处公布：Eclipse 3.8 和 4.2 M6 - 新增功能和值得注意的，称为有选择地忽略源文件夹中的错误/警告。 这也是屏幕截图的来源。 这是根据之前链接的 Bug 220928 开发的新功能。

Answer 2

有一个针对此问题的票证，Bug 220928，此后已已针对 Eclipse 3.8 完成。 有关详细信息，请参阅此答案。

如果您无法使用 Eclipse 3.7 或更低版本：对该票证进行评论的用户“Marc”在 评论 35。 在等待此功能集成到 Eclipse 中时，我使用它并取得了很大的成功。

这真的很简单：

1. 安装插件。
2. 右键单击项目并选择“添加/删除生成的代码性质”。
3. 打开项目设置（右键单击并选择“属性”）。
4. 打开“警告清洁器”选项卡。
5. 选择您想要忽略警告的源文件夹。

Answer 3

我通过使用 maven regexp 替换插件解决了这个问题 - 它不能解决原因，但可以治愈痛苦：

<plugin>
  <groupId>com.google.code.maven-replacer-plugin</groupId>
  <artifactId>maven-replacer-plugin</artifactId>
  <version>1.3.2</version>
  <executions>
<execution>
  <phase>prepare-package</phase>
  <goals>
    <goal>replace</goal>
  </goals>
</execution>
  </executions>
  <configuration>
<includes>
  <include>target/generated-sources/antlr/**/*.java</include>
</includes>

<regex>true</regex>
<regexFlags>
  <regexFlag>MULTILINE</regexFlag>
</regexFlags>

<replacements>
  <replacement>
    <token>^public class</token>
    <value>@SuppressWarnings("all") public class</value>
  </replacement>
</replacements>
  </configuration>
</plugin>

请注意，我没有设法让 ** 符号起作用，因此您可能必须准确指定路径。

请参阅下面的评论，了解如何不生成重复的 @SupressWarnings 的改进

Answer 4

我认为您能做的最好的事情就是启用项目特定设置来显示警告。

窗口 -> 首选项-> Java-> 编译器-> 错误/警告

表单顶部是用于配置项目特定设置的链接。

Answer 5

用户 @Jorn 暗示 Ant 代码可以做到这一点。 这是我所得到的

<echo>Adding @SuppressWarnings("all") to ANTLR generated parser/lexer *.java</echo>
<echo> in ${project.build.directory}/generated-sources/antlr/</echo>
<replace dir="${project.build.directory}/generated-sources/antlr/" 
         summary="true" 
         includes="**/*.java" 
         token="public class" 
         value='@SuppressWarnings("all") public class' />

请注意，Ant 的是 进行文本替换，而不是正则表达式替换，
因此它不能像 Maven 正则表达式替换插件那样使用令牌中的 ^ 元字符来匹配行首。

我在执行此操作的同时，在 Maven pom 中从 maven-antrun-plugin 运行 Antlr，因为 ANTLR maven 插件与 Cobertura maven 插件不能很好地配合。

（我意识到这不是原始问题的答案，但我无法在评论/回复另一个答案中格式化 Ant 代码，只能在答案中格式化）

Answer 6

我不认为 Eclipse 本质上提供了在目录级别执行此操作的方法（但我不确定）。

您可以将生成的文件放入单独的 Java 项目中，并控制该特定项目的警告。

无论如何，我通常更喜欢将自动生成的代码放在单独的项目中。

Answer 7

您只能在项目级别抑制警告。 但是，您可以配置问题选项卡以抑制来自文件或包的警告。 进入“配置内容”菜单并使用“在工作集：”范围。

Answer 8

这个小 python 脚本“修补”M2E 生成的 .classpath 文件，并将所需的 XML 标记添加到以 target/ generated-sources 开头的所有源文件夹中。 您可以从项目的根文件夹运行它。 显然，当从M2E重新生成Eclipse项目信息时，您需要重新运行它。 显然，一切风险由您自己承担；-)

#!/usr/bin/env python
from xml.dom.minidom import parse
import glob
import os

print('Reading .classpath files...')
for root, dirs, files in os.walk('.'):
    for name in files:
        if (name == '.classpath'):
            classpathFile = os.path.join(root, name)
            print('Patching file:' + classpathFile)
            classpathDOM = parse(classpathFile)
            classPathEntries = classpathDOM.getElementsByTagName('classpathentry')
            for classPathEntry in classPathEntries:
                if classPathEntry.attributes["path"].value.startswith('target/generated-sources'):
                    # ensure that the <attributes> tag exists
                    attributesNode = None;
                    for attributes in classPathEntry.childNodes:
                            if (attributes.nodeName == 'attributes'):
                                attributesNode = attributes

                    if (attributesNode == None):
                        attributesNode = classpathDOM.createElement('attributes')
                        classPathEntry.appendChild(attributesNode)

                    # search if the 'ignore_optional_problems' entry exists
                    hasBeenSet = 0
                    for node in attributesNode.childNodes:
                        if (node.nodeName == 'attribute' and node.getAttribute('name') == 'ignore_optional_problems'):
                            # it exists, make sure its value is true
                            node.setAttribute('value','true')
                            #print(node.getAttribute('name'))
                            hasBeenSet = 1

                    if (not(hasBeenSet)):
                        # it does not exist, add it
                        x = classpathDOM.createElement("attribute")
                        x.setAttribute('name','ignore_optional_problems')
                        x.setAttribute('value','true')
                        attributesNode.appendChild(x)

            try:
                f = open(classpathFile, "w") 
                classpathDOM.writexml(f)
                print('Writing file:' + classpathFile)
            finally:
                f.close()
print('Done.')

Answer 9

我正在对一些 ANTLR 语法执行此操作，这些语法使用 Ant 生成 Java 解析器。 Ant 构建脚本将 @SuppressWarnings("all") 添加到一个 Java 文件，并将 @Override 添加到另一个 Java 文件中的一些方法。
如果您有兴趣，我可以查一下具体是如何完成的。

Answer 10

对于 ANTLR 2，可以通过在语法文件中的类声明之前附加 @SuppressWarnings 来抑制生成代码中的警告，例如

{@SuppressWarnings("all")} class MyBaseParser extends Parser;

Answer 11

这可以通过从构建路径中排除某些目录来完成（以下示例使用 Eclipse 3.5 给出）

[1] 打开 Java 构建路径

• 单击 Package Explorer 中的项目
• 右键单击​​，属性
• 选择 Java 构建路径

[2] 添加要排除的

• 目录 源选项卡应包含项目源文件夹的详细信息
• 展开源文件夹并找到“排除” :' 属性
• 选择 '排除：' 并单击编辑
• 使用添加/添加多个选项将文件夹添加到排除模式中
• 单击完成，然后 Eclipse 即可重建。

Answer 12

我发布 warning-cleaner 插件已经有一段时间了，现在我使用的是 Eclipse 3.8，我不再需要它了。
不过，对于那些仍然需要这个插件的人，我已经在 github 上发布了它，并在 bintray 上更新了站点。
如果您仍在使用 Eclipse 3.7 或更早版本，这可能很有用。
检查此站点了解安装详细信息。

Answer 13

如果 eclipse 项目是使用 Eclipse 插件的 eclipse< 从 gradle 生成的/code> 命令可以通过将其添加到 build.gradle 文件的顶层来设置选择性地忽略源文件夹中的错误/警告选项：

eclipse.classpath.file {
    whenMerged { classpath ->
        classpath.entries.each { entry -> 
            if (entry.path.contains('build/generated/parser')) {
                entry.entryAttributes['ignore_optional_problems'] = true
            }
        }
    }
}

这假设生成的源位于 build/ generated/parser 文件夹中。