如何使 Maven Javadoc 插件适用于任何 Java 版本

Question

我正在使用这样的 Maven Javadoc 插件

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.1.1</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

我安装了多个 JDK 版本，并希望能够使用其中任何一个构建项目。上述配置在 Java 8 上运行良好，但在 Java 11 上失败并出现以下错误

未能执行目标 org.apache.maven.plugins:maven-javadoc-plugin:3.1.1:jar (attach-javadocs) 项目 ...: MavenReportException: Error while 生成 Javadoc：找不到 javadoc 命令：环境 变量 JAVA_HOME 未正确设置。

显而易见的解决方案是设置 JAVA_HOME。但正如我所提到的，我有多个版本的 JDK，所以每次我想使用另一个版本时重新配置 JAVA_HOME 一点也不方便。

另一个解决方案（来自Unable to find javadoc command - maven）是在插件中添加以下配置：

<configuration>
    <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
</configuration>

这使它适用于 Java 11，但会破坏 Java 8，因为在这种情况下，javadoc 的位置是 ${java.home}/../bin/javadoc。

理想情况下，我总是想使用 Maven 使用的 java 可执行文件所在目录中的 javadoc，但我还没有找到使用 Maven Javadoc 插件的方法。

Answer 1

Maven profiles 或许能帮上忙。

在您的 POM 中添加类似的内容。

<profiles>
    <profile>
        <id>jdk-8-config</id>
        <activation>
            <jdk>1.8</jdk>
        </activation>
        <properties>
            <javadocExecutable>${java.home}/../bin/javadoc</javadocExecutable>
        </properties>
    </profile>
    <profile>
        <id>jdk-11-config</id>
        <activation>
            <jdk>11</jdk>
        </activation>
        <properties>
            <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
        </properties>
    </profile>
</profiles>

JDK 范围也是可能的，请阅读链接文档中的更多内容。

Maven 将选择用于运行自身的 Java 版本，激活正确的配置文件，并正确定义属性。

警告 - 通常我们使用 JAVA_HOME 集构建，或者通过 Jenkins 构建，可以配置为每个作业定义 JAVA_HOME。这种方法在这些情况下效果很好。

您还可以研究 Maven 工具链。我没有这些经验，除了阅读它们有助于更轻松地定义各种机器上的工具位置。