Maven - 打包之争：Jar vs. Shade vs. Assembly

文章目录

  • Pre
  • 概述
  • Jar 打包方式_maven-jar-plugin
    • Overview
    • 使用
    • 官方文档
  • Shade 打包方式_maven-shade-plugin
    • Overview
    • 使用
      • 将部分jar包添加或排除
      • 将依赖jar包内部资源添加或排除
      • 自动将所有不使用的类排除
      • 将依赖的类重命名并打包进来 （隔离方案）
      • 修改包的后缀名
    • 官方文档
  • Assembly 打包方式_maven-assembly-plugin
    • Overview
    • 使用
    • 官方文档

在这里插入图片描述

Pre

Maven - 统一构建规范：Maven 插件管理最佳实践

在这里插入图片描述

概述

Maven 提供了多种打包方式，其中常见的包括三种：jar、shade、assembly。下面是它们的详细比较：

  1. Jar 打包方式：

    • 描述： 这是最常见的打包方式，它创建一个标准的Java JAR文件。
    • 优点： 简单直接，适用于大多数简单项目。
    • 缺点： 不能包含项目的依赖，如果项目有外部依赖，用户必须手动将它们添加到类路径中。

  2. Shade 打包方式：

    • 描述： Maven Shade插件允许创建一个可执行的JAR文件，其中包含所有依赖。
    • 优点： 生成一个独立的可执行JAR，无需用户手动添加依赖。
    • 缺点： 可能会导致JAR文件较大，不适合所有项目。

  3. Assembly 打包方式：

    • 描述： Maven Assembly插件提供了一种更灵活的打包方式，允许创建各种自定义分发包。
    • 优点： 可以根据项目的需要创建定制的分发包，非常灵活。
    • 缺点： 配置相对复杂，适用于需要高度定制化的项目。

总结 ：

  • Jar方式适用于简单项目，但对于有依赖的项目需要手动处理依赖 ; 默认的打包方式，用来打普通的project JAR包；。
  • Shade方式生成可执行JAR，但可能导致文件较大; 用来打可执行jar包，也就是所谓的fat JAR包。
  • Assembly方式最灵活，可以根据项目需求创建定制分发包 ; 自定义的打包结构，也可以定制依赖项等。

Jar 打包方式_maven-jar-plugin

Overview

使用maven-jar-plugin插件， 默认的打包方式，用来打普通的project JAR包 .

使用

