无法找到要链接到的源XRef

时间:2012-08-20 13:03:58

标签: java maven maven-3 pmd

我有一个使用pmd插件进行代码质量检查的大型maven项目。

自从我开始使用pmd插件后,我收到以下警告消息:

[WARNING] Unable to locate Source XRef to link to - DISABLED

我用Google搜索,发现我需要实现jxr插件。

所以我将以下内容添加到主pom.xml文件中的build属性中。

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

它确实没有改变任何东西。

我需要实现哪些想法才能解决此警告消息?

mvn -version

的输出
Apache Maven 3.0.4 (r1232337; 2012-01-17 10:44:56+0200)
Maven home: /usr/share/maven-bin-3.0
Java version: 1.7.0_05, vendor: Oracle Corporation
Java home: /usr/lib64/icedtea7/jre
Default locale: en_US, platform encoding: ANSI_X3.4-1968
OS name: "linux", version: "3.5.2-gentoo", arch: "amd64", family: "unix"

谢谢!

4 个答案:

答案 0 :(得分:65)

您应该将maven-jxr-plugin添加到 reportingPlugin 部分。

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

重新运行并享受。

顺便说一句,也许你需要运行一次jxr:jxr目标才能首先生成一些将由pmd使用的文件。

答案 1 :(得分:41)

请注意,还可以通过添加

来禁用外部参照功能
<configuration>
  <linkXRef>false</linkXRef>
</configuration>

到maven-pmd-plugin插件。由于运行了额外的报告插件,这可以解决警告而不会使构建更长时间。例如。如果你在Jenkins中运行你的构建,Jenkins PMD插件可以处理PMD警告与源代码的关联,不需要为此运行另一个Maven插件。

答案 2 :(得分:0)

如果将jxr:jxr添加为插件,则应添加maven-jxr-plugin并在site生命周期之前运行maven-jxr-plugin目标:
clean jxr:jxr site

否则,如果您希望它与mvn site一起使用,则应将其添加为报告。查看JXR使用文档: JXR Usage

答案 3 :(得分:0)

以这种方式配置它而不将其绑定到站点阶段会更容易。

然后,它就像mvn test一样简单。

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>3.8.1</version>
      <configuration>
        <source>1.8</source>
        <target>1.8</target>
      </configuration>
    </plugin>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-surefire-plugin</artifactId>
      <version>${maven-surefire-plugin.version}</version>
      <dependencies>
        <dependency>
          <groupId>org.junit.platform</groupId>
          <artifactId>junit-platform-surefire-provider</artifactId>
          <version>1.2.0</version>
        </dependency>
        <dependency>
          <groupId>org.junit.jupiter</groupId>
          <artifactId>junit-jupiter-engine</artifactId>
          <version>${junit.jupiter.version}</version>
        </dependency>
      </dependencies>
      <configuration>
      <testSourceDirectory>src/test/java</testSourceDirectory>
      <includes>
        <include>com.whatever.suite.*</include>
      </includes>
      <systemPropertyVariables>
        <selenide.remote>${grid.hub}</selenide.remote>
      </systemPropertyVariables>
      <trimStackTrace>false</trimStackTrace>
    </configuration>
  </plugin>
  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-report-plugin</artifactId>
    <version>${maven-surefire-plugin.version}</version>
    <configuration>
      <outputDirectory>target/surefire-reports</outputDirectory>
      <linkXRef>false</linkXRef>
    </configuration>
    <executions>
      <execution>
        <id>during-tests</id>
        <phase>test</phase>
        <goals>
          <goal>report</goal>
        </goals>
      </execution>
    </executions>
  </plugin>
</plugins>