Interested Article - Apache Maven

Apache Maven — фреймворк для автоматизации сборки проектов на основе описания их структуры в файлах ( англ. ), на языке XML . Проект Maven издаётся сообществом Apache Software Foundation , где формально является частью Jakarta Project .

Название системы является словом из языка идиш , смысл которого можно примерно выразить как «собиратель знания» .

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

Maven используется для построения и управления проектами , написанными на Java , C# , Ruby , Scala , и других языках .

Среди примечательных альтернатив — система автоматической сборки Gradle , построенная на принципах Apache Ant и Maven, но использующая специализированный DSL на Groovy вместо POM-конфигурации.

История разработки

Maven был создан канадцем Ясоном ван Зилом ( Jason van Zyl ) и организованной им фирмой . Он начался как подпроект Apache Turbine в 2002 году, в 2003 году Maven был квалифицирован как Apache-проект верхнего уровня, тогда же появилась его первая версия — Maven 1.x, опубликованная 13 июля 2004 года как версия 1.0. Это происходило, однако, так быстро, что некоторые частности оказались непродуманными, например, слишком много конфигурации, проблемы с производительностью.

Поэтому концепция была доработана и с 2005 года началась параллельная разработка Maven 2.x, которая была сдана в версии 2.0 19 октября 2005 года.

Maven 1.x не разрабатывается дальше и ограничивается поддержкой пользователей и устранением ошибок.

Разработка Maven 3.0 началась в 2008 году. После восьми альфа-релизов, первая бета-версия Maven 3.0 была опубликована в октябре 2010 года. Особенное внимание было уделено её обратной совместимости с Maven 2. Для большинства проектов переход от версии Maven 2 к версии Maven 3 не требует никаких изменений .

Разработка Maven происходит в следующих подпроектах:

Maven 1.x и Maven 2.x — старые версии Maven.
Maven 3.x развивает текущую линию продуктов Maven .
Plugins разрабатывает большинство maven-плагинов.
Shared Components изготовляет компоненты программного обеспечения, которые могут использоваться всеми другими подпроектами.
Ant Tasks позволяет использовать возможности Ant из Maven.
Doxia — фреймворк для генерации контента из форматов Almost Plain Text (APT), Confluence , DocBook , FML ( FAQ Markup Language), LaTeX , Rich Text Format (RTF), TWiki , XDoc и XHTML .
SCM (Source Code Management) разрабатывает программное обеспечение для подключения Apache к различным системам версионирования как CVS или Subversion .
Surefire разрабатывает тест-фреймворк для Maven-а.
Wagon готовит абстракцию коммуникационных протоколов как «доступ к файлам», HTTP или FTP .

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

Информация для сборки проекта, поддерживаемого Apache Maven, содержится в XML -файле с названием pom.xml . При запуске Maven проверяет, содержит ли конфигурационный файл все необходимые данные и все ли данные синтаксически правильно записаны.

Пример файла pom.xml :

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

  <!-- зависимости от библиотек -->
  
  <dependencies>
    <dependency>
    
      <!-- координаты необходимой библиотеки -->
      
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      
      <!-- эта библиотека используется только для запуска и компилирования тестов -->
      
      <scope>test</scope>
      
    </dependency>
  </dependencies>
</project>

Минимальная конфигурация включает версию конфигурационного файла, имя проекта, его автора и версию . С помощью pom.xml конфигурируются зависимости от других проектов, индивидуальные фазы процесса построения проекта (build process), список плагинов , реализующих порядок сборки .

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

POM-файлы подпроектов могут наследовать конфигурацию от других файлов конфигурации. В то же время все файлы конфигурации обязательно наследуются от «Супер POM» файла по умолчанию. Супер POM обеспечивает конфигурацию по умолчанию, например, стандартная структура каталогов, используемые по умолчанию плагины, привязка к фазам жизненного цикла и прочее.

Основные концепции

Соглашения по конфигурации

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

Архетипы

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

Maven использует принцип Maven-архетипов (англ. Archetypes ). Архетип — это инструмент шаблонов, каждый из которых определён паттерном или моделью, по аналогии с которой создаются производные.

Стандартная структура каталогов — одна из реализаций принципа архетипов в Maven. Следующая структура показывает важнейшие каталоги для проекта на Java :

Корневой каталог проекта: файл pom.xml и все дальнейшие подкаталоги
- src : все исходные файлы
  - src/main : исходные файлы собственно для продукта
    - src/main/java : исходный текст на Java
    - src/main/resources : другие файлы, которые используются при компиляции или исполнении, например properties-файлы
  - src/test : исходные файлы, необходимые для организации автоматического тестирования
    - src/test/java : JUnit -тест-задания для автоматического тестирования
- target : все создаваемые в процессе работы Мавена файлы
  - target/classes : компилированные Java-классы

Жизненный цикл

Жизненный цикл maven-проекта — это список поименованных фаз, определяющий порядок действий при его построении. Жизненный цикл Maven содержит три независимых порядка выполнения:

