三种方式打 java 可执行 jar 包,你用对了吗
写完代码只是开始,如何打包成一个“开箱即用”的 jar 文件,才是交付的关键一步。
很多 java 开发者都遇到过这样的问题: 本地跑得好好的程序,一打包就报错 classnotfoundexception? 别慌,这很可能不是你的代码问题,而是——jar 包没打好!
maven 提供了多种打可执行 jar 的方式。今天我们就来对比三种主流方案:
maven-jar-plugin(轻量外置依赖)maven-assembly-plugin(全家桶打包)maven-shade-plugin(高级防冲突版)
每种方式配真实 pom.xml 配置 + 执行命令 + 输出结构,让你看完就能上手!
方式一:maven-jar-plugin—— “轻量但依赖外置”
它只打包你自己的代码,不包含第三方依赖,但会在 manifest.mf 中指定依赖路径。
pom.xml 配置
<build>
<plugins>
<plugin>
<groupid>org.apache.maven.plugins</groupid>
<artifactid>maven-jar-plugin</artifactid>
<version>3.2.0</version>
<configuration>
<archive>
<manifest>
<mainclass>org.example.app</mainclass>
<addclasspath>true</addclasspath>
<classpathprefix>dependencies/</classpathprefix>
</manifest>
</archive>
</configuration>
</plugin>
<plugin>
<groupid>org.apache.maven.plugins</groupid>
<artifactid>maven-dependency-plugin</artifactid>
<version>3.1.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>copy-dependencies</goal>
</goals>
<configuration>
<outputdirectory>${project.build.directory}/dependencies/</outputdirectory>
<includescope>runtime</includescope>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
打包后结构

jar包解压后看长啥样
├── meta-inf
│ ├── manifest.mf
│ └── maven
│ └── org.example
│ └── java-demo
│ ├── pom.properties
│ └── pom.xml
└── org
└── example
└── app.class
jar包中的manifest.mf文件
manifest-version: 1.0 created-by: maven jar plugin 3.2.0 build-jdk-spec: 17 class-path: dependencies/fastjson2-2.0.60.jar <-第三方依赖包在这里 main-class: org.example.app <-启动类
执行命令
java -jar java-demo-1.0-snapshot.jar
- 优点:jar 小、依赖清晰
- 缺点:必须保证
dependencies/目录在 jar 同级,否则运行失败!
方式二:maven-assembly-plugin—— “全家桶打包”
生成一个 fat jar,把你的代码 + 所有依赖的 class 全部塞进去。
pom.xml 配置
<build>
<plugins>
<plugin>
<groupid>org.apache.maven.plugins</groupid>
<artifactid>maven-assembly-plugin</artifactid>
<version>3.1.0</version>
<configuration>
<finalname>java-demo</finalname>
<descriptorrefs>
<descriptorref>jar-with-dependencies</descriptorref>
</descriptorrefs>
<archive>
<manifest>
<mainclass>org.example.app</mainclass>
</manifest>
</archive>
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
打包后结构

target/
├── java-demo-jar-with-dependencies.jar ← 可执行 fat jar
└── java-demo-1.0-snapshot.jar ← 原始包(不可执行)
可执行jar包的解压后长啥样

jar包的manifest.mf文件
manifest-version: 1.0 created-by: apache maven 3.9.8 built-by: administrator build-jdk: 17.0.11 main-class: org.example.app
执行命令
java -jar java-demo-jar-with-dependencies.jar
- 优点:一个文件搞定,部署简单
- 缺点:依赖类直接合并,容易因同名类冲突导致运行时错误
方式三:maven-shade-plugin—— “高级防冲突版”
不仅能打包所有依赖,还支持 类重定位(relocation) ,从根本上避免类冲突。类重定位其实就是动态的移动、修改jar包中的类名、包名。
pom.xml 配置(基础版)
<plugin>
<groupid>org.apache.maven.plugins</groupid>
<artifactid>maven-shade-plugin</artifactid>
<version>3.2.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<!-- 此处按需编写更具体的配置 -->
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.manifestresourcetransformer">
<mainclass>org.example.app</mainclass>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
如需解决冲突,可加 <relocations> 重命名包路径(此处略,按需扩展)。
打包后结构

