Как подавить предупреждения Java для определенных каталогов или файлов, таких как сгенерированный код

Я использую генератор парсера, который создает несколько уродливый код. В результате мой проект Eclipse имеет несколько десятков предупреждений, исходящих из сгенерированных исходных файлов. Я знаю, что могу использовать @SuppressWarningаннотацию для подавления определенных предупреждений в определенных элементах, но любые аннотации, которые я добавляю вручную, будут потеряны при повторном запуске генератора парсера. Есть ли способ настроить Eclipse для подавления предупреждений для определенного файла или каталога?

Начиная с версии 3.8 M6, Eclipse (а точнее JDT) имеет для этого встроенные функции. Его можно настроить с помощью пути сборки проекта : Свойства проекта> Путь сборки Java> Компилятор> Источник

Здесь анонсированы: Eclipse 3.8 и 4.2 M6 - новые и заслуживающие внимания , называемые выборочно игнорировать ошибки / предупреждения из исходных папок . Отсюда и скриншот. Это новая функция, разработанная для ранее связанной ошибки 220928 .

Для этого есть билет, ошибка 220928 , который с тех пор был завершен для Eclipse 3.8. Подробнее см. В этом ответе .

Если вы застряли на Eclipse 3.7 или ниже: пользователь «Marc», комментирующий этот тикет, создал (или, по крайней мере, ссылается на) плагин под названием «warningcleaner» в комментарии 35 . Я использую это с большим успехом, ожидая интеграции этой функции в Eclipse.

Это действительно очень просто:

1. Установите плагин.
2. Щелкните проект правой кнопкой мыши и выберите «Добавить / удалить характер сгенерированного кода».
3. Откройте настройки проекта (щелкните правой кнопкой мыши и выберите «Свойства»).
4. Откройте вкладку «Очиститель предупреждений».
5. Выберите исходные папки, из которых вы хотите игнорировать предупреждения.

Я решил это с помощью плагина maven regexp replace - он не решает причину, но лечит боль:

<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.

Я думаю, что лучшее, что вы можете сделать, - это включить специальные настройки проекта для отображения предупреждений.

Окно -> Настройки -> Java -> Компилятор -> Ошибки / предупреждения

В верхней части формы находится ссылка для настройки параметров конкретного проекта.

Пользователь @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' />

Обратите внимание, что <replace> в Ant выполняет замену текста, а не регулярного выражения, поэтому он не может использовать метасимвол ^ в токене для соответствия началу строки, как это делает плагин замены maven regexp.

Я делаю это одновременно с запуском Antlr из maven-antrun-plugin в моем Maven pom, потому что плагин maven ANTLR не работал с плагином Maven Cobertura.

(Я понимаю, что это не ответ на исходный вопрос, но я не могу форматировать код Ant в комментарии / ответе на другой ответ, только в ответе)

Я не думаю, что Eclipse по своей сути предоставляет способ сделать это на уровне каталогов (но я не уверен).

Вы можете поместить сгенерированные файлы в отдельный проект Java и управлять предупреждениями для этого конкретного проекта.

Я вообще предпочитаю помещать автоматически сгенерированный код в отдельный проект.

Вы можете подавить предупреждения только на уровне проекта. Однако вы можете настроить вкладку проблем, чтобы подавить предупреждения от файлов или пакетов. Перейдите в меню «Настроить содержимое» и поработайте с областью «В рабочем наборе:».

Этот небольшой скрипт python «исправляет» .classpathфайлы, созданные M2E , и добавляет требуемый тег XML во все исходные папки, начиная с target/generated-sources. Вы можете просто запустить его из корневой папки вашего проекта. Очевидно, вам нужно повторно запустить его, когда информация о проекте Eclipse будет повторно сгенерирована из M2E. И все, разумеется, на ваш страх и риск ;-)

#!/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.')

Я делаю это с несколькими грамматиками ANTLR, которые генерируют синтаксический анализатор Java с использованием Ant. Сценарий сборки Ant добавляет в @SuppressWarnings("all")один файл Java и @Overrideнесколько методов в другой. Я могу посмотреть, как именно это делается, если вам интересно.

В случае ANTLR 2 можно подавить предупреждения в сгенерированном коде, добавив appenidng @SuppressWarningsперед объявлением класса в файле грамматики, например

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

Это можно сделать, исключив определенные каталоги из пути сборки (следующий пример дается с использованием Eclipse 3.5)

[1] Откройте путь сборки Java

• Щелкните проект в проводнике пакетов
• Щелкните правой кнопкой мыши, свойства
• Выберите путь сборки Java

[2] Добавить каталоги для исключения

• Вкладка Источник должна содержать сведения об исходных папках проекта.
• Разверните исходную папку и найдите свойство «Исключено:».
• Выберите "Исключено:" и нажмите "Изменить".
• Добавьте папки в шаблоны исключения с помощью параметров Добавить / Добавить несколько
• Нажмите «Готово», затем «ОК», чтобы Eclipse перестроился.

Прошло некоторое время с тех пор, как я выпустил плагин для очистки предупреждений, и теперь, когда я использую Eclipse 3.8, он мне больше не нужен. Однако для тех, кому все еще нужен этот плагин, я выпустил его на github с сайтом обновлений на bintray. Если вы все еще используете Eclipse 3.7 или более раннюю версию, это может быть полезно. Посетите этот сайт для получения информации об установке.

Если проект затмения генерируется из Gradle с помощью Eclipse Plugin в eclipse команде в Selectively ignore errors/warnings from source foldersопции может быть установлено путем добавления этого на верхнем уровне вам 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папке.