clean — жизненный цикл для очистки проекта. Содержит следующие фазы:
1. pre-clean
2. clean
3. post-clean
default — основной жизненный цикл, содержащий следующие фазы:
1. validate — выполняется проверка, является ли структура проекта полной и правильной.
2. generate-sources
3. process-sources
4. generate-resources
5. process-resources
6. compile — компилируются исходные тексты.
7. process-test-sources
8. process-test-resources
9. test-compile
10. test — собранный код тестируется заранее подготовленным набором тестов.
11. package — упаковка откомпилированных классов и прочих ресурсов. Например, в JAR-файл.
12. integration-test — программное обеспечение в целом или его крупные модули подвергаются интеграционному тестированию. Проверяется взаимодействие между составными частями программного продукта.
13. install — установка программного обеспечения в локальный Maven-репозиторий, чтобы сделать его доступным для других проектов текущего пользователя.
14. deploy — стабильная версия программного обеспечения распространяется на удаленный Maven-репозиторий, чтобы сделать его доступным для других пользователей.
site — жизненный цикл генерации проектной документации. Состоит из фаз:
1. pre-site
2. site
3. post-site
4. site-deploy

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

Архитектура

Maven базируется на plugin -архитектуре, которая позволяет применять плагины для различных задач ( англ. compile, test, build, deploy, checkstyle, pmd, scp-transfer ) для данного проекта, без необходимости их в явном виде инсталлировать. Это возможно за счет того, что информация поступает плагину через стандартный вход, а результаты пишутся в его стандартный выход. Теоретически, это позволяет кому угодно писать плагины для взаимодействия со средствами построения проекта (компиляторы, средства тестирования, и так далее) для любого другого языка. В реальности, поддержка других языков кроме Java сейчас минимальна. Существует плагин для .NET-фреймворка , а также плагины для C / C++ .

Количество доступных плагинов в настоящее время очень велико и включает, в том числе, плагины, позволяющие непосредственно из Maven запускать web-приложение для тестирования его в браузере; плагины, позволяющие тестировать или создавать банки данных; плагины, позволяющие генерировать Web Services. Задачей разработчика в такой ситуации является найти и применить наиболее подходящий набор плагинов.

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

 mvn [имя плагина]:[имя цели]

Например, Java-проект может быть скомпилирован плагином-компилятором путём выполнения команды mvn compiler:compile .

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

Зависимости

В файле pom.xml задаются зависимости, которые имеет управляемый с помощью Maven проект. Менеджер зависимостей основан на нескольких основных принципах:

Репозитории. Maven ищет необходимые файлы в локальных каталогах или в локальном maven-репозитории. Если зависимость не может быть локально разрешена, Maven подключается к указанному maven-репозиторию в сети и копирует в локальный репозиторий. По умолчанию Maven использует Maven Central Repository , но разработчик может конфигурировать и другие публичные Maven-репозитории, такие, как Apache, Ibiblio, Codehaus или Java.Net.
Транзитивные зависимости. Необходимые библиотеки подгружаются в проект автоматически. При разрешении конфликта версий используется принцип «ближайшей» зависимости, то есть выбирается зависимость, путь к которой через список зависимых проектов является наиболее коротким.
Исключение зависимостей. Файл описания проекта предусматривает возможность исключить зависимость в случае обнаружения цикличности или отсутствия необходимости в определённой библиотеке.
Поиск зависимостей. Поиск зависимостей (open-source-библиотек и модулей) ведётся по их координатам (groupId, artifactId и version). Эти координаты могут быть определены с помощью специальных поисковых машин, например, Maven search engine . Например, по поисковому признаку «pop3» поисковая машина предоставляет результат с groupId="com.sun.mail" и artifactId="pop3".
Менеджеры репозиториев. Репозитории реализуются с помощью менеджеров репозиториев Maven (Maven Repository Manager), таких как Apache Archiva, Nexus (ранее Proximity), Artifactory, Codehaus Maven Proxy или Dead Simple Maven Proxy .

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

compile. Область по умолчанию. Зависимость доступна во всех путях поиска классов в проекте. Распространяется на зависимые проекты.
provided. Область аналогична compile, за исключением того, что JDK или контейнер сам предоставит зависимость во время выполнения программы.
runtime. Зависимость не нужна для компиляции, но нужна для выполнения.
test. Зависимость не нужна для нормальной работы приложения, а нужна только для компиляции и запуска тестов.
system. Область аналогична provided за исключением того, что содержащий зависимость JAR указывается явно. Артефакт не ищется в репозитории.
import (начиная с версии Maven 2.0.9) используется только с зависимостью типа pom в секции <dependencyManagement> . Зависимости текущего POM заменяются на зависимости из указанного POM.

Приведение проекта к виду Maven

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

Для того, чтобы Maven распознал проект, как подлежащий обработке, он должен содержать установленную структуру каталогов. Все файлы с исходным кодом должны находиться по относительному пути « \src\main\java » .

Файл конфигурации web-проекта web.xml должен находиться в каталоге « \src\main\webapp\WEB-INF » .

Файл конфигурации Maven-проекта pom.xml должен находиться в корневом каталоге проекта. В нём согласно его предназначению могут быть указаны удаленный репозиторий, плагины для создания архивов, плагин компилятора и прочее. Для web-проекта также необходимо добавлять дополнительные зависимости, как например javaee.jar.