target/
├── java-demo-1.0-snapshot.jar ← 可执行最终包,把项目中的代码及所依赖的第三方jar的class文件都打进去了
└── original-java-demo-1.0-snapshot.jar ← 原始包(备份),不能直接执行,只包含项目中自有的代码,menifest.mf文件中连main-class都没有。
可执行jar包的解压后长啥样

jar包的manifest.mf文件
manifest-version: 1.0 created-by: maven jar plugin 3.4.1 build-jdk-spec: 17 main-class: org.example.app
执行命令
java -jar java-demo-1.0-snapshot.jar
- 优点:支持类重定位、稳定性高、被 spring boot 等广泛采用
- 缺点:jar 体积大,配置略复杂
动态重命名包示例
如果最终的 jar 包被其他的项目所依赖的话, classpath 中可能存在重复的 class 文件,直接地引用此 jar 包中的类可能会导致类加载冲突。为了解决这个问题,我们可以使用 shade 提供的重定位功能,把部分类移动到一个全新的包中。
<build>
<plugins>
<plugin>
<groupid>org.apache.maven.plugins</groupid>
<artifactid>maven-shade-plugin</artifactid>
<version>3.2.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.manifestresourcetransformer">
<mainclass>org.example.app</mainclass>
</transformer>
</transformers>
<relocations>
<relocation>
<!--在打包时,将项目中的原始包com.alibaba.fastjson2,重命名为com.asia.fastjson2-->
<pattern>com.alibaba.fastjson2</pattern>
<shadedpattern>com.asia.fastjson2</shadedpattern>
<!--排除以下类路径,保持不动-->
<excludes>
<exclude>com.alibaba.fastjson2.json</exclude>
<exclude>com.alibaba.fastjson2.filter.*</exclude>
</excludes>
</relocation>
</relocations>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
涉及标签:
<pattern>:原始包名<shadedpattern>:重命名后的包名<excludes>:原始包内不需要重定位的类,类名支持通配符
jar包解压后看什么样

.
├── com
│ ├── alibaba
│ │ └── fastjson2
│ │ ├── filter
│ │ └── json.class
│ └── asia
│ └── fastjson2
│ ├── annotation
│ ├── codec
│ ├── function
│ ├── internal
│ ├── 省略。。。
│ ├── typereference.class
│ ├── util
│ └── writer
├── meta-inf
│ ├── manifest.mf
│ ├── maven
│ │ ├── com.alibaba.fastjson2
│ │ │ └── fastjson2
│ │ └── org.example
│ │ └── java-demo
│ ├── native-image
│ │ └── com.alibaba.fastjson2
│ │ └── fastjson2
│ ├── proguard
│ │ └── fastjson2.pro
│ ├── scm
│ │ └── com.alibaba.fastjson2
│ │ └── fastjson2
│ └── versions
│ └── 9
│ └── module-info.class
├── org
│ └── example
│ └── app.class
└── schema
├── 2020-12.json
└── draft-04.json
一张表看懂怎么选
| 插件 | 是否含依赖 | 是否可直接运行 | 能否防冲突 | 推荐场景 |
|---|---|---|---|---|
| maven-jar-plugin | ❌(外置) | ✅(需依赖目录) | ❌ | 轻量部署、依赖独立管理 |
| maven-assembly-plugin | ✅ | ✅ | ❌ | 快速打包、简单项目 |
| maven-shade-plugin | ✅ | ✅ | ✅(支持重定位) | 复杂项目、生产环境 |
到此这篇关于java打包可执行jar文件的三种方式详解的文章就介绍到这了,更多相关java打包jar内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网!
发表评论