Apache Maven PMD 插件

PMD 插件允许您在项目的源代码上自动运行PMD代码分析工具，并生成带有其结果的站点报告。它还支持与 PMD 一起分发的单独的复制/粘贴检测器工具（或 CPD）。

此版本的 Maven PMD 插件使用 PMD 6.42.0 并且需要 Java 8。有关更多信息，请参阅在运行时升级 PMD 。

该插件接受可用于自定义 PMD 工具执行的配置参数。

目标概述

这个插件有以下目标：

  • pmd:pmd根据插件中的规则集和配置集创建 PMD 站点报告。除了站点报告之外，它还可以生成以下任何格式的 pmd 输出文件：xml、csv 或 txt。
  • pmd:aggregate-pmd根据插件中设置的规则集和配置在聚合器项目中创建 PMD 站点报告。除了站点报告之外，它还可以生成以下任何格式的 pmd 输出文件：xml、csv 或 txt。
  • pmd:aggregate-pmd-no-fork在聚合器项目中创建 PMD 站点报告，而无需再次分叉测试编译阶段。
  • pmd:cpd为​​ PMD 的复制/粘贴检测器 (CPD) 工具创建报告。它还可以生成以下任何格式的 cpd 结果文件：xml、csv 或 txt。
  • pmd:aggregate-cpd在聚合器项目中为 PMD 的复制/粘贴检测器 (CPD) 工具创建报告。它还可以生成以下任何格式的 cpd 结果文件：xml、csv 或 txt。
  • 如果源代码中存在任何 PMD 违规，则pmd:check会导致构建失败。此目标在执行自身之前自动调用pmd:pmd 。
  • 如果源代码中存在任何 PMD 违规，则pmd:aggregate-pmd-check会使聚合器项目中的构建失败。此目标在执行自身之前自动调用pmd:aggregate-pmd 。
  • 如果源代码中存在任何 CPD 违规，则pmd:cpd-check会使构建失败。此目标在执行自身之前自动调用pmd:cpd 。
  • 如果源代码中存在任何 CPD 违规，则pmd:aggregate-cpd-check会使聚合器项目中的构建失败。此目标在执行自身之前自动调用pmd:aggregate-cpd 。

用法

有关如何使用 PMD 插件的一般说明可以在使用页面上找到。下面给出的示例中描述了一些更具体的用例。

如果您对插件的使用仍有疑问，请查看常见问题解答并随时联系用户邮件列表。邮件列表中的帖子已存档，并且可能已经包含您问题的答案，作为旧线程的一部分。因此，也值得浏览/搜索邮件存档。

如果您觉得插件缺少功能或存在缺陷，您可以在我们的问题跟踪器中填写功能请求或错误报告。创建新问题时，请提供您所关注问题的全面描述。特别是对于修复错误，开发人员可以重现您的问题至关重要。出于这个原因，非常感谢附在问题上的整个调试日志、POM 或最好的小演示项目。当然，补丁也是受欢迎的。贡献者可以从我们的源代码库中查看该项目，并将在帮助使用 Maven 的指南中找到补充信息。

升级说明

注意：从 PMD 6.0.0 和 Maven PMD Plugin 3.9.0 开始，规则被重新组织成类别，例如/category/java/bestpractices.xml。因此，当升级到 Maven PMD 插件 3.9.0 时，您应该检查您的插件配置和/或自定义规则集。有关详细信息，请参阅使用规则集。

例子

为了让您更好地了解 Maven PMD 插件的一些用法，您可以查看以下示例：