使用maven的maven-assembly-plugin将jar包依赖打包到一个jar文件

本文介绍如何使用Maven的maven-assembly-plugin插件将Java项目及其所有依赖打包成一个独立的Jar文件,便于部署。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

有时候我们为了方便部署java程序需要把项目依赖的jar包都打包到一个jar文件中。可以使用maven-assembly-plugin插件来实现打包。

<build>
  <plugins>
    <plugin>
      <artifactId>maven-assembly-plugin</artifactId>
      <configuration>
        <archive>
          <manifest>
            <mainClass>cn.outofmemory.MainClass</mainClass>
          </manifest>
        </archive>
        <descriptorRefs>
          <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
      </configuration>
    </plugin>
  </plugins>
</build>

在pom.xml中添加了上述plugin配置之后可以通过下面的命令来编译。注意assembly:single必须在compile后面。

mvn clean compile assembly:single

通常情况下这个插件绑定到编译阶段自动执行,这可以保证当前正在编译的jar包可以在mvn install/deployment/release阶段之前编译成功。

<plugin>
  <artifactId>maven-assembly-plugin</artifactId>
  <configuration>
    <archive>
      <manifest>
        <mainClass>cn.outofmemory.MainClass</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>
<think>我们正在使用maven-assembly-plugin打包一个包含本地依赖的单个可执行JAR文件。根据引用内容,maven-assembly-plugin支持自定义打包结构,可以包含依赖项。步骤:1.在pom.xml中配置maven-assembly-plugin插件,并指定一个自定义的assembly描述符文件。2.创建assembly描述符文件(例如:assembly.xml),在该文件中定义如何打包依赖项(括本地依赖)以及项目的输出。3.注意:对于本地依赖(即不在Maven仓库中的依赖),我们需要先将它们安装到本地仓库,或者使用system作用域并指定路径。但注意,system作用域的依赖打包时可能需要特殊处理。然而,根据问题,我们需要将本地依赖打包进单个JAR。这里假设本地依赖已经以JAR文件的形式存在,并且我们可能使用system作用域来引用它们。但请注意:maven-assembly-plugin默认处理的是项目依赖括从仓库获取的依赖)。对于system作用域的依赖,插件默认不会包含它们,因为它们是本地的,不在仓库中。因此,我们需要在assembly描述符中显式包含这些依赖。另一种做法:将本地依赖安装到本地Maven仓库,然后作为普通依赖引入,这样assembly插件就能自动处理它们。但问题要求直接打包本地依赖,所以我们考虑使用system作用域。步骤详细说明:1.在pom.xml中,对于本地依赖使用system作用域,并指定systemPath:```xml<dependency><groupId>com.example</groupId><artifactId>local-lib</artifactId><version>1.0</version><scope>system</scope><systemPath>${project.basedir}/lib/local-lib-1.0.jar</systemPath></dependency>```2.配置maven-assembly-plugin插件,使用自定义的assembly.xml文件。3.在assembly.xml中,我们需要将所有依赖括system作用域的)打包JAR中。但是,默认情况下,依赖集合(<dependencySet>)不会包含system作用域的依赖。因此,我们需要在<dependencySet>中指定<scope>system</scope>来包含它们。4.同时,我们需要将项目的主类设置为可执行JAR的入口点。具体配置如下:在pom.xml中配置插件:```xml<build><plugins><plugin><artifactId>maven-assembly-plugin</artifactId><version>3.3.0</version><!--使用最新版本--><configuration><descriptor>src/main/assembly/assembly.xml</descriptor><!--描述符文件路径--><archive><manifest><mainClass>com.example.Main</mainClass><!--指定主类--></manifest></archive></configuration><executions><execution><phase>package</phase><goals><goal>single</goal></goals></execution></executions></plugin></plugins></build>```创建assembly.xml(在src/main/assembly目录下):```xml<assemblyxmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0http://maven.apache.org/xsd/assembly-1.1.0.xsd"><id>jar-with-dependencies</id><formats><format>jar</format><!--打包JAR格式--></formats><includeBaseDirectory>false</includeBaseDirectory><dependencySets><dependencySet><outputDirectory>/</outputDirectory><!--依赖打包JAR的根目录,或者可以指定为lib目录--><useProjectArtifact>true</useProjectArtifact><!--包含项目自身构建的JAR--><scope>runtime</scope><!--通常包含runtime和compile作用域的依赖--><!--但是,我们还需要包含system作用域的依赖,因此需要添加system作用域--><!--注意:这里我们指定多个作用域,用逗号分隔--><scope>runtime,system</scope><!--或者,如果我们想包含所有依赖,可以使用<scope>runtime</scope>,但默认不包含system,所以这里显式指定多个--><!--另一种方式:使用<scope>runtime</scope>和<scope>system</scope>两个dependencySet,但这里我们用一个并指定多个scope--><!--注意:在同一个dependencySet中指定多个scope,这些scope的依赖会被合并--><!--但是,根据文档,scope属性是单值的,所以我们不能直接写多个。因此,我们需要分成两个dependencySet?--><!--实际上,在1.1.0版本的描述符中,scope属性是字符串,我们可以写多个,用逗号分隔?但文档没有明确,我们可以尝试。--><!--或者,我们可以使用includes或excludes来指定具体的依赖--><!--更可靠的方式:分成两个dependencySet,一个处理runtime,一个处理system--></dependencySet></dependencySets></assembly>```但是,根据maven-assembly-plugin的文档,<scope>元素只能指定一个值。因此,我们需要两个dependencySet:```xml<dependencySets><dependencySet><outputDirectory>/</outputDirectory><useProjectArtifact>true</useProjectArtifact><scope>runtime</scope></dependencySet><dependencySet><outputDirectory>/</outputDirectory><scope>system</scope><!--注意:system作用域的依赖通常需要显式包含,因为默认不包含--></dependencySet></dependencySets>```这样,两个作用域的依赖都会被包含。但是,这样打包会将所有依赖JAR文件解压后合并到单个JAR中吗?注意:默认情况下,maven-assembly-plugin会将依赖JAR文件解压后合并到输出JAR中(即生成fatjar)。这是通过设置<unpack>true</unpack>来实现的。如果不设置,默认是false,即不解压,这样会直接将依赖JAR文件放入输出JAR中(这样会导致类加载器无法加载,因为JAR中的JAR不会被类加载器识别)。因此,我们需要将依赖解压:修改dependencySet,添加<unpack>true</unpack>:```xml<dependencySet><outputDirectory>/</outputDirectory><useProjectArtifact>true</useProjectArtifact><scope>runtime</scope><unpack>true</unpack><!--解压依赖JAR文件--></dependencySet><dependencySet><outputDirectory>/</outputDirectory><scope>system</scope><unpack>true</unpack><!--同样解压--></dependencySet>```这样,所有依赖括system作用域的)都会被解压并合并到最终的JAR文件中。注意:项目自身的JAR也会被解压合并(因为<useProjectArtifact>true</useProjectArtifact>)。5.另外,我们还需要注意,如果本地依赖JAR文件在${project.basedir}/lib下,并且已经在pom中以system作用域引入,那么上述配置会包含它们。6.执行打包命令:`mvncleanpackage`,插件会在target目录下生成一个以`jar-with-dependencies`为后缀的JAR文件(因为我们设置的id是`jar-with-dependencies`)。7.这个JAR文件就是可执行的,因为它包含了主类清单(由插件配置中的<archive>部分指定)和所有依赖的类。但是,有一个潜在问题:如果多个依赖JAR中有相同的资源文件(如META-INF/services),合并时可能会覆盖。如果需要处理这种情况,可能需要更高级的配置,比如使用maven-shade-plugin,但问题要求使用maven-assembly-plugin。另外,如果本地依赖没有通过pom.xml引入,而是直接放在某个目录下,那么我们需要在assembly.xml中使用<fileSets>来包含这些JAR,然后解压它们。但是,这样处理比较麻烦,因为需要手动指定每个JAR,并且还要解压。所以推荐还是通过pom.xml引入(使用system作用域)。总结步骤:1.将本地依赖作为system作用域依赖添加到pom.xml。2.配置maven-assembly-plugin插件,指定主类和assembly描述符。3.在assembly描述符中,定义两个dependencySet,分别处理runtime作用域和system作用域的依赖,并设置解压(unpack)为true。4.运行mvnpackage进行打包。注意:由于使用system作用域,在团队协作时,其他开发者可能没有相同的本地路径,因此这种方法主要适用于个人或已知环境。更好的做法是将这些本地依赖安装到本地仓库或使用私服。根据引用[3],assembly插件支持多种打包格式,这里我们使用jar格式。生成的文件名:默认是`<finalName>-<id>.jar`,其中id就是我们在assembly.xml中设置的id(`jar-with-dependencies`),所以生成的文件名类似`project-1.0-jar-with-dependencies.jar`。相关问题:1.如何在Maven中引入本地JAR文件作为依赖?2.除了maven-assembly-plugin,还有哪些插件可以打包可执行JAR?3.如何处理打包时资源文件冲突?4.如何将Maven项目及其所有依赖打包一个可执行的JAR文件?5.使用maven-assembly-plugin打包时,如何排除某些依赖?</think>### 如何使用 maven-assembly-plugin 打包本地依赖到单个可执行 JAR 以下是完整配置步骤,结合引用内容实现将本地依赖打包到单个可执行 JAR 文件: #### 1. 添加本地依赖到 POM 在 `pom.xml` 中使用 `system` 作用域引入本地 JAR: ```xml <dependencies> <dependency> <groupId>com.example</groupId> <artifactId>local-lib</artifactId> <version>1.0</version> <scope>system</scope> <systemPath>${project.basedir}/lib/local-lib-1.0.jar</systemPath> </dependency> </dependencies> ``` #### 2. 配置 maven-assembly-plugin 在 `pom.xml` 的 `<build>` 中添加插件配置: ```xml <plugin> <artifactId>maven-assembly-plugin</artifactId> <version>3.4.2</version> <configuration> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> <!-- 自定义配置文件(关键步骤) --> <descriptor>src/main/assembly/custom-assembly.xml</descriptor> <archive> <manifest> <mainClass>com.example.MainApp</mainClass> <!-- 替换为你的主类 --> </manifest> </archive> </configuration> <executions> <execution> <phase>package</phase> <goals> <goal>single</goal> </goals> </execution> </executions> </plugin> ``` #### 3. 创建自定义打包描述符 在 `src/main/assembly/custom-assembly.xml` 中: ```xml <assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd"> <id>executable-jar</id> <formats> <format>jar</format> <!-- 生成JAR格式 [^3] --> </formats> <includeBaseDirectory>false</includeBaseDirectory> <!-- 包含项目编译输出 --> <fileSets> <fileSet> <directory>${project.build.outputDirectory}</directory> <outputDirectory>/</outputDirectory> </fileSet> </fileSets> <!-- 关键:包含所有依赖(含system作用域本地JAR--> <dependencySets> <dependencySet> <outputDirectory>/</outputDirectory> <useProjectArtifact>true</useProjectArtifact> <scope>runtime</scope> <!-- 包含常规依赖 --> <unpack>true</unpack> <!-- 解压JAR内容 --> </dependencySet> <dependencySet> <outputDirectory>/</outputDirectory> <scope>system</scope> <!-- 显式包含本地依赖 [^2] --> <unpack>true</unpack> </dependencySet> </dependencySets> </assembly> ``` #### 4. 执行打包命令 ```bash mvn clean package ``` 生成的 JAR 位于: ``` target/your-project-1.0-executable-jar.jar ``` ### 关键配置解析 1. **作用域处理** - 通过两个 `<dependencySet>` 分别处理 `runtime`(标准依赖)和 `system`(本地依赖- `<unpack>true</unpack>` 将依赖 JAR 解压后合并到最终 JAR 中[^2] 2. **文件结构** - 依赖内容直接输出到 JAR 根目录(`<outputDirectory>/</outputDirectory>`) - 项目编译类文件通过 `<fileSet>` 包含[^1] 3. **可执行配置** - `<mainClass>` 指定程序入口点 - 使用 `jar` 格式生成标准可执行 JAR[^3] ### 验证结果 检查生成的 JAR 是否包含本地依赖类: ```bash jar tf target/your-project-1.0-executable-jar.jar | grep LocalLibClass ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值