Апач Мавен

Апач Мавен

Разработчики)	Фонд программного обеспечения Apache
Начальная версия	13 июля 2004 г ( 13 июля 2004 г. )
Стабильная версия	3.9.7  / 22 мая 2024 г ( 22 мая 2024 г. )
Репозиторий	github .с /апач /мавен
Написано в	Джава
Тип	Инструмент сборки
Лицензия	Лицензия Апач 2.0
Веб-сайт	знаток .apache .org

Maven — это инструмент автоматизации сборки , используемый в основном для Java проектов . Maven также можно использовать для создания и управления проектами, написанными на C# , Ruby , Scala и других языках. Проект Maven поддерживается The Apache Software Foundation , где он ранее был частью проекта Jakarta .

Maven рассматривает два аспекта создания программного обеспечения: способ создания программного обеспечения и его зависимости. В отличие от более ранних инструментов, таких как Apache Ant , он использует соглашения для процедуры сборки. Необходимо указать только исключения. XML - файл описывает собираемый программный проект, его зависимости от других внешних модулей и компонентов, порядок сборки, каталоги и необходимые плагины . Он поставляется с заранее определенными целями для выполнения определенных четко определенных задач, таких как компиляция кода и его упаковка. Maven динамически загружает библиотеки Java и подключаемые модули Maven из одного или нескольких репозиториев, таких как центральный репозиторий Maven 2, и сохраняет их в локальном кеше. Этот локальный кэш загруженных артефактов также можно обновлять артефактами, созданными локальными проектами. Публичные репозитории также можно обновлять.

Maven построен с использованием архитектуры на основе плагинов, которая позволяет использовать любое приложение, управляемое через стандартный ввод. C / C ++ . Для Maven 2 поддерживается собственный плагин

Альтернативные технологии, такие как Gradle и sbt, в качестве инструментов сборки не полагаются на XML , но сохраняют ключевые концепции, представленные Maven. В Apache Ivy также был разработан специальный менеджер зависимостей, который также поддерживает репозитории Maven.

Apache Maven поддерживает воспроизводимые сборки .

История

Количество артефактов в центральном репозитории Maven быстро росло.

Maven был создан Джейсоном ван Зилом в 2002 году и начинался как подпроект Apache Turbine . высшего уровня В 2003 году Maven был принят в качестве проекта Apache Software Foundation .

История версий:

• Версия 1 — июль 2004 г. — первый важный выпуск (сейчас срок его эксплуатации истек).
• Версия 2 — октябрь 2005 г. — примерно через шесть месяцев в бета-циклах (сейчас срок службы истек).
• Версия 3 — октябрь 2010 г. — остается в основном обратно совместимой с проектами Maven 2. Изменения включали переработку основного Project Builder и поддержку параллельных сборок. Переработка ядра разделила файловое представление и представление в памяти и позволила надстройкам использовать файлы определения проекта, не основанные на XML. Предлагаемые языки включают Ruby (уже в частном прототипе Джейсона ван Зила), YAML и Groovy . Функция параллельной сборки использует настраиваемое количество ядер на многоядерной машине и особенно подходит для крупных многомодульных проектов.
• Версия 4 — в настоящее время находится в стадии альфа-разработки (по состоянию на конец 2023 г.).

Синтаксис

Проекты Maven настраиваются с использованием объектной модели проекта (POM) в pom.xml файл.

Пример файла:

<project> 
   <!-- версия модели всегда равна 4.0.0 для POM Maven 2.x --> 
   <modelVersion>  4.0.0  </modelVersion> 
  
   <!-- координаты проекта, т. е. группа значений, которые однозначно идентифицируют этот проект --> 
   <groupId>  com.mycompany.app  </groupId> 
   <artifactId>  my-app  </artifactId> 
   <version>  1.0  </version> 

   <!-- зависимости библиотеки --> < 
   зависимости> 

       <!-- координаты необходимой библиотеки. 
  Область действия — «тест», что указывает на то, что библиотека 
 используется только для запуска тестов.   --> 
       <dependent> 
           <groupId>  org.junit.jupiter  </groupId> 
           <artifactId>  junit-jupiter-engine  </artifactId> 
           <version>  5.9.1  </version> 
           <scope>  test  </scope> 
       </ зависимость> < 

   /зависимости> 
 </проект> 

Этот POM определяет уникальный идентификатор проекта ( координаты ) и единственную зависимость от библиотеки JUnit . Однако этого уже достаточно для сборки проекта и выполнения модульных тестов связанных с ним . Maven достигает этого, используя идею Соглашения над Конфигурацией , то есть Maven предоставляет значения по умолчанию для конфигурации проекта.