<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-jar-plugin</artifactId><version>3.1.0</version><configuration><archive><manifest><!-- 指定入口函数 --><mainClass>类的全路径名称</mainClass><!-- 是否添加依赖的jar路径配置 --><addClasspath>true</addClasspath><!-- 依赖的jar包存放位置，和生成的jar放在同一级目录下 --><classpathPrefix>lib/</classpathPrefix></manifest></archive><!-- 不打包com.artisan.excludes下面的所有类 --><excludes>com/artisan/excludes/*</excludes></configuration></plugin></plugins>
</build>

上面配置使用这个 jar包的时候就需要在它同一级的创建一个lib目录来存放。 可以使用includes或excludes选择的打包某些内容

官方文档

https://maven.apache.org/shared/maven-archiver/examples/classpath.html

Shade 打包方式_maven-shade-plugin

Overview

插件：使用maven-shade-plugin插件

maven-shade-plugin提供了两大基本功能：

  • 将依赖的jar包打包到当前jar包（常规打包是不会将所依赖jar包打进来的）；
  • 对依赖的jar包进行重命名（用于类的隔离）；

使用

maven-shade-plugin 只存在一个goal shade:shade，需要将其绑定到 phase package 上

<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.1.1</version><configuration><!-- put your configurations here --></configuration><executions><execution><phase>package</phase><goals><goal>shade</goal></goals></execution></executions></plugin></plugins>
</build>

然后在当前pom文件所在路径下，执行打包命令：mvn clean package

将部分jar包添加或排除

<project>...<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.1.1</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><artifactSet><excludes><exclude>jmock:*</exclude><exclude>*:xml-apis</exclude><exclude>org.apache.maven:lib:tests</exclude><exclude>log4j:log4j:jar:</exclude></excludes><includes><include>junit:junit</include></includes></artifactSet></configuration></execution></executions></plugin></plugins></build>...
</project>
  • jar包以groupId:artifactId[[:type]:classifier]的形式表示
  • 1.3版本后插件支持通配符 ‘*’ and ‘?’

将依赖jar包内部资源添加或排除

<project>...<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.1.1</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><filters><filter><artifact>junit:junit</artifact><includes><include>junit/framework/**</include><include>org/junit/**</include></includes><excludes><exclude>org/junit/experimental/**</exclude><exclude>org/junit/runners/**</exclude></excludes></filter><filter><artifact>*:*</artifact><excludes><exclude>META-INF/*.SF</exclude><exclude>META-INF/*.DSA</exclude><exclude>META-INF/*.RSA</exclude></excludes></filter></filters></configuration></execution></executions></plugin></plugins></build>...
</project>

自动将所有不使用的类排除

<project>...<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.1.1</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><minimizeJar>true</minimizeJar></configuration></execution></executions></plugin></plugins></build>...
</project>

将依赖的类重命名并打包进来 （隔离方案）

<project>...<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.1.1</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><relocations><relocation><pattern>org.codehaus.plexus.util</pattern><shadedPattern>org.shaded.plexus.util</shadedPattern><excludes><exclude>org.codehaus.plexus.util.xml.Xpp3Dom</exclude><exclude>org.codehaus.plexus.util.xml.pull.*</exclude></excludes></relocation></relocations></configuration></execution></executions></plugin></plugins></build>...
</project>

将“org.codehaus.plexus.util”重命名为“org.shaded.plexus.util”，原始jar包中的“org.codehaus.plexus.util.xml.Xpp3Dom”和“org.codehaus.plexus.util.xml.pull”不会被重命名到目的包中；

修改包的后缀名

默认会生成一个Jar包和一个以 “-shaded”为结尾的uber-jar包，可以通过配置来指定uber-jar的后缀名。

<project>...<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.1.1</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><shadedArtifactAttached>true</shadedArtifactAttached><shadedClassifierName>jackofall</shadedClassifierName> <!-- Any name that makes sense --></configuration></execution></executions></plugin></plugins></build>...
</project>

Invalid signature file digest for Manifest main attributes

原因：有些jar包生成时，会 使用jarsigner生成文件签名（完成性校验），分为两个文件存放在META-INF目录下：

a signature file, with a .SF extension；
a signature block file, with a .DSA, .RSA, or .EC extension；

需要在生成 uber-jar时，将这些排除掉，不再进行完成性校验，如下所示：

<configuration><filters><filter><artifact>*:*</artifact><excludes><exclude>META-INF/*.SF</exclude><exclude>META-INF/*.DSA</exclude><exclude>META-INF/*.RSA</exclude></excludes></filter></filters>
</configuration>

https://maven.apache.org/plugins/maven-shade-plugin/examples/attached-artifact.html

官方文档

https://maven.apache.org/plugins/maven-shade-plugin/examples/attached-artifact.html

Assembly 打包方式_maven-assembly-plugin

Overview

使用maven-assembly-plugin插件 。

日常使用比较多的是maven-assembly-plugin插件

例如：大数据项目中往往有很多shell脚本、SQL脚本、.properties及.xml配置项等，采用assembly插件可以让输出的结构清晰而标准化

使用

首先在pom文件添加以下内容：

<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-assembly-plugin</artifactId><version>${maven-assembly-plugin.version}<version><executions><execution><id>make-assembly</id><!-- 绑定到package生命周期 --><phase>package</phase><goals><!-- 只运行一次 --><goal>single</goal></goals></execution></executions><configuration><!-- 配置描述符文件 --><descriptor>src/main/assembly/assembly.xml</descriptor><!-- 也可以使用Maven预配置的描述符<descriptorRefs><descriptorRef>jar-with-dependencies</descriptorRef></descriptorRefs> --></configuration></plugin></plugins>
</build>

然后编写描述符文件：

<assembly><id>assembly</id><formats><format>tar.gz</format></formats><includeBaseDirectory>true</includeBaseDirectory><fileSets><fileSet><directory>src/main/bin</directory><includes><include>*.sh</include></includes><outputDirectory>bin</outputDirectory><fileMode>0755</fileMode></fileSet><fileSet><directory>src/main/conf</directory><outputDirectory>conf</outputDirectory></fileSet><fileSet><directory>src/main/sql</directory><includes><include>*.sql</include></includes><outputDirectory>sql</outputDirectory></fileSet><fileSet><directory>target/classes/</directory><includes><include>*.properties</include><include>*.xml</include><include>*.txt</include></includes><outputDirectory>conf</outputDirectory></fileSet></fileSets><files><file><source>target/${project.artifactId}-${project.version}.jar</source><outputDirectory>.</outputDirectory></file></files><dependencySets><dependencySet><unpack>false</unpack><scope>runtime</scope><outputDirectory>lib</outputDirectory></dependencySet></dependencySets>
</assembly>
字段解析
formats是assembly插件支持的打包文件格式，有zip、tar、tar.gz、tar.bz2、jar、war。可以同时定义多个formats。
id是添加到打包文件名的标识符，用来做后缀。比如说，如果按上面的配置，生成的文件就是artifactId-{artifactId}-artifactId-{version}-assembly.tar.gz
fileSets/fileSet用来设置一组文件在打包时的属性。
directory源目录的路径。
includes/excludes设定包含或排除哪些文件，支持通配符。
fileMode指定该目录下的文件属性，采用Unix八进制描述法，默认值是064。
outputDirectory生成目录的路径。
files/file与fileSets大致相同，不过是指定单个文件，并且还可以通过destName属性来设置与源文件不同的名称。
dependencySets/dependencySet用来设置工程依赖文件在打包时的属性，也与fileSets大致相同。
dependencySet-unpack布尔值，false表示将依赖以原来的JAR形式打包，true则表示将依赖解成*.class文件的目录结构打包。
dependencySet-scope表示符合哪个作用范围的依赖会被打包进去。compile与provided都不用管，一般是写runtime。

按照以上配置打包好后，将.tar.gz文件上传到服务器，解压之后就会得到bin、conf、lib等规范化的目录结构，十分方便。

官方文档

https://maven.apache.org/plugins/maven-assembly-plugin/examples/single/filtering-some-distribution-files.html

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/216404.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

鸿蒙(HarmonyOS)应用开发——安装DevEco Studio安装

鸿蒙(HarmonyOS)应用开发——安装DevEco Studio安装

前言 HarmonyOS华为开发的操作系统&#xff0c;旨在为多种设备提供统一的体验。它采用了分布式架构&#xff0c;可以在多个设备上同时运行&#xff0c;提供更加流畅的连接和互动。HarmonyOS的目标是提供更高的安全性、更高效、响应更快的用户体验&#xff0c;并通过跨设备功能…
阅读更多...
外汇天眼：香港监管机构对AMTD Global Markets Limited启动法律诉讼

外汇天眼：香港监管机构对AMTD Global Markets Limited启动法律诉讼

香港证监会&#xff08;SFC&#xff09;已经启动了法律程序&#xff0c;要求首次审裁法院调查AMTD Global Markets Limited&#xff08;AMTD&#xff0c;目前以orientiert XYZ Securities Limited为名&#xff09;及其前高管在与首次公开发行&#xff08;IPO&#xff09;相关的…
阅读更多...
王道p150 14.假设二叉树采用二叉链表存储结构，设计一个算法，求非空二叉树 b的宽度(即具有结点数最多的那一层的结点个数) （c语言代码实现）

王道p150 14.假设二叉树采用二叉链表存储结构，设计一个算法，求非空二叉树 b的宽度(即具有结点数最多的那一层的结点个数) （c语言代码实现）

采用层次遍历的方法求出所有结点的层次&#xff0c;并将所有结点和对应的层次放在一个队列中。然后通过扫描队列求出各层的结点总数&#xff0c;最大的层结点总数即为二叉树的宽度。 /* A B C D E F …
阅读更多...
React UI界面：Ant Design初步

React UI界面：Ant Design初步

文章目录 初步回调函数变量输出 React初步 初步 Antd是一套非常现代的React组件库&#xff0c;是好多人用过的第一个组件库&#xff0c;但我对其印象最深的却是圣诞节彩蛋&#xff0c;只是上网一查才发现&#xff0c;一晃这么多年过去了。 先创建一个React项目&#xff0c;然…
阅读更多...
实验室信息管理系统源码，LIS系统源码，lis源码

实验室信息管理系统源码，LIS系统源码，lis源码

医学检验(LIS)管理系统源码&#xff0c;云LIS系统全套商业源码 随着全自动生化分析仪、全自动免疫分析仪和全自动血球计数器等仪器的使用&#xff0c;检验科的大多数项目实现了全自动化分析。全自动化分析引入后&#xff0c;组合化验增多&#xff0c;更好的满足了临床需要&…
阅读更多...
RabbitMQ之发送者（生产者）可靠性

RabbitMQ之发送者（生产者）可靠性

文章目录 前言一、生产者重试机制二、生产者确认机制实现生产者确认&#xff08;1&#xff09;定义ReturnCallback&#xff08;2&#xff09;定义ConfirmCallback 总结 前言 生产者重试机制、生产者确认机制。 一、生产者重试机制 问题&#xff1a;生产者发送消息时&#xff0…
阅读更多...
记录华为云服务器（Linux 可视化 宝塔面板）-- 安全组篇

记录华为云服务器（Linux 可视化 宝塔面板）-- 安全组篇

文章目录 前言安全组说明安全组的特性安全组的应用场景 进入安全组添加基本规则添加自定义规则如有启发&#xff0c;可点赞收藏哟~ 前言 和windows防火墙类似&#xff0c;安全组是一种虚拟防火墙&#xff0c;具备状态检测和数据包过滤功能&#xff0c;可以对进出云服务器的流量…
阅读更多...
golang panic关键词执行原理与代码分析

golang panic关键词执行原理与代码分析

使用的go版本为 go1.21.2 首先我们写一个简单的panic调度与捕获代码 package mainfunc main() {defer func() {recover()}()panic("panic test") }通过go build -gcflags -S main.go获取到对应的汇编代码 可以看到当我们调度panic时&#xff0c;Go的编译器会将这段…
阅读更多...
《尚品甄选》：后台系统——权限管理之角色管理（debug一遍）

《尚品甄选》：后台系统——权限管理之角色管理（debug一遍）

文章目录 一、权限管理介绍二、表结构的设计三、查询角色四、添加角色五、修改角色六、删除角色 一、权限管理介绍 在后台管理系统中&#xff0c;权限管理是指为了保证系统操作的安全性和可控性&#xff0c;对用户的操作权限进行限制和管理。简单的来说就是某一个用户可以使用…
阅读更多...
2014年全国硕士研究生入学统一考试管理类专业学位联考数学试题——解析版

2014年全国硕士研究生入学统一考试管理类专业学位联考数学试题——解析版

文章目录 2014 年考研管理类联考数学真题一、问题求解&#xff08;本大题共 15 小题&#xff0c;每小题 3 分&#xff0c;共 45 分&#xff09;下列每题给出 5 个选项中&#xff0c;只有一个是符合要求的&#xff0c;请在答题卡上将所选择的字母涂黑。真题&#xff08;2014-01&…
阅读更多...
2024年襄阳中级工程师职称评审条件及要求

2024年襄阳中级工程师职称评审条件及要求

想要评审襄阳市中级工程师职称的小伙伴看过来&#xff0c;襄阳人社局对于评审所需的条件及要求如下。秋禾火带大家详细来了解一下 评审范围和人员要求 评审所申报的企业必须是在襄阳市注册登记满一年以上&#xff0c;正常运作的非公有制企业&#xff08;也就是私企&#xff09…
阅读更多...
科普：多领域分布式协同仿真

科普：多领域分布式协同仿真

分布式协同仿真是一种在分布式计算环境中进行协同工作的仿真方法。使用该方法进行协同仿真时&#xff0c;仿真任务将被分发到多个计算节点上&#xff0c;并且这些节点可以同时工作以模拟完整的系统行为。分布式协同仿真已被广泛应用于工程、科学和军事领域&#xff0c;以便更好…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023