PMD-跳过由@PostConstruct或@PreDestroy注释的检查方法

Question

我有以下课程：

import javax.annotation.PostConstruct;

public class PmdUnusedMethod {

    private void unusedMethod() {
    }

    @PostConstruct
    private void postConstructAnnotatedMethod() {
    }
}

和定义的PMD规则集：

<rule ref="rulesets/java/unusedcode.xml"/>

在这种情况下，PMD向我报告有关未使用方法的两个错误（“unusedMethod”和“postConstructAnnotatedMethod”），但我想忽略使用@PreDestroy和@PostConstruct注释的方法的规则“UnusedPrivateMethod”。

我知道我可以做这样的事：

<rule ref="rulesets/java/unusedcode.xml">
        <exclude name="UnusedPrivateMethod"/>
    </rule>
    <rule ref="rulesets/java/unusedcode.xml/UnusedPrivateMethod">
        <properties>
            <property name="violationSuppressXPath"
                      value="//ClassOrInterfaceBodyDeclaration/Annotation/MarkerAnnotation/Name[@Image='PostConstruct']"/>
        </properties>
    </rule>

但在这种情况下，PMD跳过检查该规则，检查类中所有包含my注释的方法，而不仅仅是使用@PostConstruct注释的方法。我希望在检查代码后，我的“unusedMethod”只有错误，PMD不会通知“postConstructAnnotatedMethod”的错误。

我想这样做：

<rule ref="rulesets/java/unusedcode.xml/UnusedPrivateMethod">
    <properties>
        <property name="violationSuppressXPath"
                  value="//MethodDeclaration/Annotation/Name[@Image='PostConstruct']"/>
    </properties>
</rule>

仅跳过使用所需注释注释的方法，而不是所有方法。

此外，我不想用许多@SuppressWarnings（“PMD.UnusedPrivateMethod”）注释污染我的代码。

Answer 1

以违规所在的节点为起点执行抑制XPath，因此您可以简单地“上到一个方法，检查注释”。

例如：

<rule ref="rulesets/java/unusedcode.xml/UnusedPrivateMethod">
    <properties>
        <property name="violationSuppressXPath"
                  value="./ancestor::ClassOrInterfaceBodyDeclaration/Annotation/MarkerAnnotation/Name[@Image='PostConstruct']"/>
    </properties>
</rule>