Java 11/12 Javadoc with maven 导致无法生成用于测试的 Javadocs

2022-09-03 08:15:27

我有一个小项目,结构如下:

pom.xml

src/main/java/
  module-info.java
  de.ps.pl.te/
    package-info.java
    TE.java

src/test/java/
   de.ps.pl.te.test/
     package-info.java
     TETests.java

同样在我的maven pom中,我定义了javadoc插件,如下所示:

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.1.0</version>
        <configuration>
          <show>protected</show>
          <failOnError>false</failOnError>
        </configuration>
      </plugin>

现在我在运行过程中得到了一些奇怪的输出

mvn clean install site

[信息]生成 “Javadoc” 报告--- maven-javadoc-plugin:3.1.0:aggregate-no-fork [ERROR] 获取链接时出错:D:\work\eclipse\java\FritzBox\phplib\target\javadoc-bundle-options。忽略了它。

[...]

[信息]生成“Test Javadoc”报告--- maven-javadoc-plugin:3.1.0:test-aggregate-no-fork

[错误]获取链接时出错:D:\work\eclipse\java\FritzBox\phplib\target\javadoc-bundle-options。忽略了它。

正在为 package de.ps.pl.te.test 加载源文件...

1 个错误

[错误]创建 javadoc 报告时出错:

退出代码:2 - javadoc:错误 - 没有软件包 de.powerstat.phplib.templateengine.test 的源文件

命令行是: [...]javadoc.exe @options @packages

请参阅“[...]”目录中生成的 Javadoc 文件。

org.apache.maven.reporting.MavenReportException:

退出代码:2 - javadoc:错误 - 没有软件包 de.ps..pl.te.test 的源文件

命令行是: [...]javadoc.exe @options @packages

请参阅“[...]\target\site\testapidocs' dir.

at org.apache.maven.plugins.javadoc.AbstractJavadocMojo.executeJavadocCommandLine (AbstractJavadocMojo.java:5761)

at org.apache.maven.plugins.javadoc.AbstractJavadocMojo.executeReport (AbstractJavadocMojo.java:2148)

at org.apache.maven.plugins.javadoc.TestJavadocReport.executeReport (TestJavadocReport.java:162)

[...]

我研究了以下问题:

但我的问题似乎有所不同,并且基于java模块化。所以问题是如何修复它 - 还是更多的是进行错误报告?

编辑 1

现在我尝试使用JDK 11.0.3和JDK 12.0.1 - 由于oracle证书和服务器问题,我无法下载OpenJDK - 所以我无法测试OpenJDK 13早期访问。

有趣的一点是,使用版本 11/12 时,错误消息略有不同。

对于 JDK 11,错误是:

退出代码: 1 - Project\src\main\java\module-info.java:12: error: module not found: org.apache.logging.log4j require org.apache.logging.log4j;

对于 JDK 12,错误是:

退出代码:1 - 错误:找不到模块:de.powerstat.phplib.templateengine

消息的其余部分仍然相同。

另外,我发现了一个可能涉及此处的错误报告:

Javadoc 不支持多发行版 jar 中的 module-info

我也试图排除模块信息.java但没有成功:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <version>3.1.0</version>
  <configuration>
    <show>protected</show>
    <failOnError>false</failOnError>
    <sourceFileExcludes>
      <sourceFileExclude>**/module-info.java</sourceFileExclude>
    </sourceFileExcludes>
  </configuration>
</plugin>

编辑 2

在target\site\apidocs中,我可以找到以下(maven生成的?)文件:

  • 参数文件
  • javadoc.bat
  • 选项

参数文件:

'D:/TemplateEngine/src/main/java/de/ps/pl/te/package-info.java'
'D:/TemplateEngine/src/main/java/de/ps/pl/te/TemplateEngine.java'

javadoc.bat:

D:\Programme\Java\jdk-11.0.3\bin\javadoc.exe @options @argfile

包:

de.powerstat.phplib.templateengine
de.powerstat.phplib.templateengine

选项:

--module-path
'C:/.m2/repository/org/apache/logging/log4j/log4j-api/2.11.2/log4j-api-2.11.2.jar;C:/.m2/repository/org/apache/logging/log4j/log4j-core/2.11.2/log4j-core-2.11.2.jar'
-sourcepath
'D:/TemplateEngine/src/main/java'
-d
'D:/TemplateEngine/target/site/apidocs'
-linkoffline
'https://docs.oracle.com/en/java/javase/11/docs/api' 'D:/TemplateEngine/target/javadoc-bundle-options'
[Removed uninteresting parts like encoding, title etc.]

如果有人想亲自尝试,我已经在GitHub上提供了整个项目。

编辑3:

上面提到的一些问题随着更新到Java 11.0.10或其他更新版本而消失。但是仍然有一个问题存在 - 我已经将其报告为错误


答案 1

测试时,我看到了这个错误

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.7.1:site (default-site) on project templateengine: Execution default-site of goal org.apache.maven.plugins:maven-site-plugin:3.7.1:site failed: could not find reports directory [C:\tmp\TemplateEngine\target\pit-reports]
[ERROR]
[ERROR] Please copy and paste the information and the complete stacktrace below when reporting an issue
[ERROR] VM : OpenJDK 64-Bit Server VM
[ERROR] Vendor : Oracle Corporation
[ERROR] Version : 12.0.1+12
[ERROR] Uptime : 146619
[ERROR] Input ->
[ERROR]  1 : -Dclassworlds.conf=C:/ProgramData/chocolatey/lib/maven/apache-maven-3.6.1/bin/m2.conf
[ERROR]  2 : -Dmaven.home=C:/ProgramData/chocolatey/lib/maven/apache-maven-3.6.1
[ERROR]  3 : -Dlibrary.jansi.path=C:/ProgramData/chocolatey/lib/maven/apache-maven-3.6.1/lib/jansi-native
[ERROR]  4 : -Dmaven.multiModuleProjectDirectory=C:/tmp/TemplateEngine
[ERROR] BootClassPathSupported : false

刚刚创建了文件夹“mkdir ./target/pit-reports”,它就消失了。这就产生了问题

<show>private</show>

因此,我们可以说您在maven-javadoc-plugin中发现了一个错误:)


答案 2

我最近遇到了同样的错误。看起来像是因为我的存储库中的maven-shade-plugin。我使用的是1.6的旧版本并将其升级到3.2.4,并且此错误消失了。


推荐