Maven PMD 插件未使用 'mvn site' 命令或 'pmd:pmd' 生成报告

Question

我正在阅读一个有趣的教程：http://www.avajava.com/tutorials/lessons/how-do-i-generate-pmd-and-cpd-reports-for-a-site.html?page=1

本教程介绍如何使用 Maven 运行开源静态分析工具 PMD，以及如何在 Maven 创建的网站上查看生成的输出。 Maven 可以使用 mvn site 命令轻松创建网站，但本教程展示了如何使用 PMD 在源代码上获得更多有用的指标。

我已尽最大努力遵守指示。这是我阅读教程后得到的 pom.xml 文件：

<project xmlns="http://maven.apache.org/POM/4.0.0" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.name.bookstore</groupId>
  <artifactId>bookstore</artifactId>
  <packaging>jar</packaging>
  <version>1</version>
  <name>bookstore</name>
  <url>http://maven.apache.org</url>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <extensions>
      <!-- start for deploying using webdav -->
      <extension>
        <groupId>org.apache.maven.wagon</groupId>
        <artifactId>wagon-webdav</artifactId>
        <version>1.0-beta-2</version>
      </extension>
    </extensions>
  </build>

  <distributionManagement>
    <!-- start -location where site is deployed -->
    <site>
      <id>site.deployments</id>
      <name>Site deployments</name>
      <url>dav:localhost/${basedir}</url>
    </site>
  </distributionManagement>

  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-pmd-plugin</artifactId>
        <version>3.4</version>

      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jxr-plugin</artifactId>
        <version>2.5</version>
      </plugin>

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.10.1</version>
      </plugin>
    </plugins>
  </reporting>

</project>

当我运行命令时： mvn clean site 我得到一个由 Maven 构建的网站，其中包含许多不同的页面，但其中 none 显示了与 PMD 有关的任何内容。我在这里错过了什么？ 为什么我在生成的网站中看不到任何关于 PMD 的信息？

此外，当我运行 mvn pmd:pmd 构建成功时，我没有获得任何有用的 PMD 指标。我什至在我的 Java 源文件之一中编写了一些未使用的变量和方法，如上面的链接教程所示，但没有有用的输出。

mvn pmd:pmd 命令似乎确实创建了一些文件。一对是它看起来像的引擎的规则文件，其他的是空的。请查看下面的屏幕截图：

图 1：pmd:pmd 命令

创建的文件

图 2：空的 pmd 文件 - 尽管 Java 源文件

中有明显的错误

有人知道发生了什么事吗？为什么 PMD 不能为我使用 Maven？

感谢阅读本文。

此外，根据我在 PMD's website and Maven's website 上在 Internet 上阅读的内容，"Project Reports" 部分中应该有一些信息。这里没有来自 PMD 的数据。请看下面的屏幕截图。

图 3：项目报告中未找到 PMD 数据

此致

更新

当我将 pom.xml 文件的 PMD 部分更改为以下代码片段时，我通过 PMD 获得了一些 CPD 结果，但仍然没有从 PMD 获得任何代码错误。我什至在 NullPointerException 中编码，PMD 即使在发出 mvn pmd:check 命令时也什么也没说。

 <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-pmd-plugin</artifactId>
    <version>3.4</version>
    <configuration>

      <linkXref>true</linkXref>
      <sourceEncoding>utf-8</sourceEncoding>
      <minimumTokens>1</minimumTokens>
      <targetJdk>1.7</targetJdk>
    </configuration>
  </plugin>

在代码片段中，我将 sourceEncoding 标记更改为 utf-8，因为我看到的与此相关的所有内容都是 utf-8。我还将 minimumTokens 值更改为 1 以尝试从此插件获得更多输出。我还将此片段放在 <build> 部分以尝试获得结果但仍然没有...：/

感谢您学习这个...

Answer 1

maven-pmd-plugin by default skips nowadays empty reports (property skipEmptyReport)。您需要将其设置为 false，以便始终在您的站点中获得 PMD/CPD 报告：

<reporting>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-pmd-plugin</artifactId>
      <version>3.4</version>
      <configuration>
        <skipEmptyReport>false</skipEmptyReport>
      </configuration>
    </plugin>
  </plugins>
</reporting>

这适用于 PMD 和 CPD。我假设这是您的问题，如图 2 所示，未检测到 PMD 违规（pmd.xml 文件为空）。

属性 minimumTokens 配置 CPD 并定义代码被截断的最少长度必须被声明为重复。数字越低，检测到的重复项越多，但重复项也可能更短，因此误报率可能更高。

无需进一步配置 maven-pmd-plugin，它默认使用这三个 PMD 规则集：java-basic, java-imports, java-unusedcode. See also property rulesets. If you want to detect specific problems, then you'll need to enable these rules. See also How to make a ruleset.

Maven PMD 插件未使用 'mvn site' 命令或 'pmd:pmd' 生成报告

Maven PMD plug-in not generating a report with 'mvn site' command or 'pmd:pmd'

java

maven

pmd