如何让Gradle 4.5.1使用PMD 6.x规则分类?
解决PMD 6.x规则名弃用警告的Gradle配置调整方案
刚好遇到过类似的配置问题,我来帮你搞定这个PMD弃用警告!你遇到的是PMD从6.x版本开始的规则结构重构导致的——旧的rulesets/java/basic.xml/AvoidBranchingStatementAsLastInLoop规则路径已经被官方标记为弃用,取而代之的是category/java/errorprone.xml/AvoidBranchingStatementAsLastInLoop,而且PMD 7.0.0会彻底移除对旧规则路径的支持,所以必须调整Gradle里的PMD配置来消除警告。
下面是具体的修改步骤:
1. 定位Gradle中的PMD配置块
首先找到你项目构建脚本(build.gradle或build.gradle.kts)里的pmd闭包,这是配置PMD规则的核心区域。
2. 替换旧规则引用
根据你之前的配置方式,分两种情况修改:
情况一:直接指定规则集文件
如果之前是通过ruleSets指定整个规则集文件,比如:
pmd { toolVersion = '6.1.0' ruleSets = ['rulesets/java/basic.xml', 'rulesets/java/design.xml'] }
需要把旧的rulesets/xxx.xml路径替换成对应的category/xxx.xml路径,比如上面的配置要改成:
pmd { toolVersion = '6.1.0' ruleSets = [ 'category/java/errorprone.xml', // 对应原basic.xml中的错误预防类规则 'category/java/design.xml' ] }
注:PMD 6.x把原有的规则集重新归类到了不同的category下,比如原basic.xml里的错误预防类规则大多移到了errorprone.xml中,你可以根据需要调整对应的category路径。
情况二:单独指定单个规则
如果之前是通过rules闭包单独启用某个规则,比如:
pmd { toolVersion = '6.1.0' rules { include 'rulesets/java/basic.xml/AvoidBranchingStatementAsLastInLoop' } }
直接替换规则的完整路径即可:
pmd { toolVersion = '6.1.0' rules { include 'category/java/errorprone.xml/AvoidBranchingStatementAsLastInLoop' } }
3. 验证修改效果
保存配置后,重新执行构建命令(比如./gradlew build),你会发现之前的弃用警告已经消失了。
额外提示
- 如果项目使用了自定义的PMD规则集文件(比如自己写的
my-ruleset.xml),需要在文件里把所有旧的规则引用路径替换成新的category格式。 - 建议尽早完成这次迁移,避免未来升级到PMD 7.0.0时出现构建失败的问题。
内容的提问来源于stack exchange,提问作者Thunderforge
相关产品推荐
相关产品推荐

