Как выполнить ряд целей перед запуском моего плагина Maven?

Question

Я пишу плагин Maven (Mojo), который должен выполнить стандартный набор других исполнений плагина, прежде чем он будет запущен.

Есть ли механизм для объявления всех целей в моем плагине, поэтому мне не нужно полагаться на пользователя, определяющего их все в их POM?

Answer 1

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

В вашем Mojo объявите в Javadoc жизненный цикл, который будет выполнен:

/**
 * Invoke the custom lifecycle before executing this goal.
 * 
 * @goal my-goal
 * @execute lifecycle="my-custom-lifecycle" phase="process-resources"
 */
public class MyMojo extends AbstractMojo {
...

Затем определите пользовательский жизненный цикл в src/main/resources/META-INF/maven/lifecycle.xml.

Жизненный цикл немного похож на plexus component.xml, но позволяет вам указать конфигурацию для этих целей.

Обратите внимание, что синтаксис немного отличается от конфигурации плагинов в pom. Вы определяете цель, используя: как разделитель, а не определяя отдельные элементы groupId, artifactId и version, в противном случае это в значительной степени та же запись, что и у элемента исполнения конфигурации плагина в pom. Вы даже можете использовать некоторые свойства в lifecycle.xml (хотя, возможно, не все свойства поддерживаются, мне нужно это проверить).

В следующем примере плагин зависимостей запускается дважды с различными конфигурациями на этапе ресурсов процесса:

<lifecycles>
  <lifecycle>
    <id>download-dependencies</id>
    <phases>
      <phase>
        <id>process-resources</id>
        <executions>
          <execution>
            <goals>
              <goal>
                org.apache.maven.plugins:maven-dependency-plugin:copy-dependencies
              </goal>
            </goals>
            <configuration>
              <includeScope>compile</includeScope>
              <includeTypes>war</includeTypes>
              <overWrite>true</overWrite>
              <outputDirectory>
                ${project.build.outputDirectory}/wars
              </outputDirectory>
            </configuration>
          </execution>
          <execution>
            <goals>
              <goal>
                org.apache.maven.plugins:maven-dependency-plugin:copy-dependencies
              </goal>
            </goals>
            <configuration>
              <includeScope>compile</includeScope>
              <includeTypes>jar</includeTypes>
              <overWrite>true</overWrite>
              <outputDirectory>
                ${project.build.outputDirectory}/jars
              </outputDirectory>
            </configuration>
          </execution>
        </executions>
      </phase>
    </phases>
  </lifecycle>
</lifecycles>

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

В файле lifecycle.xml вы можете определить несколько этапов и несколько выполнений для каждой фазы жизненного цикла. Доступные фазы определены в жизненном цикле Maven.

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