*Spring Boot 项目打包自定义文件名详解：Maven 配置与操作步骤

修炼室

已于 2024-09-23 16:09:20 修改

阅读量3.3k

点赞数

于 2023-06-07 21:28:15 首次发布

本文链接：https://blog.csdn.net/qq_22841387/article/details/131096418

版权

后端学习专栏收录该内容

27 篇文章

订阅专栏

在Springboot项目中，可以通过在pom.xml的<build>标签内添加<finalName>标签来自定义打包后的jar文件名。首先执行Maven的clean目标，然后执行package目标，即可得到命名定制的jar包。

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

Spring Boot 项目打包自定义文件名详解：Maven 配置与操作步骤

在使用 Spring Boot 进行项目开发时，默认的 Maven 打包行为会生成类似 项目名称-版本号-(SNAPSHOT).jar 的文件名格式。这种命名虽然标准化，但在某些场景中，我们可能希望生成自定义的文件名。本文将详细介绍如何通过修改 Maven 的 pom.xml 文件中的 <build> 配置来实现打包时生成自定义文件名，并且通过 Maven clean 和 package 操作顺利生成符合要求的打包文件。

默认的打包文件名

Spring Boot 项目使用 Maven 打包时，默认生成的文件名格式通常是这样的：

项目名称-版本号-(SNAPSHOT).jar

这个文件名格式主要由 Maven 根据项目的 <artifactId>、<version> 等配置自动生成。例如，如果项目名称为 my-app，版本号为 1.0.0-SNAPSHOT，则打包结果将会生成如下的文件：

my-app-1.0.0-SNAPSHOT.jar

尽管这种命名方式在版本管理中有其作用，但在一些场景下，如需要更简洁的文件名或希望文件名与项目环境或用途对应时，修改打包文件名是必要的。

自定义打包文件名

为了生成符合需求的文件名，我们可以在 pom.xml 文件中通过 <finalName> 标签来自定义打包的结果名称。

修改 `pom.xml`

打开 pom.xml 文件，找到 <build> 标签（如果没有，手动添加一个 <build> 块）。
在 <build> 块内添加 <finalName> 标签，并指定自定义的文件名。

示例如下：

<build>
    <finalName>my-custom-name</finalName>
</build>

在这个配置中，<finalName> 指定了最终生成的文件名为 my-custom-name.jar。

详细解析：

<finalName> 标签用于定义打包后生成的文件名，默认情况下是 ${artifactId}-${version}，而手动设置这个属性后，Maven 将使用你指定的名称进行打包。
通过这种方式，你可以避免冗长的文件名，也可以确保不同环境（如开发、测试、生产）的包名一致性。

打包操作步骤

完成 pom.xml 文件的修改后，我们可以使用 Maven 的常规操作来执行打包。以下是具体的步骤：

1. Clean 操作

清理项目之前的构建成果，确保没有旧的文件残留。

在 IDEA 的右侧 Maven 工具栏中，展开 Lifecycle 选项，找到并双击 clean。
clean 操作将删除 target 目录中的所有内容，这是一种常见的清理步骤，避免旧文件干扰新打包过程。

执行 clean

2. Package 操作

执行 package 命令，正式开始打包项目，生成 .jar 文件。

在同一 Maven 工具栏中的 Lifecycle 选项，找到 package，双击执行打包。

Maven package 操作

package 操作会在 target 目录下生成 .jar 文件，文件名将根据你在 pom.xml 中指定的 <finalName> 属性生成。

打包结果查看

打包完成后，打开项目的 target 文件夹，你将看到生成的 .jar 文件，其名称将会是你自定义的 finalName.jar。

例如，如果你在 pom.xml 中指定了如下配置：

<build>
    <finalName>my-custom-name</finalName>
</build>

那么打包后的文件名将是：

my-custom-name.jar

此时你可以根据实际需要将此 .jar 文件部署到服务器，或者将其用于本地测试和其他发布场景。

扩展：Maven 常用命令介绍

在实际开发中，除了 clean 和 package 外，Maven 还提供了许多其他有用的命令。以下是一些常用的命令介绍：

clean：清理目标目录（target），删除之前编译和打包生成的文件。
compile：编译项目中的源代码，生成 .class 文件。
test：运行项目中的测试用例。
install：将打包好的文件安装到本地 Maven 仓库，供本地项目依赖。
deploy：将最终的构建成果发布到远程仓库。

这些命令可以通过 IntelliJ IDEA 中的 Maven 工具栏快速执行，也可以通过命令行在项目根目录下运行：

mvn clean
mvn package

总结

本文详细讲解了如何通过修改 pom.xml 中的 <build> 配置，来自定义 Spring Boot 项目的打包文件名，并介绍了通过 Maven 工具执行打包的完整步骤。通过这种方法，开发者可以轻松控制生成的文件名格式，使其更加符合项目需求。

默认的文件名规则：项目名称-版本号-SNAPSHOT.jar
自定义文件名的方法：修改 pom.xml 中的 <finalName> 属性
打包步骤：先执行 clean 清理旧文件，再执行 package 打包生成新文件。

了解这些细节后，可以根据项目的不同需求灵活配置打包行为，提升开发和发布效率。