Загрузка исходников и Javadocs с помощью Maven

1. Обзор

Просмотр исходного кода и документации различных библиотек и фреймворков — хороший способ узнать о них больше.

В этом кратком руководстве мы увидим, как настроить Maven или попросить Maven загрузить для нас источники зависимостей и их Javadocs.

2. Командная строка

По умолчанию Maven загружает только фактический JAR-файл каждой зависимости, а не файлы исходного кода и документации.

Чтобы загрузить только исходники , сначала мы должны перейти в каталог, содержащий pom.xml, а затем выполнить команду:

mvn dependency:sources

Загрузка исходников может занять некоторое время. Точно так же, чтобы загрузить только Javadocs, мы можем ввести команду :

mvn dependency:resolve -Dclassifier=javadoc

Конечно, мы также можем загрузить их обоих одной командой:

mvn dependency:sources dependency:resolve -Dclassifier=javadoc

Очевидно, что если мы добавим новую зависимость после выдачи этих команд, нам придется повторно выдать команды для загрузки исходников и Javadocs для новой зависимости.

3. Настройки Мавена

Также можно загрузить исходные коды и документацию для всей системы по всем проектам 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 загружать исходники и документацию. Более того, Maven применит эти настройки ко всем проектам.

4. Пом.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 нам просто нужно перейти в Preference > Build, Execution, Deployment > Build Tools > Maven > importing и установить флажки для источников и документации:

6. Заключение

В этом кратком руководстве мы увидели, как загружать источники зависимостей и документацию в Maven различными способами, от решений командной строки до конфигураций для каждого проекта или всей системы.