Skip to content

Yet another programming solutions log

Sample bits from programming for the future generations.

Technologies Technologies
  • Algorithms and Data Structures
  • Java Tutorials
  • JUnit Tutorial
  • MongoDB Tutorial
  • Quartz Scheduler Tutorial
  • Spock Framework Tutorial
  • Spring Framework
  • Bash Tutorial
  • Clojure Tutorial
  • Design Patterns
  • Developer’s Tools
  • Productivity
  • About
Expand Search Form

Maven package with dependencies

farenda 2015-08-26 0

Problem:

How to use Maven to package a project with dependencies? The solution is to use maven-assembly-plugin as in the following example.

Solution:

Here we’ll use very simple Maven project with compile dependency on Apache Commons Lang3 library. Packaging of the bundle is done by maven-assembly-plugin according to a configuration. Fortunately, the plugin comes with a couple of ready to use configurations, one of which is jar-with-dependencies:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.farenda.java</groupId>
    <artifactId>solved</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.4</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>2.5.5</version>
                <configuration>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

Sample Java code using our dependency (Apache Commons Lang3):

package com.farenda.java;

import org.apache.commons.lang3.LocaleUtils;

import java.util.Locale;

public class JavaSolved {

    public static void main(String[] args) {
        for (Locale locale : LocaleUtils.availableLocaleSet()) {
            System.out.printf("Country: %s, language: %s%n",
                    locale.getCountry(), locale.getLanguage());
        }
    }
}

Now, running mvn assembly:assembly command will tell Maven to run the assembly plugin with configuration from the pom.xml.

All project classes with dependencies have been packed into target/solved-0.0.1-SNAPSHOT-jar-with-dependencies.jar. Here are sample entries that confirm correct packaging:

-rw-r--r--      1067  21-Aug-2015  18:16:20  com/farenda/java/JavaSolved.class
-rw-r--r--      7004   3-Apr-2015  14:30:26  org/apache/commons/lang3/AnnotationUtils.class
-rw-r--r--       246   3-Apr-2015  14:30:26  org/apache/commons/lang3/builder/Builder.class

As you can see dependent JAR has been unpacked and repackaged with project code. Such single JAR is easier to distribute than whole bunch.

Share with the World!
Categories Dev Tools Tags java, maven
Previous: Java find annotated classes
Next: Bash case statement

Recent Posts

  • Java 8 Date Time concepts
  • Maven dependency to local JAR
  • Caesar cipher in Java
  • Java casting trick
  • Java 8 flatMap practical example
  • Linked List – remove element
  • Linked List – insert element at position
  • Linked List add element at the end
  • Create Java Streams
  • Floyd Cycle detection in Java

Pages

  • About Farenda
  • Algorithms and Data Structures
  • Bash Tutorial
  • Bean Validation Tutorial
  • Clojure Tutorial
  • Design Patterns
  • Java 8 Streams and Lambda Expressions Tutorial
  • Java Basics Tutorial
  • Java Collections Tutorial
  • Java Concurrency Tutorial
  • Java IO Tutorial
  • Java Tutorials
  • Java Util Tutorial
  • Java XML Tutorial
  • JUnit Tutorial
  • MongoDB Tutorial
  • Quartz Scheduler Tutorial
  • Software Developer’s Tools
  • Spock Framework Tutorial
  • Spring Framework

Tags

algorithms bash bean-validation books clojure design-patterns embedmongo exercises git gof gradle groovy hateoas hsqldb i18n java java-basics java-collections java-concurrency java-io java-lang java-time java-util java-xml java8 java8-files junit linux lists log4j logging maven mongodb performance quartz refactoring regex rest slf4j solid spring spring-boot spring-core sql unit-tests

Yet another programming solutions log © 2021

sponsored
We use cookies to ensure that we give you the best experience on our website. If you continue to use this site we will assume that you are happy with it.Ok