PMD 自定义规则集 - 也许您拼错了规则名称？答案

【问题标题】：PMD custom ruleset - Maybe you mispelled a rule name?PMD 自定义规则集 - 也许您拼错了规则名称？
【发布时间】：2018-02-23 18:48:33
【问题描述】：

我正在尝试将 pmd 集成到我的项目中。但我收到以下错误

java.lang.IllegalArgumentException：未找到规则。也许您拼错了规则名称？

pom.xml 入口如下 -

<reporting>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-pmd-plugin</artifactId>
            <version>3.7</version>
            <configuration>
                <linkXRef>false</linkXRef>
                <rulesets>             
                    <ruleset>
                        pmdruleset.xml
                    </ruleset>
                </rulesets>
            </configuration>
        </plugin>
    </plugins>
</reporting>

自定义规则集文件包含以下内容 -

<?xml version="1.0"?>
<ruleset name="Controversial"
         xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">

    <description>
        <rule ref="rulesets/java/errorprone.xml/NullAssignment"/>
    </description>
</ruleset>

我无法理解出了什么问题。有人可以帮忙吗！

【问题讨论】：

我正在运行以下命令 - 1) mvn pmd:pmd 2) mvn site
您的规则标签包含在描述标签中。规则标签应该是规则集标签的子标签。

标签： java maven-plugin pmd

【解决方案1】：

@eclipse-pmd 是对的，规则标签需要是规则集标签的子标签。

此外，您尝试使用的规则 (NullAssignment) 不在规则集中容易出错，而是存在争议。在 PMD 6 中，规则还被组织成类别，现在属于“容易出错”类别。后面会详细介绍。

maven-pmd-plugin 3.7 / PMD 5.5.1

您使用的是 maven-pmd-plugin 版本 3.7 -> 这意味着您会自动使用旧的 PMD 版本（准确地说是版本 5.5.1）。对于此版本，您的规则集应如下所示：

<?xml version="1.0"?>
<ruleset name="Custom Ruleset"
     xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">

    <description>
        Custom Ruleset
    </description>

    <rule ref="rulesets/java/controversial.xml/NullAssignment"/>
</ruleset>

PMD 5.5.1 的文档位于：https://pmd.github.io/pmd-5.5.1/pmd-java/rules/java/controversial.html#NullAssignment

maven-pmd-plugin 3.9.0 / PMD 6.0.1

如果您切换到最新的 maven-pmd-plugin 版本 3.9.0，您将自动使用 PMD 6.0.1 并受益于最新的错误修复。您可以继续使用上面的规则集，但是您会看到弃用通知，因为我们移动了规则。要消除此警告，请使用以下规则参考：

<rule ref="category/java/errorprone.xml/NullAssignment" />

PMD 6.0.1 的文档位于：https://pmd.github.io/pmd-6.0.1/pmd_rules_java_errorprone.html#nullassignment

关于规则集的文档在这里：https://pmd.github.io/pmd-6.0.1/pmd_userdocs_understanding_rulesets.html

【讨论】：