Структура каталогов обычного идиоматического проекта Maven имеет следующие записи каталогов:

Структура каталогов для проекта Java, автоматически созданная Maven.

Имя каталога	Цель
проект дома	Содержит pom.xml и все подкаталоги.
src/main/java	Содержит исходный код Java для проекта.
src/main/resources	Содержит доставляемые ресурсы для проекта, такие как файлы свойств.
src/test/java	Содержит исходный код Java для тестирования (например, тестовые примеры JUnit или TestNG) для проекта.
src/test/resources	Содержит ресурсы, необходимые для тестирования.

Команда mvn package скомпилирует все файлы Java, выполнит все тесты и упакует готовый код и ресурсы в target/my-app-1.0.jar (при условии, что идентификатор артефакта — мое приложение, а версия — 1.0.)

Используя Maven, пользователь предоставляет только конфигурацию проекта, в то время как настраиваемые плагины выполняют фактическую работу по компиляции проекта, очистке целевых каталогов, запуску модульных тестов, созданию документации API и так далее. В общем, пользователям не придется писать плагины самостоятельно. Сравните это с Ant и make , в которых пишутся императивные процедуры для выполнения вышеупомянутых задач.

Дизайн

Объектная модель проекта

Объектная модель проекта (POM) предоставляет всю конфигурацию для одного проекта. Общая конфигурация охватывает имя проекта, его владельца и его зависимости от других проектов. Также можно настроить отдельные этапы процесса сборки, которые реализованы в виде плагинов . Например, можно настроить плагин-компилятор на использование Java версии 1.5 для компиляции или указать упаковку проекта, даже если некоторые модульные тесты не пройдены.

Более крупные проекты следует разделить на несколько модулей или подпроектов, каждый со своим POM. Затем можно написать корневой POM, с помощью которого можно скомпилировать все модули одной командой. POM также могут наследовать конфигурацию от других POM. Все POM наследуются от Super POM. по умолчанию. Super POM предоставляет конфигурацию по умолчанию, такую ​​как исходные каталоги по умолчанию, плагины по умолчанию и т. д.

Плагины

Большая часть функциональности Maven находится в плагинах . Плагин предоставляет набор целей, которые можно выполнить с помощью команды mvn [plugin-name]:[goal-name]. Например, проект Java можно скомпилировать с помощью цели компиляции плагина компилятора. запустив mvn compiler:compile.

Существуют плагины Maven для сборки, тестирования, управления исходным кодом, запуска веб-сервера, создания файлов проекта Eclipse и многого другого. Плагины представлены и настроены в разделе <plugins> файла pom.xmlфайл. Некоторые базовые плагины включены в каждый проект по умолчанию и имеют разумные настройки по умолчанию.

Однако было бы затруднительно, если бы архетипическая последовательность сборки, тестирования и упаковки программного проекта требовала выполнения каждой соответствующей цели вручную:

• mvn compiler:compile
• mvn surefire:test
• mvn jar:jar

Концепция жизненного цикла Maven решает эту проблему.

Плагины — это основной способ расширения Maven. Разработку плагина Maven можно выполнить путем расширения класса org.apache.maven.plugin.AbstractMojo. Пример кода и объяснение плагина Maven для создания облачной виртуальной машины с сервером приложений приведены в статье Автоматизация разработки и управления облачными виртуальными машинами .

Жизненные циклы сборки

Жизненный цикл сборки представляет собой список именованных этапов , которые можно использовать для упорядочения выполнения цели. Одним из трех стандартных жизненных циклов Maven является жизненный цикл по умолчанию , который включает в себя следующие этапы, выполняемые в указанном порядке:

• подтвердить
• генерировать-источники
• источники процессов
• генерировать ресурсы
• процесс-ресурсы
• компилировать
• исходники-процессов-тестов
• процесс-тест-ресурсы
• тестовая компиляция
• тест
• упаковка
• установить
• развертывать

Цели, предоставляемые плагинами, могут быть связаны с разными этапами жизненного цикла. Например, по умолчанию цель compiler:compile связано с compile фаза, а цель surefire:test связано с testфаза. Когда mvn test команда выполняется, Maven выполняет все цели, связанные с каждой фазой, вплоть до testфаза. В таком случае Maven запускает resources:resources цель, связанная с process-resources фаза, тогда compiler:compileи так далее, пока, наконец, не запустится surefire:test цель.

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

