plugins - 如何检查和访问 Maven Artifacts 的 javadoc/source

Question

我正在编写一个 Maven 插件，需要检查某个项目是否依赖项有可用的 javadoc 和源...如果是这样，希望下载它们并将它们存档在服务器上。

我不知道如何检查 javadoc 和源代码是否可用或者如何访问它们(如果有)。

如有任何帮助，我们将不胜感激。

Answer 1

您可以通过将分类器标记添加到依赖项来引用其他工件。分类器是存储库中工件名称的附加部分，例如 junit-4.5-sources.jar

因此，要直接声明对 junit 源 jar 的依赖关系，您可以按如下方式指定它:

<dependency>
  <groupId>junit</groupId>
  <artifactId>junit</artifactId>
  <version>4.5</version>
  <classifier>sources</classifier>
  <scope>test</scope>
</dependency>

如果要下载所有依赖项源，请使用 maven-dependency-plugin 的复制依赖项目标指定分类器源。以下示例定义了两种执行，一种用于源，一种用于 javadocs。

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-dependency-plugin</artifactId>
      <executions>
        <execution>
          <id>sources</id>
          <phase>package</phase>
          <goals>
            <goal>copy-dependencies</goal>
          </goals>
          <configuration>
            <classifier>sources</classifier>
            <failOnMissingClassifierArtifact>false</failOnMissingClassifierArtifact>
            <outputDirectory>${project.build.directory}/sources</outputDirectory>
          </configuration>
        </execution>
        <execution>
          <id>javadocs</id>
          <phase>package</phase>
          <goals>
            <goal>copy-dependencies</goal>
          </goals>
          <configuration>
            <classifier>javadoc</classifier>
            <failOnMissingClassifierArtifact>false</failOnMissingClassifierArtifact>
            <outputDirectory>${project.build.directory}/javadocs</outputDirectory>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

如果要将所有下载的工件打包为 zip，可以使用 maven-assemble-plugin 创建项目的存档。下面的示例是包含源代码和 javadocs 目录的程序集描述 rune 件的内容:

<assembly>
  <id>project</id>
  <formats>
    <format>zip</format>
  </formats>
  <fileSets>
    <fileSet>
      <directory>${project.basedir}</directory>
      <useDefaultExcludes>true</useDefaultExcludes>
      <includes>
        <include>${project.build.directory}/sources</include>
        <include>${project.build.directory}/javadocs</include>
      </includes>
    </fileSet>
  </fileSets>
</assembly>

要引用程序集，请将插件配置添加到您的 pom.xml 中。假设上述内容已放入 src/main/assemble/sources.xml 中(确保它是在上面的依赖配置之后定义的):

<plugin>
  <artifactId>maven-assembly-plugin</artifactId>
  <version>2.2-beta-4</version>
  <executions>
    <execution>
      <phase>package</phase>
      <goals>
        <goal>single</goal>
      </goals>
      <configuration>
        <descriptors>
           <descriptor>src/main/assembly/sources.xml</descriptor>
        </descriptors>
      </configuration>
    </execution>
  </executions>
</plugin>