Включая зависимости в банке с Maven - PullRequest
307 голосов
/ 13 ноября 2009

Есть ли способ заставить maven (2.0.9) включить все зависимости в один файл jar?

У меня есть проект сборки в один файл JAR. Я хочу, чтобы классы из зависимостей также копировались в jar.

Обновление: Я знаю, что не могу просто включить файл JAR в файл JAR. Я ищу способ распаковать файлы jar, указанные как зависимости, и упаковать файлы классов в мой файл jar.

Ответы [ 13 ]

432 голосов
/ 13 ноября 2009

Вы можете сделать это с помощью плагина maven-assembly с дескриптором "jar-with-dependencies". Вот соответствующий фрагмент из одного из наших pom.xml, который делает это:

  <build>
    <plugins>
      <!-- any other plugins -->
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>single</goal>
            </goals>
          </execution>
        </executions>
        <configuration>
          <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
          </descriptorRefs>
        </configuration>
      </plugin>
    </plugins>
  </build>
125 голосов
/ 13 ноября 2009

В Maven 2 правильный способ сделать это - использовать Плагин сборки Maven2 , который имеет для этой цели предопределенный файл дескриптора , который вы можете просто командная строка:

mvn assembly:assembly -DdescriptorId=jar-with-dependencies

Если вы хотите сделать этот jar исполняемым, просто добавьте основной класс для запуска в конфигурацию плагина:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-assembly-plugin</artifactId>
  <configuration>
    <archive>
      <manifest>
        <mainClass>my.package.to.my.MainClass</mainClass>
      </manifest>
    </archive>
  </configuration>
</plugin>

Если вы хотите создать эту сборку как часть обычного процесса сборки, вы должны связать single или directory-single цель (цель assembly должна выполняться ТОЛЬКО из командной строки) в фазу жизненного цикла (package имеет смысл), примерно так:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-assembly-plugin</artifactId>
  <executions>
    <execution>
      <id>create-my-bundle</id>
      <phase>package</phase>
      <goals>
        <goal>single</goal>
      </goals>
      <configuration>
        <descriptorRefs>
          <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
        ...
      </configuration>
    </execution>
  </executions>
</plugin>

Адаптируйте элемент configuration в соответствии с вашими потребностями (например, с помощью материалов манифеста, как говорится).

28 голосов
/ 29 декабря 2016

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

    <plugins>
            <plugin>
                 <artifactId>maven-assembly-plugin</artifactId>
                 <executions>
                     <execution>
                          <phase>package</phase>
                          <goals>
                              <goal>single</goal>
                          </goals>
                      </execution>
                  </executions>
                  <configuration>
                       <!-- ... -->
                       <archive>
                           <manifest>
                                 <mainClass>fully.qualified.MainClass</mainClass>
                           </manifest>
                       </archive>
                       <descriptorRefs>
                           <descriptorRef>jar-with-dependencies</descriptorRef>
                      </descriptorRefs>
                 </configuration>
         </plugin>
   </plugins>
17 голосов
/ 13 ноября 2009

Есть плагин Shade Maven . Его можно использовать для упаковки и переименования зависимостей (чтобы исключить проблемы с зависимостями в пути к классам).

13 голосов
/ 18 января 2012

Вы можете использовать только что созданную банку, используя тег <classifier>.

<dependencies>
    <dependency>
        <groupId>your.group.id</groupId>
        <artifactId>your.artifact.id</artifactId>
        <version>1.0</version>
        <type>jar</type>
        <classifier>jar-with-dependencies</classifier>
    </dependency>
</dependencies>
12 голосов
/ 16 мая 2013

Если вам (как и мне) не очень нравится подход jar-with-dependencies , описанный выше, я предпочитаю maven-решение просто создать WAR-проект, даже если вы создаете только отдельное Java-приложение:

  1. Создайте обычный jav-проект maven, который соберет ваш jar-файл (без зависимостей).

  2. Кроме того, настройте maven war-проект (только с пустым файлом src / main / webapp / WEB-INF / web.xml , что позволит избежать предупреждения / ошибки в maven -build), которая имеет только ваш jar-проект в качестве зависимости, и делает ваш jar-проект <module> под вашим war-проектом. (Этот военный проект - всего лишь простая уловка, чтобы обернуть все ваши зависимости jar-файла в zip-файл.)

  3. Создайте военный проект для создания военного файла.

  4. На этапе развертывания просто переименуйте ваш .war-файл в * .zip и разархивируйте его.

Теперь у вас должен быть каталог lib (который вы можете переместить куда хотите) с вашим jar-файлом и всеми зависимостями, необходимыми для запуска вашего приложения:

java -cp 'path/lib/*' MainClass

(Подстановочный знак в classpath работает в Java-6 или новее)

Я думаю, что это проще в установке в maven (не нужно возиться с плагином сборки), а также дает более четкое представление о структуре приложения (вы увидите номера версий всех зависимых jar-файлов в простом виде просматривать и избегать засорения всего в один jar-файл).