Стандартные жизненные циклы дают пользователям, впервые участвующим в проекте, возможность точно собирать, тестировать и устанавливать каждый проект Maven, введя одну команду. mvn install. По умолчанию Maven упаковывает файл POM в сгенерированные файлы JAR и WAR. Такие инструменты, как Diet4j можно использовать эту информацию для рекурсивного разрешения и запуска модулей Maven во время выполнения без необходимости использования jar-файла uber, содержащего весь код проекта.

Зависимости

Центральной функцией Maven является управление зависимостями . Механизм обработки зависимостей Maven организован вокруг системы координат, идентифицирующей отдельные артефакты, такие как программные библиотеки или модули. В приведенном выше примере POM координаты JUnit ссылаются на прямую зависимость проекта. Проект, которому нужна, скажем, библиотека Hibernate , просто должен объявить координаты проекта Hibernate в своем POM. Maven автоматически загрузит зависимость и те зависимости, которые нужны самому Hibernate (так называемые транзитивные зависимости ) и сохранит их в локальном репозитории пользователя. Maven 2 Центральный репозиторий по умолчанию используется для поиска библиотек, но можно настроить используемые репозитории (например, частные репозитории компании) внутри POM.

Фундаментальное различие между Maven и Ant заключается в том, что дизайн Maven рассматривает все проекты как имеющие определенную структуру и набор поддерживаемых рабочих процессов задач (например, получение ресурсов из системы контроля версий, компиляция проекта, модульное тестирование и т. д.). Хотя большинство программных проектов фактически поддерживают эти операции и фактически имеют четко определенную структуру, Maven требует, чтобы эта структура и детали реализации операции были определены в файле POM. Таким образом, Maven опирается на соглашение о том, как определять проекты и на список рабочих процессов, которые обычно поддерживаются во всех проектах.

Существуют поисковые системы, такие как The Central Repository Search Engine, который можно использовать для определения координат различных библиотек и фреймворков с открытым исходным кодом.

Проекты, разработанные на одной машине, могут зависеть друг от друга через локальный репозиторий. Локальный репозиторий представляет собой простую структуру папок, которая действует как кэш для загруженных зависимостей и как централизованное место хранения локально созданных артефактов. Команда Maven mvn installсобирает проект и помещает его двоичные файлы в локальный репозиторий. Затем другие проекты смогут использовать этот проект, указав его координаты в своих POM.

Совместимость

Существуют надстройки к нескольким популярным интегрированным средам разработки (IDE), ориентированным на язык программирования Java, которые обеспечивают интеграцию Maven с механизмом сборки IDE и инструментами редактирования исходного кода, позволяя Maven компилировать проекты из IDE, а также устанавливать путь к классам для завершение кода, выделение ошибок компилятора и т. д.

Примеры популярных IDE, поддерживающих разработку с помощью Maven, включают:

• Затмение
• NetBeans
• Я понимаю идею
• JBuilder
• JDeveloper (версия 11.1.2)
• MyEclipse
• Код Visual Studio

Эти надстройки также предоставляют возможность редактировать POM или использовать POM для определения полного набора зависимостей проекта непосредственно в IDE.

Некоторые встроенные функции IDE теряют силу, когда IDE больше не выполняет компиляцию. Например, JDT Eclipse имеет возможность перекомпилировать один исходный файл Java после его редактирования. Многие IDE работают с плоским набором проектов вместо иерархии папок, предпочитаемой Maven. Это усложняет использование систем SCM в IDE при использовании Maven.

См. также

• Апач Континуум
• Апачское желе
• Хадсон
• Дженкинс
• Список программного обеспечения для автоматизации сборки

Дальнейшее чтение

• О'Брайен, Тим; и другие. «Maven: Полный справочник» . Sonatype.com . Сонатип . Проверено 15 марта 2013 г.
• Maven: Полное руководство . Компания Сонатайп. O'Reilly Media, Inc. 2009. с. 470. ИСБН  9780596551780 . Проверено 17 апреля 2013 г. {{cite book}}: CS1 maint: другие ( ссылка )
• Ван Зил, Джейсон (01 октября 2008 г.), Maven: Definitive Guide (первое издание), O'Reilly Media , стр. 468 , ISBN  978-0-596-51733-5
• «Запуск тестов JUnit из Maven2». JUnit в действии (2-е изд.). Публикации Мэннинга . 2011. стр. 152–168. ISBN  978-1-935182-02-3 .
• Настройка сборки Maven . Пакет. 2013. стр. 1–250. ISBN  9781783987221 .
• Освоение Apache Maven 3 . Пакеты. 2014. с. 298. ИСБН  9781783983865 .

Внешние ссылки

• Официальный веб-сайт