Плагин SpotBugs Maven исключает каталог

Question

Я использую SpotBugs Maven Plugin для статического анализа, и я хотел бы исключить каталог из проверки.Глядя на документацию цели spotbugs:check , кажется, что настроить плагин таким способом невозможно.Я также проверил документацию для файла фильтра SpotBugs .

В плагине Apache Maven PMD это можно сделать с помощью параметра excludeRoots :

<excludeRoots>
  <excludeRoot>target</excludeRoot>
</excludeRoots>

Можно ли исключить каталог из проверки SpotBugs?

Answer 1

Можно исключить каталог из проверки с помощью SpotBugs, хотя подход отличается от того, который вы описали для PMD. Это двухэтапный процесс:

1. Сначала создайте файл фильтра XML с указанием критериев для исключаемых каталогов.

2. Затем в pom.xml обратитесь к этому файлу, используя дополнительную настройку <excludeFilterFile>. К сожалению, документация для этого параметра очень краткая.

В качестве простого примера:

1. Создайте файл фильтра с именем ignore.xml , содержащий следующее, которое ссылается на каталог с именем mydir :

   <?xml version="1.0" encoding="UTF-8"?>
   <FindBugsFilter>
       <Match>
           <Source name="~mydir\..*"/>
       </Match>
   </FindBugsFilter>
   

   Документация для тег <Source> находится здесь . См. Раздел Соответствие имени элемента Java , чтобы узнать, как задать имя для <Source>.

2. Затем в pom.xml , в спецификации для spotbugs-maven-plugin , добавьте тег <excludeFilterFile>, чтобы mydir был игнорируется SpotBugs:

   <configuration>
     <excludeFilterFile>ignore.xml</excludeFilterFile>
   </configuration>
   

Примечания:

• Существует также тег <includeFilterFile>. См. Раздел под названием Указание фильтров ошибок, которые нужно запустить в документации по использованию .

• Помимо Source, SpotBugs предоставляет несколько других способов указать, какой код должен быть включен или исключен из проверки. См. Документацию файла фильтра для тегов Package, Class, Method, Local, Field и Type.