如何在不重新生成javadoc的情况下聚合maven子项目javadoc输出

Question

我有一个更大的多模块Maven构建。我需要为所有模块生成javadoc，并生成一个“聚合”的javadoc结果，我可以将其部署到一个框中供用户使用。

在我尝试实现一个具有特定特性和需求的定制小标签之前，我已经有很长一段时间可以很好地完成这项工作了，这使得这项工作变得更加复杂。

所有子模块继承的父pom不是聚合器pom。在父pom中，我定义了maven javadoc插件。这是我添加自定义taglet之前的样子：

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.10.4</version>
            <configuration>
                <additionalparam>-Xdoclint:none</additionalparam>
                <bottom>Unified Service Layer - bottom</bottom>
                <doctitle>Unified Service Layer - title</doctitle>
                <footer>Unified Service Layer - footer</footer>
                <groups></groups>
                <header>Unified Service Layer - header</header>
                <level>public</level>
                <packagesheader>Unified Service Layer - packagesheader</packagesheader>
                <top>Unified Server Layer - top</top>
                <windowtitle>Unified Service Layer - windowtitle</windowtitle>
            </configuration>
            <executions>
                <execution>
                    <id>module-javadoc-jar</id>
                    <phase>package</phase>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                    <configuration>
                        <show>protected</show>
                        <detectLinks>false</detectLinks>
                    </configuration>
                </execution>
                <execution>
                    <id>aggregated-documentation</id>
                    <phase>package</phase>
                    <inherited>false</inherited>
                    <goals>
                        <goal>aggregate-jar</goal>
                    </goals>
                    <configuration>
                        <show>protected</show>
                        <detectLinks>false</detectLinks>
                    </configuration>
                </execution>
            </executions>
        </plugin>

有了这个，我可以构建所有模块，这些模块将生成自己的javadoc（我现在知道这只是一个验证步骤，因为聚合jar不使用这个输出）。我从jenkins那里调用了一个单独的步骤，它在根项目中运行“javadoc:aggregate-jar”，生成我部署的聚合javadoc-jar。

同样，到目前为止，这种方法一直运行良好。

我实现了一个定制的javadoc标记，它需要访问与它所包含的源文件相关联的类对象。通过在上述配置中添加以下内容，我至少在单个模块构建中实现了这一点：

                <taglets>
                    <taglet>
                        <tagletClass>com.att.det.taglet.ValidationConstraintsTaglet</tagletClass>
                    </taglet>
                    <taglet>
                        <tagletClass>com.att.det.taglet.ValidationConstraintsCombinedTaglet</tagletClass>
                    </taglet>
                </taglets>
                <tagletArtifacts>
                    <tagletArtifact>
                        <groupId>com.att.detsusl.taglets</groupId>
                        <artifactId>validationJavadocTaglet</artifactId>
                        <version>0.0.1-SNAPSHOT</version>
                    </tagletArtifact>
                </tagletArtifacts>

为了让taglet访问类文件，我必须为每个子项目pom.xml添加一个最小的插件配置，如下所示：

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <configuration>
                <tagletArtifacts combine.children="append">
                    <tagletArtifact>
                        <groupId>com.att.detsusl</groupId>
                        <artifactId>artifact-name</artifactId>
                        <version>${current.pom.version}</version>
                    </tagletArtifact>
                </tagletArtifacts>
            </configuration>
        </plugin>

通过这些最小的更改，我可以在每个模块中运行构建，生成javadoc，并检查每个模块中生成的javadoc输出，验证它是否都有效。

然而，问题是，当我在根项目中运行“javadoc:aggregate-jar”时，所有已经构建的输出都会被忽略。它为所有子项目重新运行javadoc生成，同时忽略每个子项目pom中附加的tagletArtifacts列表。xml文件。因此，当它尝试获取类文件时，我得到了ClassNotFound错误。

我可以通过将所有子项目GAVs放入顶级“tagletarti事”列表来“修复”它，但我绝对不想这样做。我喜欢在子项目pom.xml（使用combine.children=“append”）中指定它以使其工作的能力。

我需要的是所有子项目的整体javadoc包，标签能够访问类文件，而无需强制父pom知道其所有子项目。我该怎么做？

Answer 1

我在所有的总目标上都面临着同样的问题。我检查了maven javadoc plugin的源代码，结果表明聚合是通过遍历子模块和收集源文件来完成的，因此完全忽略了子模块中指定的任何表单配置。

在执行过程中，每个子模块都被完全忽略：source

if ( isAggregator() && !project.isExecutionRoot() ) {
    return;
}

在收集源文件的过程中，遍历子模块：source

if ( isAggregator() && project.isExecutionRoot() ) {
    for ( MavenProject subProject : reactorProjects ) {
        if ( subProject != project ) {
            List<String> sourceRoots = getProjectSourceRoots( subProject );

所以目前，没有办法做到这一点。

这也不容易修复，因为整个插件都是通过对实际的javadoc工具进行一次调用来实现的。如果您还想尊重子模块中的设置，则必须合并它们的配置块。虽然这在使用标记工件（tagletArtifacts）的情况下有效，但它并不适用于您可以指定的所有设置，例如任何形式的过滤器，因此无法以通用方式完成。