MavenでソースとJavadocをダウンロードする

投稿日: 2022-11-10 2022-11-10
タグ: Maven

1. 概要

さまざまなライブラリやフレームワークのソースコードとドキュメントを確認することは、それらについてさらに学ぶための良い方法です。

この短いチュートリアルでは、依存関係のソースとそのJavadocをダウンロードするためにMavenを構成する方法、またはMavenに依頼する方法を説明します。

2. コマンドライン

デフォルトでは、Mavenは各依存関係の実際のJARファイルのみをダウンロードし、ソースおよびドキュメントファイルはダウンロードしません。

ソースのみをダウンロードするには、最初に pom.xmlを含むディレクトリに移動してから、次のコマンドを実行する必要があります：

mvn dependency:sources

ソースのダウンロードには時間がかかる場合があります。同様に、 Javadocのみをダウンロードするには、コマンドを発行できます。

mvn dependency:resolve -Dclassifier=javadoc

もちろん、1つのコマンドで両方をダウンロードすることもできます。

mvn dependency:sources dependency:resolve -Dclassifier=javadoc

明らかに、これらのコマンドを発行した後に新しい依存関係を追加する場合は、新しい依存関係のソースとJavadocをダウンロードするためにコマンドを再発行する必要があります。

3. Maven設定

すべてのMavenプロジェクトでシステム全体のソースとドキュメントをダウンロードすることも可能です。これを行うには、〜/ m2 / settings.xml ファイルを編集するか、ファイルを作成して次の構成を追加する必要があります。

<settings>
    <!-- ... other settings omitted ... -->
    <profiles>
        <profile>
            <id>downloadSources</id>
            <properties>
                <downloadSources>true</downloadSources>
                <downloadJavadocs>true</downloadJavadocs>
            </properties>
        </profile>
    </profiles>

    <activeProfiles>
        <activeProfile>downloadSources</activeProfile>
    </activeProfiles>
</settings>

上に示したように、デフォルトでプロファイルを作成してアクティブ化します。このプロファイルでは、ソースとドキュメントをダウンロードするようにMavenに指示する2つのプロパティを設定しています。さらに、Mavenはこれらの設定をすべてのプロジェクトに適用します。

4. pom.xml

この構成をpom.xmlに入れることも可能です。 このようにして、すべてのプロジェクト貢献者に、依存関係の解決の一環としてソースとドキュメントをダウンロードするように強制します：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <version>3.1.2</version>
            <executions>
                <execution>
                    <goals>
                        <goal>sources</goal>
                        <goal>resolve</goal>
                    </goals>
                    <configuration>
                        <classifier>javadoc</classifier>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

ここでは、ソースとドキュメントをダウンロードするようにmaven-dependency-pluginを構成しています。

5. IDEセットアップ

これを行うために、お気に入りのIDEをセットアップすることもできます。たとえば、IntelliJ IDEAでは、環境設定>ビルド、実行、デプロイメント>ビルドツール> Maven>インポートに移動し、ソースとドキュメントのチェックボックスをオンにするだけです。

6. 結論

このクイックチュートリアルでは、コマンドラインソリューションからプロジェクトごとまたはシステム全体の構成に至るまで、さまざまな方法でMavenに依存関係のソースとドキュメントをダウンロードする方法を説明しました。

getdocs

13036