使用 SpotBugs Gradle 插件

本章介绍如何将 SpotBugs 集成到 Gradle 构建脚本中。

使用 SpotBugs Gradle 插件

请参阅 官方 Gradle 插件页面 上的说明。

请注意，SpotBugs Gradle 插件不支持 Gradle v6，您需要使用 v7.0 或更高版本。

此 Gradle 插件引入的任务

此 Gradle 插件会为 Gradle Java 插件生成的每个 sourceSet 生成一个任务。例如，如果您有两个 sourceSet：main 和 test，此插件将生成两个任务：spotbugsMain 和 spotbugsTest。

生成的任务以编译后的 .class 文件作为输入，因此它会在 Java 编译运行之后执行（例如 classes 任务）。SpotBugs Gradle 插件会为这些生成的任务添加从 check 出发的任务依赖，因此您只需运行 ./gradlew check 即可运行 SpotBugs。

如果您不希望自动生成任务，请改用 SpotBugs Base 插件。此插件不会生成任务，因此您可以从零开始进行配置。

配置 Gradle 插件

此插件使用 Extension 进行配置。请查阅 SpotBugsExtension 的文档。

例如，要指定 SpotBugs 的版本，您可以按如下方式配置：

spotbugs {
  toolVersion = '4.8.5'
}

引入 SpotBugs 插件

要引入 SpotBugs 插件，请按如下方式在 dependencies 中声明依赖：

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

其他用法

详情请参阅官方 README](⟦...⟧)。