Упаковка фляги в дистрибутив с разделенными внешними ресурсами и зависимостями - PullRequest
Новая
       45

Упаковка фляги в дистрибутив с разделенными внешними ресурсами и зависимостями

15 голосов
/ 17 ноября 2010

Вот что я пытаюсь достичь - каталог dist (или zip-файл), который выглядит следующим образом: 

dist/
|-- application-1.0.jar
|-- conf/
    |-- application.properties
    |-- log4j.properties
|-- lib/
    |-- *.jar

В основном:

  • Исполняемый файлсоздается jar (с соответствующим classpath в манифесте)
  • Я хочу исключить src/main/resources из автоматической упаковки вместе с jar, так что application.properties можно изменить
  • Я хочу иметьвнешние зависимости в каталоге lib/

Я придумал решение, используя профиль с плагинами, прикрепленными к фазе пакета, но будет ли лучше использовать плагин сборки?

Ответы [ 2 ]

8 голосов
/ 17 ноября 2010

Решение с использованием сборочного плагина состоит из нескольких частей:

  • В состав pom входит настройка подключаемого модуля jar (maven-jar-plugin) и настройка подключаемого модуля сборки (maven-assembly-plugin).
  • На этапе упаковки maven вызывается плагин jar для создания jar приложения.
  • Затем запускается плагин сборки, который объединяет созданный файл jar, ресурсы и зависимости в zip-файл, как определено файлом сборки (distribution-zip.xml).

В pom настройте плагины: 

<build>
    <plugins>
        <plugin>
            <artifactId>maven-jar-plugin</artifactId>
            <version>2.2</version>
            <configuration>
                <archive>
                    <!-- Make an executable jar, adjust classpath entries-->
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <classpathPrefix>./lib/</classpathPrefix>
                        <mainClass>com.acme.KillerApp</mainClass>
                    </manifest>
                    <!--Resources will be placed under conf/-->
                    <manifestEntries>
                        <Class-Path>./conf/</Class-Path>
                    </manifestEntries>
                </archive>
                <!--exclude the properties file from the archive-->
                <excludes>
                    <exclude>*.properties</exclude>
                </excludes>
            </configuration>
        </plugin>

        <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>2.2-beta-5</version>
            <configuration>
                <descriptors>
                    <descriptor>${basedir}/assembly/distribution-zip.xml</descriptor>
                </descriptors>
            </configuration>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
...

Содержимое файла сборки distribution-zip.xml (благодаря Neeme Praks ) объединяет созданный jar, ресурсы и зависимости: 

<assembly>
    <id>dist</id>
    <formats>
        <format>zip</format>
    </formats>

    <includeBaseDirectory>true</includeBaseDirectory>

    <dependencySets>
        <dependencySet>
            <!--Include runtime dependencies-->
            <outputDirectory>lib</outputDirectory>
            <scope>runtime</scope>
        </dependencySet>
    </dependencySets>

    <fileSets>
        <fileSet>
            <!--Get the generated application jar-->
            <directory>${project.build.directory}</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>*.jar</include>
            </includes>
        </fileSet>
        <fileSet>
            <!--Get application resources-->
            <directory>src/main/resources</directory>
            <outputDirectory>conf</outputDirectory>
        </fileSet>
        <fileSet>
            <!--Get misc user files-->
            <directory>${project.basedir}</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>README*</include>
                <include>LICENSE*</include>
                <include>NOTICE*</include>
            </includes>
        </fileSet>       
    </fileSets>
</assembly>

Получаемый в результате распространяемый zip-файл создается как target/killer-app-1.0-dist.zip!

4 голосов
/ 17 ноября 2010

Для этого нужно использовать два плагина: maven-jar-plugin и maven-assembly-plugin .

Полезные pom.xml образцы:

(Я бы порекомендовал вам разделить редактируемые пользователем файлы свойств в отдельном каталоге, но это дело вкуса.)

Пример конфигурации сборки для начала работы: 

<assembly>
  <id>dist</id>
  <formats>
    <format>zip</format>
  </formats>
  <includeBaseDirectory>true</includeBaseDirectory>
  <baseDirectory>dist</baseDirectory>
  <dependencySets>
    <dependencySet>
      <outputDirectory>lib</outputDirectory>
      <scope>runtime</scope>
    </dependencySet>
  </dependencySets>
  <fileSets>
    <fileSet>
      <directory>src/conf</directory>
      <outputDirectory>conf</outputDirectory>
    </fileSet>
    <fileSet>
      <directory>src/run</directory>
      <outputDirectory></outputDirectory>
      <excludes>
        <exclude>*.sh</exclude>
      </excludes>
    </fileSet>
  </fileSets>
  <files>
    <file>
      <source>src/run/run.sh</source>
      <outputDirectory></outputDirectory>
      <fileMode>0755</fileMode>
    </file>
  </files>
</assembly>
...