第三十一章. FindBugs 插件

Chapter 31. The FindBugs Plugin

FindBugs 插件使用 FindBugs 对项目的 Java 源文件执行质量检查,并从这些检查中生成报告。
The FindBugs plugin performs quality checks on your project's Java source files using FindBugs and generates reports from these checks.

31.1. 用法

31.1. Usage

要使用 FindBugs 插件,请在构建脚本中包含:
To use the FindBugs plugin, include in your build script:

示例 31.1. 使用 FindBugs 插件 - Example 31.1. Using the FindBugs plugin

build.gradle

apply plugin: 'findbugs'

该插件向项目添加了许多执行质量检查的任务。你可以通过运行 gradle check 来执行这些检查。
The plugin adds a number of tasks to the project that perform the quality checks. You can execute the checks by running gradle check.

31.2. 任务

31.2. Tasks

FindBugs 插件将以下任务添加到项目中:
The FindBugs plugin adds the following tasks to the project:

表 31.1. FindBugs 插件——任务 - Table 31.1. FindBugs plugin - tasks

任务名称
Task name
依赖于
Depends on
类型
Type
描述
Description
findbugsMain classes FindBugs 针对Java 的生产源文件运行 FindBugs。
Runs FindBugs against the production Java source files.
findbugsTest testClasses FindBugs 针对 Java 测试源文件运行 FindBugs。
Runs FindBugs against the test Java source files.
findbugsSourceSet sourceSetClasses FindBugs 针对给定源集的 Java 源文件运行 FindBugs。
Runs FindBugs against the given source set's Java source files.

FindBugs 插件向 Java 插件所定义的任务添加了以下依赖。
The FindBugs plugin adds the following dependencies to tasks defined by the Java plugin.

表 31.2. FindBugs 插件——附加的任务依赖 - Table 31.2. FindBugs plugin - additional task dependencies

任务名称
Task name
依赖于
Depends on
check 所有 FindBugs 任务,包括 findbugsMainfindbugsTest
All FindBugs tasks, including findbugsMain and findbugsTest.

31.3. 依赖管理

31.3. Dependency management

FindBugs 插件添加了下列的依赖配置:
The FindBugs plugin adds the following dependency configurations:

表31.3. FindBugs 插件——依赖配置 - Table 31.3. FindBugs plugin - dependency configurations

名称
Name
意义
Meaning
findbugs 要使用的 FindBugs 库
The FindBugs libraries to use

31.4. 配置

31.4. Configuration

请参阅 FindBugsExtension
See FindBugsExtension.