Таким образом, выходной файл конфигурации веб-проекта, согласованный с Maven, выглядит следующим образом:

<project xmlns="http://maven.apache.org/POM/4.0.0" 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.mkyong</groupId>
  <artifactId>servletdemo</artifactId>
  <packaging>war</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>servletdemo</name>
  <url>http://maven.apache.org</url>

  <repositories>
    <repository>
      <id>java.net</id>
      <url>http://download.java.net/maven/2</url>
    </repository>
  </repositories>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-war-plugin</artifactId>
        <configuration>
          <webResources>
            <resource>
              <directory>${basedir}/src/main/java</directory>
              <targetPath>WEB-INF/classes</targetPath>
              <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
                <include>**/*.css</include>
                <include>**/*.html</include>
              </includes>
            </resource>
          </webResources>
        </configuration>
      </plugin>
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.6</source>
          <target>1.6</target>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

После выполнения всех указанных требований Maven-проект готов для выполнения фаз жизненного цикла, таких, как компиляция, сборка архива и генерация документации .

Пример выходного лога сообщений при выполнении команды mvn war:war :

E:\workspace\servletdemo>mvn war:war
[INFO] Scanning for projects...
.......
[INFO] Processing war project
[INFO] Copying webapp resources[E:\workspace\servletdemo]
[INFO] Webapp assembled in[47 msecs]
[INFO] Building war: E:\workspace\servletdemo\target\servletdemo-1.0-SNAPSHOT.war
[INFO] -----------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] -----------------------------------------------

Взаимодействие со средами разработки

Для некоторых интегрированных сред разработки Maven содержит плагины, позволяющие управлять жизненным циклом, выполняя команды при помощи интерфейса IDE. Список таких сред разработки включает Eclipse (через плагин M2eclipse ), IntelliJ IDEA , NetBeans , JBuilder , JDeveloper (версия 11.1.2), MyEclipse, Emacs

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

Примечания

(англ.) — 2007.
— 2006.
(неопр.) . Дата обращения: 26 февраля 2012. 19 февраля 2012 года. POM
(неопр.) Дата обращения: 25 февраля 2012. 21 февраля 2012 года.
Apache Maven Community. (неопр.) . Apache Maven Project . Дата обращения: 18 декабря 2015. 13 декабря 2015 года.
от 11 февраля 2012 на Wayback Machine .
15 февраля 2012 года.
↑ Apache Maven Foundation. (неопр.) . Apache Maven Docs . Дата обращения: 20 декабря 2015. 19 декабря 2015 года.
↑ Apache Foundations. (неопр.) . Apache Maven Project . Дата обращения: 6 октября 2007. 19 ноября 2017 года.
от 19 ноября 2017 на Wayback Machine .
от 15 сентября 2020 на Wayback Machine .
(неопр.) Дата обращения: 28 октября 2016. 14 сентября 2016 года.
Apache Maven Foundation. (неопр.) Дата обращения: 18 декабря 2015. 22 декабря 2015 года.
↑ от 21 февраля 2012 на Wayback Machine .
от 17 ноября 2017 на Wayback Machine .
от 27 октября 2016 на Wayback Machine .
от 29 октября 2016 на Wayback Machine .
от 20 декабря 2017 на Wayback Machine .
от 15 декабря 2017 на Wayback Machine .
от 24 июля 2017 на Wayback Machine .
от 26 апреля 2020 на Wayback Machine .
от 26 апреля 2020 на Wayback Machine .
23 ноября 2012 года.
Apache Maven Foundation. (неопр.) . Дата обращения: 18 декабря 2015. 20 декабря 2015 года.
от 21 февраля 2012 на Wayback Machine .
Apache Foundation. (неопр.) . Apache Maven Documentation . Дата обращения: 21 декабря 2015. 3 января 2016 года.
от 3 ноября 2013 на Wayback Machine .

Ссылки

(англ.)
(англ.)
(англ.)
от 9 ноября 2010 на Wayback Machine (рус.)
Murali Kashaboina; Geeth Narayanan.: (англ.) . «Eclipse Developer's Journal» (3 июля 2007). Дата обращения: 14 октября 2008. 29 февраля 2012 года.
Синг Ли. (рус.) . «IBM developerWorks Россия» (25 июня 2006). Дата обращения: 14 октября 2008. 29 февраля 2012 года.
Нил Санче. (рус.) . «IBM developerWorks Россия» (19 июля 2007). — Совместное применение Maven, Struts и XDoclet. Дата обращения: 14 октября 2008. 29 февраля 2012 года.
Алексей Литвинюк. (рус.) . «Компьютерная газета». Дата обращения: 4 сентября 2009. Архивировано из 3 июня 2010 года.

Выговский Леонид. (рус.) (5 января 2010). — В статье дается подробная инструкция по установке maven-репозитория на сервере приложенй Glassfish или контейнере сервлетов Apache Tomcat. Дата обращения: 5 января 2010. 29 февраля 2012 года.