10 голосов
/ 31 августа 2015

http://fiji.sc/Uber-JAR дает превосходное объяснение альтернатив:

Существует три распространенных метода построения Uber-JAR:

  1. незатушеванная. Распакуйте все файлы JAR, затем упакуйте их в один JAR.
    • Pro: работает с загрузчиком классов Java по умолчанию.
    • Con: файлы, присутствующие в нескольких JAR-файлах с одинаковым путем (например, META-INF / services / javax.script.ScriptEngineFactory) перезапишет один другой, приводящий к неправильному поведению.
    • Инструменты: Maven Assembly Плагин Classworlds Uberjar
  2. Затенение. То же, что и у затененных, но переименовываете (т. Е. "Тень") все пакеты всех зависимостей.
    • Pro: работает с загрузчиком классов Java по умолчанию. Предотвращает некоторые (не все) конфликты версий зависимостей.
    • Con: Files присутствует в нескольких файлах JAR с одним и тем же путем (например, META-INF / services / javax.script.ScriptEngineFactory) перезапишет один другой, приводящий к неправильному поведению.
    • Инструменты: плагин Maven Shade
  3. баночка банок. Окончательный файл JAR содержит другие файлы JAR, встроенные в.
    • Pro: предотвращает конфликты версий зависимостей. Все файлы ресурсов сохраняются.
    • Con: необходимо связать специальный загрузчик классов "bootstrap", позволяющий Java загружать классы из обернутые файлы JAR. Отладка проблем загрузчика классов становится более сложной.
    • Инструменты: Eclipse JAR File Exporter, One-JAR.
4 голосов
/ 11 сентября 2015

Мое окончательное решение по Eclipse Luna и m2eclipse: Custom Classloader (скачать и добавить в свой проект, только 5 классов) : http://git.eclipse.org/c/jdt/eclipse.jdt.ui.git/plain/org.eclipse.jdt.ui/jar%20in%20jar%20loader/org/eclipse/jdt/internal/jarinjarloader/; этот загрузчик классов является самым лучшим из загрузчиков классов с одной флягой и очень быстрым;

<project.mainClass>org.eclipse.jdt.internal.jarinjarloader.JarRsrcLoader</project.mainClass> <project.realMainClass>my.Class</project.realMainClass>

Изменить в JIJConstants "Rsrc-Class-Path" на "Class-Path"
Чистая зависимость mvn: пакет копий-зависимостей
создается фляга с зависимостями в папке lib с тонким загрузчиком классов

<build>
    <resources>
        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.java</include>
                <include>**/*.properties</include>
            </includes>
        </resource>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
            <includes>
                <include>**/*</include>
            </includes>
            <targetPath>META-INF/</targetPath>
        </resource>
        <resource>
            <directory>${project.build.directory}/dependency/</directory>
            <includes>
                <include>*.jar</include>
            </includes>
            <targetPath>lib/</targetPath>
        </resource>
    </resources>
<pluginManagement>
        <plugins>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <configuration>
                    <archive>
                        <manifest>
                            <addClasspath>true</addClasspath>
                            <mainClass>${project.mainClass}</mainClass>
                            <classpathPrefix>lib/</classpathPrefix>
                        </manifest>

                        <manifestEntries>
                            <Rsrc-Main-Class>${project.realMainClass}  </Rsrc-Main-Class>
                            <Class-Path>./</Class-Path>
                        </manifestEntries>

                    </archive>
                </configuration>
            </plugin>
<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <executions>
                    <execution>
                        <id>copy-dependencies</id>
                        <phase>package</phase>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </pluginManagement>
</build>
3 голосов
/ 21 марта 2018
        <!-- Method 1 -->
        <!-- Copy dependency libraries jar files to a separated LIB folder -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <configuration>
                <outputDirectory>${project.build.directory}/lib</outputDirectory>
                <excludeTransitive>false</excludeTransitive> 
                <stripVersion>false</stripVersion>
            </configuration>
            <executions>
                <execution>
                    <id>copy-dependencies</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <!-- Add LIB folder to classPath -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>2.4</version>
            <configuration>
                <archive>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <classpathPrefix>lib/</classpathPrefix>
                    </manifest>
                </archive>
            </configuration>
        </plugin>


        <!-- Method 2 -->
        <!-- Package all libraries classes into one runnable jar -->
        <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <executions>
              <execution>
                <phase>package</phase>
                <goals>
                  <goal>single</goal>
                </goals>
              </execution>
            </executions>
            <configuration>
              <descriptorRefs>
                <descriptorRef>jar-with-dependencies</descriptorRef>
              </descriptorRefs>
            </configuration>
        </plugin>            
1 голос
/ 13 ноября 2009

Отложив Maven в сторону, вы можете поместить библиотеки JAR в основной Jar, но вам нужно будет использовать собственный загрузчик классов.

Проверьте этот проект: One-JAR текст ссылки

...