如何在Gradle配置中忽略PMD对Spring字段注入的检查？

你可以通过Gradle的PMD扩展配置ignoreAnnotations属性，针对触发违规的具体规则进行设置，步骤如下：

1. 确定触发违规的PMD规则名称
   查看gradle build时的报错日志，找到对应的规则名（例如常见的UnusedPrivateField，因为@Autowired注入的私有字段可能被PMD误判为未使用）。

2. 在Gradle脚本中配置PMD规则
   根据你使用的Gradle DSL（Groovy或Kotlin），添加如下配置：

Groovy DSL（build.gradle） #

pmd {
    // 按需指定你的PMD规则集，也可以保留默认配置
    rulesets = ['category/java/bestpractices.xml']
    
    ruleConfigurations {
        rule {
            // 替换为你实际找到的规则名称
            name = 'UnusedPrivateField'
            properties {
                property {
                    name = 'ignoreAnnotations'
                    // 可以添加多个需要忽略的注解，用逗号分隔
                    value = 'org.springframework.beans.factory.annotation.Autowired'
                }
            }
        }
    }
}

Kotlin DSL（build.gradle.kts） #

pmd {
    rulesets = listOf("category/java/bestpractices.xml")
    
    ruleConfigurations {
        // 替换为实际触发违规的规则名称
        rule("UnusedPrivateField") {
            property(
                "ignoreAnnotations",
                "org.springframework.beans.factory.annotation.Autowired"
            )
        }
    }
}

3. 多注解或多规则的扩展配置

• 如果需要忽略多个注解，直接在value中用逗号分隔，例如：value = 'org.springframework.beans.factory.annotation.Autowired, javax.inject.Inject'
• 如果有多个规则需要配置忽略注解，在ruleConfigurations下添加多个rule块即可。

配置完成后重新执行gradle build，PMD就会忽略带有指定注解的字段注入相关违规。

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