Avatar ·

Как создать исполняемый JAR-файл со всеми зависимостями в Maven?

Привет, коллеги! Я новичок в Java и Maven, и у меня возникла проблема. Я написал простое консольное приложение, которое использует библиотеку Apache Commons IO для чтения файлов. Всё отлично работает в IntelliJ IDEA, но когда я пытаюсь собрать исполняемый JAR-файл, возникают проблемы. Вот мой pom.xml: ```xml 4.0.0 com.example my-app 1.0 jar commons-io commons-io 2.11.0 ``` И мой Main класс: ```java import org.apache.commons.io.FileUtils; import java.io.File; import java.io.IOException; public class Main { public static void main(String[] args) { try { String content = FileUtils.readFileToString(new File("test.txt"), "UTF-8"); System.out.println(content); } catch (IOException e) { e.printStackTrace(); } } } ``` Когда я запускаю `mvn package`, создаётся JAR-файл, но при попытке запустить его через `java -jar target/my-app-1.0.jar` я получаю ошибку `ClassNotFoundException: org.apache.commons.io.FileUtils`. Я понимаю, что это потому, что зависимости не включаются в JAR. Как правильно собрать исполняемый JAR, который включал бы все необходимые библиотеки? Я слышал про "uber-JAR" или "fat JAR", но не знаю, как это сделать в Maven. Помогите, пожалуйста! <<>>

Решение с помощью Maven Shade Plugin

Проблема в том, что стандартная команда mvn package создаёт "тонкий" JAR, который содержит только ваш код, но не включает зависимости. Для создания "жирного" JAR (fat JAR / uber-JAR), который можно запустить одной командой, лучше всего использовать Maven Shade Plugin. Этот плагин объединяет все зависимости в один JAR-файл и правильно настраивает Class-Path.

Пошаговая инструкция

  1. Добавьте плагин в ваш pom.xml внутри раздела <build><plugins>:
<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>my-app</artifactId>
    <version>1.0</version>
    <packaging>jar</packaging>

    <dependencies>
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>2.11.0</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.5.1</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <transformers>
                                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                    <mainClass>com.example.Main</mainClass>
                                </transformer>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>
  1. Укажите правильный путь к главному классу. В примере выше указан com.example.Main. Если ваш класс находится в пакете по умолчанию (без package), используйте просто Main. Если он в другом пакете, например com.mycompany.app.Main, укажите полное имя.
  2. Запустите сборку:
mvn clean package
  1. Запустите полученный JAR:
java -jar target/my-app-1.0.jar

Почему это работает?

  • ManifestResourceTransformer добавляет в META-INF/MANIFEST.MF атрибут Main-Class, который указывает JVM, какой класс запускать.
  • Плагин распаковывает все JAR-файлы зависимостей и объединяет их в один файл. Если в разных JAR-файлах есть одинаковые файлы (например, конфигурации), плагин может их перезаписать или объединить.
  • В результате получается самодостаточный JAR, который можно переносить на любую машину с установленной JRE.

Дополнительные настройки (решение возможных проблем)

Иногда при объединении JAR-файлов возникают конфликты (например, разные версии одного класса). Чтобы решить это, добавьте в конфигурацию:

<configuration>
    <filters>
        <filter>
            <artifact>*:*</artifact>
            <excludes>
                <exclude>META-INF/*.SF</exclude>
                <exclude>META-INF/*.DSA</exclude>
                <exclude>META-INF/*.RSA</exclude>
            </excludes>
        </filter>
    </filters>
    <transformers>
        <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
            <mainClass>com.example.Main</mainClass>
        </transformer>
    </transformers>
</configuration>

Эти фильтры исключают цифровые подписи из зависимых JAR-файлов, которые могут вызвать ошибки при запуске.

После сборки у вас появятся два JAR-файла: my-app-1.0.jar (оригинальный) и my-app-1.0-shaded.jar (исполняемый). Запускать нужно второй — он содержит все зависимости.

<<>>

Альтернатива: Maven Assembly Plugin

Если по какой-то причине Shade Plugin вам не подходит (например, нужен более простой подход), можно использовать Maven Assembly Plugin. Он создаёт JAR со всеми зависимостями, но работает немного иначе — он просто копирует библиотеки в отдельную папку внутри JAR и настраивает Class-Path.

Добавьте в pom.xml:

<plugin>
    <artifactId>maven-assembly-plugin</artifactId>
    <version>3.6.0</version>
    <configuration>
        <archive>
            <manifest>
                <mainClass>com.example.Main</mainClass>
            </manifest>
        </archive>
        <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
    </configuration>
    <executions>
        <execution>
            <id>make-assembly</id>
            <phase>package</phase>
            <goals>
                <goal>single</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Затем выполните:

mvn clean package

В папке target появится файл my-app-1.0-jar-with-dependencies.jar. Запускайте его:

java -jar target/my-app-1.0-jar-with-dependencies.jar

Недостатки Assembly Plugin

  • Он не решает конфликты файлов (например, если две библиотеки содержат одинаковые ресурсы).
  • Размер JAR может быть больше, чем при использовании Shade Plugin.
  • Иногда возникают проблемы с файлами подписей (Signature files), что приводит к ошибкам SecurityException.

Поэтому для большинства случаев я рекомендую Shade Plugin. Assembly Plugin стоит использовать, если вам нужно просто быстро собрать проект без тонкой настройки.