SpotBugs Gradle プラグインの使い方

この章では,Gradle のビルドスクリプトに SpotBugs を統合する方法について説明します。

SpotBugs Gradle プラグインを使う

Gradle プラグインの公式ページ の案内に従ってください。

SpotBugs PluginはGradleバージョン4をサポートしません。バージョン5.6以降を使用してください。

Gradle プラグインによって導入されたタスク

This Gradle Plugin generates task for each sourceSet generated by Gradle Java Plugin. For instance, if you have two sourceSets main and test, this plugin will generates two tasks: spotbugsMain and spotbugsTest.

Generated tasks uses compiled .class files as input, so it will run after java compilation runs (e.g. classes task). SpotBugs Gradle Plugin adds task dependency from check to these generated tasks, so you can simply run ./gradlew check to run SpotBugs.

自動的にタスクを生成したくない場合は、代わりに SpotBugs Baseプラグイン を使ってください。Baseプラグインはタスクの生成をしないので、すべての設定を自分で行えます。

Gradle プラグインの設定

このプラグインは設定にExtensionを使います。使い方は `SpotBugsExtensionのドキュメント <https://spotbugs-gradle-plugin.netlify.app/com/github/spotbugs/snom/SpotBugsExtension.html>`_を参照してください。

たとえば,SpotBugs のバージョンを指定したいときは,次のように設定します。

spotbugs {
  toolVersion = '4.2.3'
}

SpotBugs Pluginを利用する

SpotBugs Pluginを利用するには,プラグインへの依存を次のように dependencies 内に記載してください:

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

その他の使い方

その他の使い方については 公式のREADMEページ を参照してください。