AroundAround
Sign in Sign up
Menu

Maven JAR with Dependencies

Emma Brown
admin
#java #programming #java-programming
Share post:
Share

Single executable JAR? Maven's got you covered... almost. Unpack the mystery of dependency inclusion & create a truly self-contained app. Click to learn the trick!

How do I create a single executable JAR using Maven, including all dependencies?

Solution in a Nutshell

Creating runnable JARs with Maven for Java/Spring Boot apps is straightforward. Ensure your pom.xml includes the Spring Boot Maven plugin:

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <executable>true</executable>
            </configuration>
        </plugin>
    </plugins>
</build>

This plugin packages your application and all its dependencies into a single executable JAR. Run:

mvn clean package

The runnable JAR will be located in the target directory. Execute it using:

java -jar target/your-app-name.jar

Key Considerations:

  • Dependencies: Maven automatically includes project dependencies. No manual JAR addition needed.
  • executable=true: Essential for creating a runnable JAR.
  • Main Class: Your application's main class must be correctly specified (usually via @SpringBootApplication).
  • Shadowing: If dependency conflicts arise, consider the maven-shade-plugin for efficient packaging.

This process simplifies deployment, eliminating manual dependency management. Remember to replace your-app-name.jar with your project's actual JAR filename.