pmd maven 插件不尊重 exclude-cpd.properties答案

【问题标题】：pmd maven plugin does not respect exclude-cpd.propertiespmd maven 插件不尊重 exclude-cpd.properties
【发布时间】：2019-09-27 00:35:44
【问题描述】：

我有多个模块的maven项目，结构是这样的：

/myProject 
  pom.xml
  exclude-cpd.properties
  -- module1
     pom.xml
     exclude-cpd.properties
  -- module2
     pom.xml
     exclude-cpd.properties

在我的父 pom.xml 中我添加了 pmd 插件：

<build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-pmd-plugin</artifactId>
                    <version>3.12.0</version>
                    <configuration>
                        <rulesets>
                            <ruleset>pmd_ruleset.xml</ruleset>
                        </rulesets>
                        <minimumTokens>80</minimumTokens>
                        <includeTests>true</includeTests>
                        <excludeFromFailureFile>exclude-cpd.properties</excludeFromFailureFile>
                        <printFailingErrors>true</printFailingErrors>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>

在 exclude-cpd.properties 中，我将所有要从 cpd-check 中排除的文件都包含为逗号分隔的字符串。

但是当我运行mvn clean compile 时，它仍然会扫描那些排除的文件并抱怨重复。似乎excludeFromFailureFile 根本不起作用，我最终不得不使用excludes 从 pmd 检查和 cpd 检查中排除文件，但这并不理想。有人知道如何让excludeFromFailureFile 工作吗？

工作 pom.xml：

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-pmd-plugin</artifactId>
                <version>3.12.0</version>
                <configuration>
                    <rulesets>
                        <ruleset>pmd_ruleset.xml</ruleset>
                    </rulesets>
                    <minimumTokens>80</minimumTokens>
                    <includeTests>true</includeTests>
                    <excludes>
                        <exclude>**/XyzService*.java</exclude>
                    </excludes>
                    <printFailingErrors>true</printFailingErrors>
                </configuration>
            </plugin>
        </plugins>
    </pluginManagement>

【问题讨论】：

标签： maven-plugin pmd

【解决方案1】：

我认为你误解了标志。

excludeFromFailureFile 的字面意思是：如果在这些文件上报告了违规行为，请不要使构建失败。仍然会分析文件，但如果只有这些文件且没有其他文件有违规，则构建仍然通过（如果其他文件有违规，构建仍然失败）。这甚至不是 PMD 功能，而是 Maven 插件的一部分。

这不是“从分析中排除”，您需要在第二个示例中使用 excludes 配置。

【讨论】：

【解决方案2】：

另一个好主意是使用 @SuppressWarnings("CPD-START") 和 @SuppressWarnings("CPD-END") 来忽略 CPD 这两个注解中的所有 java 代码，例如：

...

//enable suppression (start)
@SuppressWarnings("CPD-START")
public Object shouldBeIgnoredFromHere(String any) throws Exception {
    // any code here will be ignored for the duplication detection
}

...

//disable suppression (end)
@SuppressWarnings("CPD-END)
public void shouldBeIgnoredToHere() {
}

...

阅读压制章节：https://pmd.sourceforge.io/pmd-5.0.5/cpd-usage.html

【讨论】：