Usando o SpotBugs Gradle Plugin

Este capítulo descreve como integrar o Spotbugs em um script de construção Gradle.

Uso do SpotBugs Gradle Plugin

Por favor, siga as instruções encontradas na página oficial do Gradle Plugin.

Note that SpotBugs Gradle Plugin does not support Gradle v6, you need to use v7.0 or later.

Tarefas introduzidas pelo Gradle Plugin

Este Gradle Plugin gera tarefas para cada sourceSet gerado pelo Gradle Java Plugin. Por exemplo, se você tem dois sourceSets main and test, este plugin gera duas tarefas: spotbugsMain and spotbugsTest.

As tarefas geradas usam como entrada os arquivos .class compilados, então so apenas serão executadas após a execução da compilação java (por exemplo, tarefas classes). SpotBugs Gradle Plugin adiciona uma dependência de tarefa de verificação check para as tarefas geradas, então você pode simplesmente usar o comando ./gradlew check para executar o SpotBugs.

Se vocẽ não quer gerar tarefas automaticamente, em vez disso, use o SpotBugs Base Plugin. Este plugin não gera tarefas, então você pode configurar do zero.

Configuração do Gradle Plugin

Este plugin usa o atributo Extension para configuração. Por favor, verifique o documento SpotBugsExtension.

Por exemplo, para especificar a versão do SpotBugs, você pode configurar da seguinte forma:

spotbugs {
  toolVersion = '4.8.4'
}

Introdução ao SpotBugs Plugin

Para introduzir o SpotBugs Plugin, por favor declare a dependência em dependencies como mostrado a seguir:

dependencies {
  spotbugsPlugins 'com.h3xstream.findsecbugs:findsecbugs-plugin:1.12.0'
}

Outros usos

Visite o README oficial para mais detalhes.