Spring Bootのbuild.gradleのタスクでSpotBugsレポート出力する方法

GradleタスクでSpotBugsのレポートをHTML形式で出力します。

SpotBugs4.0.0

環境	バージョン
Spring Boot	2.2.5.RELEASE
Gradleラッパー	6.2.2
Java	11
SpotBugs	4.0.0

build.gradle

plugins {
  id 'org.springframework.boot' version '2.2.5.RELEASE'
  id 'io.spring.dependency-management' version '1.0.9.RELEASE'
  id 'java'
  id 'com.github.spotbugs' version '3.0.0'
}

// 省略

spotbugs {
  toolVersion = '4.0.0'
  ignoreFailures = true
  reportsDir = file("$project.buildDir/reports")
  effort = "max"
  reportLevel = "high"
}

sourceSets {
  main {
    java.srcDirs = ['src/main/java']
  }
}

tasks.withType(com.github.spotbugs.SpotBugsTask) {
  reports.xml.enabled = false
  reports.html.enabled = true
}

plugins {

id 'org.springframework.boot' version '2.2.5.RELEASE'

id 'io.spring.dependency-management' version '1.0.9.RELEASE'

id 'java'

id 'com.github.spotbugs' version '3.0.0'

}

// 省略

spotbugs {

toolVersion = '4.0.0'

ignoreFailures = true

reportsDir = file("$project.buildDir/reports")

effort = "max"

reportLevel = "high"

}

sourceSets {

main {

java.srcDirs = ['src/main/java']

}

tasks.withType(com.github.spotbugs.SpotBugsTask) {

reports.xml.enabled = false

reports.html.enabled = true

}

build.gradleに記述しているディレクトリは以下の場所になります。

変数	値
$project.buildDir	C:\workspace\gradle-proj\build

これでgradlew.bat tasks --allを実行すれば、spotbugsMain,spotbugsTestがタスク追加されていることがわかります。

レポートは、reportDirプロパティで指定された場所、もしくはデフォルトだとbuild\reports配下に出力されます。

SpotBugsのプラグイン(fb-contrib)を使う

レポート出力する際にfb-contribを使ってレポート出力します。

dependenciesに3行追加します。

plugins {
    id 'org.springframework.boot' version '2.2.5.RELEASE'
    id 'io.spring.dependency-management' version '1.0.9.RELEASE'
    id 'java'
    id 'com.github.spotbugs' version '3.0.0'
}

dependencies {
  // 省略
  compileOnly 'com.github.spotbugs:spotbugs:4.0.0'
  spotbugs configurations.spotbugsPlugins.dependencies
  spotbugsPlugins  'com.mebigfatguy.fb-contrib:fb-contrib:7.4.7'
}
spotbugs {
    toolVersion = '4.0.0'
    ignoreFailures = true
    reportsDir = file("$project.buildDir/findbugsReports")
    effort = 'max'
    reportLevel = 'medium'
}

sourceSets {
  main {
    java.srcDirs = ['src/main/java']
  }
}

tasks.withType(com.github.spotbugs.SpotBugsTask) {
  reports.xml.enabled = false
  reports.html.enabled = true
  pluginClasspath = project.configurations.spotbugsPlugins // 追加
}

plugins {

id 'org.springframework.boot' version '2.2.5.RELEASE'

id 'io.spring.dependency-management' version '1.0.9.RELEASE'

id 'java'

id 'com.github.spotbugs' version '3.0.0'

}

dependencies {

// 省略

compileOnly 'com.github.spotbugs:spotbugs:4.0.0'

spotbugs configurations.spotbugsPlugins.dependencies

spotbugsPlugins 'com.mebigfatguy.fb-contrib:fb-contrib:7.4.7'

}

spotbugs {

toolVersion = '4.0.0'

ignoreFailures = true

reportsDir = file("$project.buildDir/findbugsReports")

effort = 'max'

reportLevel = 'medium'

}