How to create and use local JAR file as a local Maven dependency

Posted By : Ravindra Singh | 16-Sep-2018
Java

Introduction: 

Sometimes you want to work with a JAR file that is not hosted in Maven Central, So In this article, we are going to describe some different ways you can install and work with local dependency JAR file within your local Maven setup into .m2 folder repository. Apache Maven is a software project management tool, That is used to help in the management of the project builds, Documentation and Dependencies.

 

Now, In order to set up the maven local JAR file just follow the below steps:

 

>> First you will create your project JAR file as :

1. The first step is to Download as a zip file or clone the project from GitHub, for that you want to make the JAR file to use as a local maven Dependency.

Example: Binance is a third party API that is used to provide Market data information, But Binance API dependency is not available on Maven Central so If we want to use Binance API dependency as a local JAR file into our project then follow the below steps.

2. Unzip the downloaded project into your local system drive.

3. Import the unzip project file into your Eclipse IDE.

4. And then Run the project as maven build, then there is Edit configuration window is open, now what you will do you just enter the "clean package" in Goal field of an open window and then run the project.

5. Now if your build is successful, you will get the message on eclipse console build success.

6. And your .jar file is stored in the target folder of your project local repository.

 

>> Second you will add or install the above-created JAR file into your local .m2 folder repository as :
 
By installing or adding the created project JAR file into your local .m2 repository you just run the below command on cmd :
 
 
command format is :
1
2
3
4
5
6
mvn install:install-file
   -Dfile=<path-to-file>
   -DgroupId=<group-id>
   -DartifactId=<artifact-id>
   -Dversion=<version>
   -Dpackaging=<packaging>
 
 
Example :
 
1
2
3
4
5
6
mvn install:install-file \
-Dfile=target/binance-api-dependencies.jar \
-DgroupId=com.example.demo \
-DartifactId=Binance-api \
-Dversion=1.0.9 \
-Dpackaging=jar
 
 
 
Where in above command each field is referred as :
 

< path-to-file >: the path of the target folder from where we load JAR file e.g -> c:\projectName/target/binance-api-1.0.9.jar

< group-id >: the group is the name of your project package Name e.g -> com.example.demo

< artifact-id >: the artifact name for the file is the name of dependency class you want to have e.g -> Binance-api

< version >: the version number of dependecy e.g -> 1.0.9

< packaging >: the packaging of the file you want to create e.g. -> jar

 
This above command automatically installs your create JAR into your local .m2 folder repository, Now next what you will do you just add the path of your JAR file of .m2 folder repository into your pom.xml file or build.gradle file.
 
 
build.Gradle file example :
 
add these below lines into your build.gradle file repository field :
 
        mavenLocal()
	mavenCentral artifactUrls:["file:/home/ravindrasingh/.m2/repository/"]
 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
repositories {
	mavenCentral()
	
	mavenLocal()
	mavenCentral artifactUrls:["file:/home/ravindrasingh/.m2/repository/"]
	
	//maven { url "https://staging.myproject.com/maven-libs" }
	maven {
        url 'https://repo.spring.io/libs-milestone'
    }
}
 
 
 
And also add below line in your gradle dependencies :
 
1
compile group: 'com.example.demo', name: 'binance-api', version: '1.0.9'
 
 
That's it.
 
 
 
 
>> If you want to make this dependency as accessible from the live server, you need to just register the above dependency folder created inside the .m2 folder repository onto the server and change below lines of code into your gradle file.
 
uncommented the below line in the repositories section of gradle file :
 
maven { url "https://staging.myproject.com/maven-libs" }
 
And commented the below line in the repositories section of gradle file :
 
//mavenLocal()
//mavenCentral artifactUrls:["file:/home/ravindrasingh/.m2/repository/"]
 
repositories {
	mavenCentral()
	
	//mavenLocal()
	//mavenCentral artifactUrls:["file:/home/ravindrasingh/.m2/repository/"]
	
	maven { url "https://staging.myproject.com/maven-libs" }
	maven {
        url 'https://repo.spring.io/libs-milestone'
    }
}
 
 
 
Important Note: You can do it for your projects also and register the created JAR file onto the Maven Central Library to make your project live as dependencies for other peoples.
 
 
 
 
 
 
 
 
 
 
 
 
 
Related Tags
PWA
cloud computing
saas
Web Apps
Angular
nodejs
javascript
php
vue.js
Spring boot
mysql
ReactJS
Django
Laravel
plugin
angularjs
bootstrap
html
Angular2
jquery
grails
Java Virtual Machine
html5
Mean stack
Moodle
LMS
oops
Shopify
reverseajax
Knockoutjs
ngrok
Meteor

About Author

Author Image
Ravindra Singh

Ravindra is Sr. Associate Consultant Development- Java (Backend Developer). And Familiar with AWS Cloud Machine Learning Programming (AWS Lex, Lambda, Polly, Elasticsearch ), And also having good experience in Spring Boot Microservice Architecture Applica

Request for Proposal

Name is required

Comment is required

Sending message..