【Java】spotbugs-maven-pluginで検出されるFindBugsの一部のルールを無視する

バージョン

spotbugs-maven-plugin 4.7.3.5

pom.xml の設定

configurationタグにexcludeFilterFileタグを追加し、無視するルールを指定するXMLファイルを指定する。以下ではfindbugs.xmlというファイルを指定している。

<plugin>
    <groupId>com.github.spotbugs</groupId>
    <artifactId>spotbugs-maven-plugin</artifactId>
    <version>4.7.3.5</version>
    <configuration>
      <!-- 無視するルールを指定するXMLファイル -->
      <excludeFilterFile>findbugs.xml</excludeFilterFile>
    </configuration>
</plugin>

excludeFilterFileに指定するXMLファイルはWeb上に配置してURLを指定できる。

<plugin>
    <groupId>com.github.spotbugs</groupId>
    <artifactId>spotbugs-maven-plugin</artifactId>
    <version>4.7.3.5</version>
    <configuration>
      <!-- 無視するルールを指定するXMLファイルをURLで指定 -->
      <excludeFilterFile>https://example.com/findbugs.xml</excludeFilterFile>
    </configuration>
</plugin>

findbugs.xml の設定例

FindBugsFilter > Match > Bugという構造で、無視するルールを指定する。

<FindBugsFilter>
  <Match>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>
</FindBugsFilter>

複数のルールを無視する場合は、Matchタグを複数指定する。

<FindBugsFilter>
  <Match>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>
  <Match>
    <Bug pattern="EI_EXPOSE_REP2"/>
  </Match>
</FindBugsFilter>

ルールは検知可能なバグの詳細 — spotbugs 4.7.3ドキュメントなどから確認できる。