Checkstyle 插件 - Gradle 构建系统

用法

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

KotlinGroovy

build.gradle.kts

plugins {
    checkstyle
}

该插件向项目添加了许多执行质量检查的 Task。您可以通过运行 gradle check 来执行检查。

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

Task

Checkstyle 插件向项目添加以下 Task

checkstyleMain — Checkstyle: 依赖于: classes

对生产 Java 源文件运行 Checkstyle。
checkstyleTest — Checkstyle: 依赖于: testClasses

对测试 Java 源文件运行 Checkstyle。
checkstyleSourceSet — Checkstyle: 依赖于: sourceSetClasses

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

添加到其他 Task 的依赖

Checkstyle 插件将以下依赖添加到 Java 插件定义的 Task。

check: 依赖于: 所有 Checkstyle Task，包括 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"
}

要在保留对 com.puppycrawl.tools:checkstyle 的依赖的同时，向 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 属性

自定义 HTML 报告

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

示例 3. 自定义 HTML 报告

KotlinGroovy

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 报告

SARIF 报告在 Checkstyle 10.3.3 及更高版本中受支持。默认情况下未启用。

示例 4. 启用 SARIF 报告

KotlinGroovy

build.gradle.kts

checkstyle {
    toolVersion = "10.3.3"
}
tasks.withType<Checkstyle>().configureEach {
    reports {
        sarif.required = true
    }
}

更改分配给 Checkstyle 的内存量

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

示例 5. 自定义分配给 Checkstyle 的内存量

KotlinGroovy

build.gradle.kts

tasks.withType<Checkstyle>().configureEach {
    minHeapSize = "200m"
    maxHeapSize = "1g"
}