如何在Gradle中从JAR依赖配置Checkstyle规则文件

正确配置方案 #

你需要将Checkstyle规则所在的JAR添加到Checkstyle插件的类路径，并通过Gradle资源API从类路径读取配置文件，同时确保Checkstyle版本兼容。修改后的build.gradle如下：

plugins {
    id 'checkstyle'
}

repositories {
    mavenCentral()
    maven {
        url = uri('https://repository..../repository/maven-releases')
    }
}

checkstyle {
    // 替换为UICheckstyle依赖中使用的Checkstyle版本，避免版本冲突
    toolVersion = '8.45.1' // 示例版本，请根据实际情况修改
    // 从类路径加载JAR内的配置文件
    config = resources.text.fromClasspath('config/checkstyle/checkstyle.xml')
}

dependencies {
    // 将规则JAR添加到Checkstyle插件的类路径
    checkstyle("tech.qa:UICheckstyle:1.0.8")
}

为什么之前的方案失败 #

1. 直接使用implementation依赖：implementation配置的依赖只会被添加到项目代码的类路径，Checkstyle插件无法访问，因此它会尝试在本地项目路径查找配置文件，导致找不到文件的错误。
2. 改用checkstyle依赖但未指定版本：Checkstyle插件默认自带一个Checkstyle版本，如果该版本与UICheckstyle依赖中的Checkstyle版本不兼容，就会出现ClassNotFoundException，指定toolVersion可以解决版本冲突问题。
3. 指定本地文件路径：配置文件在JAR内部，本地路径自然无法访问，必须通过类路径加载。

额外说明 #

如果不确定UICheckstyle依赖使用的Checkstyle版本，可以查看该JAR的pom.xml文件，或者通过Gradle命令查看依赖树：

./gradlew dependencies --configuration checkstyle

内容的提问来源于stack exchange，提问作者AyeVeeKay