Checkstyle 插件使用 Checkstyle 对项目的 Java 源代码文件执行质量检查，并根据这些检查生成报告。

用法

要使用 Checkstyle 插件，请在构建脚本中包含以下内容

示例 1. 使用 Checkstyle 插件
build.gradle.kts
plugins {
    checkstyle
}
build.gradle
plugins {
    id 'checkstyle'
}

该插件为项目添加了一些执行质量检查的任务。您可以通过运行 gradle check 来执行检查。

请注意，Checkstyle 将使用与运行 Gradle 相同的 Java 版本运行。

任务

Checkstyle 插件为项目添加了以下任务

checkstyleMain — Checkstyle

依赖于: classes

对生产环境的 Java 源代码文件运行 Checkstyle。

checkstyleTest — Checkstyle

依赖于: testClasses

对测试环境的 Java 源代码文件运行 Checkstyle。

checkstyleSourceSet — Checkstyle

依赖于: sourceSetClasses

对给定源集的 Java 源代码文件运行 Checkstyle。

添加到其他任务的依赖

Checkstyle 插件为 Java 插件定义的任务添加了以下依赖。

check

依赖于: 所有 Checkstyle 任务，包括 checkstyleMain 和 checkstyleTest。

项目布局

默认情况下，Checkstyle 插件期望配置文件放置在根项目中，但可以修改此设置。

<root>
└── config
    └── checkstyle           (1)
        └── checkstyle.xml   (2)
        └── suppressions.xml
1 Checkstyle 配置文件放在此处
2 主 Checkstyle 配置文件

依赖管理

Checkstyle 插件添加了以下依赖配置

表 1. Checkstyle 插件 - 依赖配置
名称 含义

checkstyle

要使用的 Checkstyle 库

默认情况下，checkstyle 配置使用 com.puppycrawl.tools:checkstyle。使用的 com.puppycrawl.tools:checkstyle 版本派生自扩展的工具版本

checkstyle {
    toolVersion = "10.12.4"
}

如果添加了另一个依赖，默认的 com.puppycrawl.tools:checkstyle 依赖将被移除

checkstyle {
    toolVersion = "10.12.4"
}

dependencies {
    checkstyle "group:artifact:version"
}

要在向 checkstyle 配置添加依赖的同时保留对 com.puppycrawl.tools:checkstyle 的依赖，请使用以下解决方案

checkstyle {
    toolVersion = "10.12.4"
}

dependencies {
    checkstyle "com.puppycrawl.tools:checkstyle:${checkstyle.toolVersion}"
    checkstyle "group:artifact:version"
}

配置

请参阅 API 文档中的 CheckstyleExtension 类。

内置变量

Checkstyle 插件定义了一个 config_loc 属性，可在 Checkstyle 配置文件中使用，以定义指向其他配置文件（如 suppressions.xml）的路径。

示例 2. 使用 config_loc 属性
checkstyle.xml
<module name="SuppressionFilter">
    <property name="file" value="${config_loc}/suppressions.xml"/>
</module>

自定义 HTML 报告

Checkstyle 任务生成的 HTML 报告可以使用 XSLT 样式表进行自定义，例如突出显示特定错误或更改其外观

示例 3. 自定义 HTML 报告
build.gradle.kts
tasks.withType<Checkstyle>().configureEach {
    reports {
        xml.required = false
        html.required = true
        html.stylesheet = resources.text.fromFile("config/xsl/checkstyle-custom.xsl")
    }
}
build.gradle
tasks.withType(Checkstyle) {
    reports {
        xml.required = false
        html.required = true
        html.stylesheet = resources.text.fromFile('config/xsl/checkstyle-custom.xsl')
    }
}

查看 Checkstyle 样式表示例。

生成 SARIF 报告

Checkstyle 10.3.3 及更高版本支持 SARIF 报告。默认不启用此功能。

示例 4. 启用 SARIF 报告
build.gradle.kts
checkstyle {
    toolVersion = "10.3.3"
}
tasks.withType<Checkstyle>().configureEach {
    reports {
        sarif.required = true
    }
}
build.gradle
checkstyle {
    toolVersion = '10.3.3'
}
tasks.withType(Checkstyle) {
    reports {
        sarif.required = true
    }
}

修改分配给 Checkstyle 的内存量

Checkstyle 分析是在单独的进程中执行的。默认情况下，Checkstyle 进程的最大堆内存为 512MB。分析大量源文件时，可能需要为该进程提供额外的内存。您可以通过配置 Checkstyle.maxHeapSize 来更改 Checkstyle 的内存量。

示例 5. 自定义分配给 Checkstyle 的内存量
build.gradle.kts
tasks.withType<Checkstyle>().configureEach {
    minHeapSize = "200m"
    maxHeapSize = "1g"
}
build.gradle
tasks.withType(Checkstyle) {
    minHeapSize = "200m"
    maxHeapSize = "1g"
}