如何添加本地JAR文件到Maven项目中

Love The Way You Lie 2022-06-05 03:15 222阅读 0赞

> 【版权申明】非商业目的可自由转载  
> 博文地址：  
> 出自：shusheng007

相关文章：  
[秒懂Java序列化与反序列化][Java]  
[秒懂 Java注解类型（@Annotation）][Java_Annotation]  
[秒懂Java多线程][Java 1]

本文于2020年4月24日更新，文章以后会首发于自己的 [博客小站][Link 1]

# 概述 #

有时我们需要将本地的jar文件添加到maven项目中，如果直接通过IDEA添加本地库引用的话，打包时候会丢失。网上中文教程的解决方法非常复杂，自己调查并实践，希望有此问题的同行不用再走弯路。

# 第一种方案：将jar安装到本地Maven仓库 #

第一种方案就是将jar包安装在你机器的本地 `maven` 库中，这种方案也有两种方式，手动和自动：

## 手动 ##

手动运行`maven`命令将`jar`文件安装到本地maven库

### 第一步 ###

首先确定你的电脑已经安装了**Maven**。在命令行中键入`mvn -v`命令，如果出现类似如下图所示，说明你的电脑已经安装了**Maven**，可进行第二步，如果没有请安装**Maven**。

![检查是否安装maven][maven]

#### 第二步 ####

安装jar到本地仓库

mvn install:install-file -Dfile=<path-to-file> -DgroupId=<group-id> -DartifactId=<artifact-id> -Dversion=<version> -Dpackaging=<packaging>

`<path-to-file>`: 要安装的JAR的本地路径 `./libs/json-simple-1.1.1.jar`  
`<group-id>`：要安装的JAR的Group Id  
`<artifact-id>`: 要安装的JAR的 Artificial Id  
`<version>`: JAR 版本  
`<packaging>`: 打包类型，例如`JAR`

> NOTE:最好在`pom.xml`文件所在的目录运行上述命令，个人经验不在根目录运行有时会安装不成功

#### 第三步 ####

使用，例如我安装了百度推送JAR到本地，我就可以在`pom.xml`文件中这样引用它了

<dependency>
    	<groupId>com.baidu.app</groupId>
    	<artifactId>bdpush</artifactId>
    	<version>3.0.1</version>
    </dependency>

这种方法弊端较大，程序的可维护性以及移植性较低。例如当你改变本地**Maven**仓库时需要重新安装。如果引用此`JAR`的项目是多人协调工作的项目，则每个人都要手动将其安装在自己的本地仓库。

### 自动 ###

第二种方法是对第一种方法的改进。我们可以将此`JAR`文件放在工程里，然后使用`maven`插件自动将其安装到本地`maven`库。

例如我在项目根目录下有个`libs`的目录，里面存放我要安装的`jar`包 , 在`pom.xml`文件中使用**maven-install-plugin**在**Maven**初始化阶段完成安装。

<build>
            <plugins>
                
            </plugins>
        </build>

> `${basedir}`表示`pom.xml`文件所在的目录

### 第二种方案 ###

第二种方法比较粗暴简单，具体为将依赖设置为**系统**域，通过完全路径引用。例如要引用的`JAR`文件在 `<PROJECT_ROOT_FOLDER>/lib`下，那么使用如下方法添加依赖

<dependency>
    	<groupId>com.baidu.app</groupId>
    	<artifactId>bdpush</artifactId>
    	<version>3.0.1</version>
    	<scope>system</scope>
    	<systemPath>${basedir}/lib/bdpush-3.0.1.ja</systemPath>
    </dependency>

> `${basedir}`表示`pom.xml`文件所在的目录，例如你的`JAR`文件在D盘下的`jarLibs`里面，就将`${basedir}`替换为“D:/jarLibs”即可。

**note**: **这种方法我自己在`SpringBoot`项目中打包成`war`文件时，没有成功打包到里面，不推荐使用**

### 第三种方案 ###

第三种方案是将`JAR`文件安装在你项目中一个单独的`maven`仓库里，这个仓库随着项目走。

1：我们在\*\*$\{basedir\}**（`pom.xml`文件所在路径）目录下建立一个叫**maven-repository\*\*的本地仓库(就是建立一个叫这个名字的文件夹)。

2：使用如下命令安装我们要引用的`JAR`到此仓库中

mvn deploy:deploy-file 
    -Dfile=<path-to-file>
    -DgroupId=<group-id> 
    -DartifactId=<artifact-id>
    -Dversion=<version> 
    -Dpackaging=jar 
    -Durl=file:./maven-repository/ 
    -DrepositoryId=maven-repository 
    -DupdateReleaseInfo=true

我们来举个例子

mvn deploy:deploy-file 
    -Dfile=./libs/json-simple-1.1.1.jar 
    -DgroupId=com.sng.app 
    -DartifactId=json-simple 
    -Dversion=1.1.1 
    -Dpackaging=jar 
    -Durl=file:./maven-repository/ 
    -DrepositoryId=maven-repository 
    -DupdateReleaseInfo=true

安装成功后控制台会显示如下类似结果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1NodVNoZW5nMDAwNw_size_16_color_FFFFFF_t_70]  
你项目中的本地`maven`库也会出现相应的文件，类似下面这样  
![在这里插入图片描述][20200424151232497.png]

3：在`pom.xml`中如下使用

申明仓库

<repositories>
        <repository>
            <id>maven-repository</id>
            <url>file:///${project.basedir}/maven-repository</url>
        </repository>
    </repositories>

然后添加引用

<dependency>
         <groupId>com.sng.app</groupId>
         <artifactId>json-simple</artifactId>
         <version>1.1.1</version>
     </dependency>

# 总结 #

推荐使用第三种方式，第三种方式比较灵活。例如等`jar`被发布到了远程仓库的话，直接将其从本地库删除即可。多个人协作的话也不需要各自维护。

[Java]: https://blog.csdn.net/shusheng0007/article/details/80629348
[Java_Annotation]: https://blog.csdn.net/shusheng0007/article/details/80622035
[Java 1]: https://blog.csdn.net/shusheng0007/article/details/80633873
[Link 1]: http://shusheng007.top
[maven]: /images/20220605/a145cb6af6e8441ba4bc2f15da95690b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1NodVNoZW5nMDAwNw_size_16_color_FFFFFF_t_70]: /images/20220605/0fcf893bee0845d09b9fdd3631cddd9a.png
[20200424151232497.png]: /images/20220605/d21497978638471492f2845712e46d2c.png