Maven Assembly Plugin：Springboot打包

法斗和荷兰豆

已于 2025-05-23 11:11:14 修改

阅读量1.1k

点赞数 8

CC 4.0 BY-SA版权

文章标签： maven java

于 2025-05-19 18:08:44 首次发布

本文链接：https://blog.csdn.net/2302_78197117/article/details/148069968

一、插件简介

Maven Assembly Plugin是Maven生态中用于构建项目分发包的核心插件，它能够将项目输出、依赖项、文档等资源按照自定义规则打包成多种格式的归档文件（如ZIP、TAR、JAR等）。该插件名称中的"assembly"意为"装配"，形象地描述了其将项目各组成部分组装成完整分发包的功能。

典型应用场景

生成包含所有依赖的可执行JAR包(fat-jar)
创建包含配置文件的生产部署包
构建包含文档、脚本的完整发行包
制作多模块项目的聚合安装包
生成符合特定目录结构的平台专用包

二、基础配置

1. 插件引入

在pom.xml中添加插件声明：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>3.6.0</version>
            <configuration>
                <!-- 基础配置 -->
            </configuration>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

2. 核心配置参数

参数名	说明	示例值
finalName	输出文件名称	myapp-{version}
appendAssemblyId	是否在文件名追加assembly id	true
descriptors	自定义描述文件路径	src/assembly/dist.xml
formats	打包格式列表	`<format>zip</format>`

三、描述文件详解

1. 描述文件结构

Assembly描述文件通常放在src/assembly目录下，基本结构

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.0 
          http://maven.apache.org/xsd/assembly-2.1.0.xsd">
    <id>dist</id>
    <formats>
        <format>zip</format>
    </formats>
    <!-- 其他配置 -->
</assembly>

2. 依赖集(dependencySets)配置

管理项目依赖的打包方式：

<dependencySets>
    <!-- 主依赖包 -->
    <dependencySet>
        <outputDirectory>/lib</outputDirectory>
        <scope>runtime</scope>
    </dependencySet>
    <!-- 排除测试依赖 -->
    <dependencySet>
        <outputDirectory>/test-lib</outputDirectory>
        <scope>test</scope>
        <excludes>
            <exclude>junit:junit</exclude>
        </excludes>
    </dependencySet>
</dependencySets>

四、典型配置案例

通过插件配置，可以将所有依赖库打包到单个JAR中，生成Fat JAR。通过配置该插件，开发者可以轻松地将项目代码及其所有运行时依赖（包括传递依赖）合并到一个可执行的 JAR 文件中，从而简化部署流程并确保应用程序在任何环境中都能独立运行。

Maven Assembly Plugin 配置示例（Fat JAR）

1. `pom.xml` 配置

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>3.6.0</version>
            <configuration>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef> <!-- 使用内置模板 -->
                </descriptorRefs>
                <archive>
                    <manifest>
                        <mainClass>com.example.Main</mainClass> <!-- 指定主类 -->
                    </manifest>
                </archive>
            </configuration>
            <executions>
                <execution>
                    <phase>package</phase> <!-- 绑定到package阶段 -->
                    <goals>
                        <goal>single</goal> <!-- 执行打包 -->
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

2. 执行流程

构建项目
```
mvn clean package
```
生成结果
- 在 target/ 目录下生成：
  - your-project-1.0.jar（普通JAR）
  - your-project-1.0-jar-with-dependencies.jar（Fat JAR）
运行Fat JAR
java -jar target/your-project-1.0-jar-with-dependencies.jar