28、Gradle Checkstyle 插件

本文详细介绍了如何在Gradle项目中使用Checkstyle插件进行Java代码质量检查,包括插件用法、任务详解、项目布局、依赖管理以及配置文件的设置,帮助开发者提升代码规范性和可维护性。

文章永久链接:https://ddkk.com/?p=9437

Checkstyle 插件

Checkstyle 插件使用 Checkstyle 对你的项目的 Java 源文件执行质量检查,并从检查结果中生成报告。

用法

要使用Checkstyle 插件,请在构建脚本中包含以下语句:

使用 Checkstyle 插件

build.gradle

apply plugin: 'checkstyle'  

该插件向你的项目添加了大量的执行质量检查的任务。你可以通过运行 gradle check 执行检查。

Tasks

Checkstyle 插件向 project 中添加了以下 tasks:

表29.1. Checkstyle 插件 – tasks

任务名称依赖于类型描述
checkstyleMainclassescheckstyle针对生产Java 源文件运行 Checkstyle。
checkstyleTesttestClassescheckstyle针对测试 Java 源文件运行 Checkstyle。
SourceSetsourceSetClassescheckstyle针对source set 的 Java 源文件运行 Checkstyle。

Checkstyle 插件向 Java 插件所加入的 tasks 添加了以下的依赖。

表29.2. Checkstyle 插件 – 额外的 task 依赖

任务名称依赖于
check所有 Checkstyle tasks,包括checkstyleTest

项目布局

Checkstyle 插件预计是以下的项目布局:

表29.3. Checkstyle 插件 – 项目布局

File意义
config/checkstyle/checkstyle.xmlCheckstyle 配置文件

依赖管理

Checkstyle 插件添加了下列的依赖配置:

表29、4. Checkstyle 插件 – 依赖配置

名称意义
checkstyle用到的 Checkstyle 库