Изтеглете източници и 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

Също така е възможно да изтеглите източници и документация в цялата система за всички проекти на Maven . За целта трябва да редактираме файла ~ / m2 / settings.xml или да създадем такъв и да добавим следната конфигурация към него:

    downloadSources  true true     downloadSources  

Както е показано по-горе, ние създаваме профил и го активираме по подразбиране. В този профил задаваме две свойства, които казват на Maven да изтегля източници и документация. Освен това Maven ще приложи тези настройки за всички проекти.

4. Pom.xml

Възможно е дори да поставите тази конфигурация в pom.xml . По този начин принуждаваме всички участници в проекта да изтеглят източници и документация като част от разрешаването на зависимости :

   org.apache.maven.plugins maven-dependency-plugin 3.1.2    sources resolve   javadoc      

Тук конфигурираме приставката maven-dependency за изтегляне на източниците и документацията.

5. Настройка на IDE

Можем също така да настроим нашите любими IDE да правят това вместо нас. Например в IntelliJ IDEA трябва само да отидем на Предпочитания> Изграждане, изпълнение, внедряване> Инструменти за изграждане> Maven> импортиране и отметка в квадратчетата за източници и документация:

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

В този бърз урок видяхме как да изтеглите източници на зависимости и документация в Maven по различни начини, вариращи от решения на командния ред до конфигурации за всеки проект или система.