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

news2024/9/23 5:23:07

文章目录

  • 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.coloradmin.cn/o/1249063.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

【合集一】每日一练30讲，轻松掌握Verilog语法

【合集一】每日一练30讲，轻松掌握Verilog语法

本原创教程由深圳市小眼睛科技有限公司创作&#xff0c;版权归本公司所有&#xff0c;如需转载&#xff0c;需授权并注明出处&#xff08;www.meyesemi.com) 第一练&#xff1a;如何区分&#xff1c;&#xff1d;表示的含义&#xff1f; 题目&#xff1a;请描述以下两种方法产…
阅读更多...
什么年代了，你还不会自动化测试？

什么年代了，你还不会自动化测试？

一、前言 在软件测试中&#xff0c;自动化测试指的是使用独立于待测软件的其他软件来自动执行测试、比较实际结果与预期并生成测试报告这一过程。在测试流程已经确定后&#xff0c;测试自动化可以自动执行的一些重复但必要测试工作。也可以完成手动测试几乎不可能完成的测试。…
阅读更多...
葡萄酒怎么按照饮用时间分类？

葡萄酒怎么按照饮用时间分类？

不同的葡萄酒搭配不同的餐食&#xff0c;会让饮酒人有不一样的感受和体会&#xff0c;所以&#xff0c;葡萄酒是分场合并且有饮用时间的。云仓酒庄的品牌雷盛红酒分享一般按照饮用时间分类可以把葡萄酒分为三大类&#xff0c;分别是餐前酒、佐餐酒和餐后酒。 餐前酒&#xff1…
阅读更多...
Multi-Modal Multi-Stream UNET Model for Liver Segmentation

Multi-Modal Multi-Stream UNET Model for Liver Segmentation

方法 作者未提供代码
阅读更多...
C++之模版初阶（简单使用模版）

C++之模版初阶（简单使用模版）

前言 在学习C的模版之前&#xff0c;咱们先来说一说模版的概念&#xff0c;模版在我们的日常生活中非常常见&#xff0c;比如我们要做一个ppt&#xff0c;我们会去在WPS找个ppt的模版&#xff0c;我们只需要写入内容即可&#xff1b;比如我们的数学公式&#xff0c;给公式套值&…
阅读更多...
Python监控服务进程及自启动服务方法与实践

Python监控服务进程及自启动服务方法与实践

1. 需求概述 当我们在Windows Server环境中部署XX系统的实际应用中&#xff0c;往往会遇到一些运维管理的挑战。为了确保系统的持续稳定运行&#xff0c;特别是在服务程序因各种原因突然关闭的情况下&#xff0c;我们可以借助Python的强大生态系统来构建一个监控与自动重启的管…
阅读更多...
CBTC 2023氢能展倒计时6天，最新同期会议活动Plus版发布

CBTC 2023氢能展倒计时6天，最新同期会议活动Plus版发布

随着时间的推移&#xff0c;CBTC2023深圳氢能技术展览会即将拉开序幕。这场盛会将于11月30日在深圳福田会展中心盛大开幕&#xff0c;以“以储赋能&#xff0c;智造未来”为主题&#xff0c;旨在搭建一个商务交流、供需合作、创新产品发布的平台&#xff0c;让氢能全产业链之间…
阅读更多...
要想固态跑得稳，散热器也要够扎实，ORICO J-10 固态散热组合体验

要想固态跑得稳，散热器也要够扎实，ORICO J-10 固态散热组合体验

我们在日常工作中&#xff0c;经常需要读写各种体积庞大的文件和数据&#xff0c;如果硬盘速度跟不上的话&#xff0c;工作效率就会大大降低。最近我发现M.2固态硬盘的价格已经大幅降低了&#xff0c;越来越多的国产品牌开始加入其中。所以我最近入手了一款ORICO J-10固态硬盘&…
阅读更多...
HHDESK客户端连接导入导出

HHDESK客户端连接导入导出

HHDESK客户端连接可以一键导出xlsx表格进行备份&#xff0c;也可一键导入设置连接。 1 导出 点击“资源”——“导出” 在弹出框中选择“保存”即可。 2 导入 右键“资源”——“导入” 点击“浏览”&#xff0c;选择相应的xlsx文档&#xff1b; 点击“确认”。 选择“…
阅读更多...
一、TIDB基础

一、TIDB基础

TIDB整个逻辑架构跟MYSQL类似&#xff0c;如下&#xff1a; TIDB集群&#xff1a;相当于MYSQL的数据库服务器&#xff0c;区别是MYSQL数据库服务器为单进程的&#xff0c;TIDB集群为分布式多进程的。 数据库&#xff1a;同MYSQL数据库&#xff0c;数据库属于集群&#xff0c;…
阅读更多...
持续集成交付CICD：GitLabCI 通过trigger触发流水线

持续集成交付CICD：GitLabCI 通过trigger触发流水线

目录 一、理论 1.GitLabCI 二、实验 1.搭建共享库项目 2.GitLabCI 通过trigger触发流水线 三、问题 1.项目app02未触发项目app01 2.GitLab 报502网关错误 一、理论 1.GitLabCI (1) 概念 GitLab CI&#xff08;Continuous Integration&#xff09;是一种持续集成工具…
阅读更多...
convertRect:toView 方法注意事项

convertRect:toView 方法注意事项

这是在网上找到的一张图 我们开发中有时候会用到左边转换&#xff0c;convertRect:toView 通常情况下&#xff0c;我们回这样使用 CGRect newRect [a convertRect:originframe toView:c];其中newRect和 originframe的size相同&#xff0c;只改变origin newRect.origin a…
阅读更多...
@ResponseBody详解

@ResponseBody详解

ResponseBody() 作用&#xff1a; responseBody注解的作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后&#xff0c;写入到response对象的body区&#xff0c;通常用来返回JSON数据或者是XML数据。 位置&#xff1a; ResponseBody是作用在方法上的&…
阅读更多...
AlphaPose-RKNN-rk3588

AlphaPose-RKNN-rk3588

1. AlphaPose背景介绍 AlphaPose是一个用于人体姿态估计的开源工具。人体姿态估计在计算机视觉中是一个核心问题&#xff0c;它旨在定位并识别图像或视频中的人体关键点和骨骼结构。在许多应用中&#xff0c;如动作识别、行为分析、虚拟现实和增强现实&#xff0c;人体姿态估计…
阅读更多...
解释PCIe MSI 中断要求中断向量连续？PCIe 规范里并没有明确指出

解释PCIe MSI 中断要求中断向量连续？PCIe 规范里并没有明确指出

MSI 向量必须连续&#xff1f; 前言 MSI 物理条件&#xff0c;MSI 中断产生的逻辑是RC初始化的时候&#xff0c;由软件将配置写入到 EP 的 2 个寄存器中&#xff0c;这两个寄存器一个指示的是地址 Message Address&#xff0c;一个指示的是数据 Message Data。当 EP 试图触发…
阅读更多...
MTK联发科MT6762/MT6763/MT6765安卓核心板参数规格比较

MTK联发科MT6762/MT6763/MT6765安卓核心板参数规格比较

MT6762安卓核心板 MTK6762安卓核心板是一款工业级高性能、可运行 android9.0 操作系统的 4G智能模块。 CPU&#xff1a;4xCortex-A53 up to 2.0Ghz/4xCortex-A53 up to 1.5GhzGraphics&#xff1a;IMG GE8320 Up to 650MhzProcess&#xff1a;12nmMemory&#xff1a;1xLP3 9…
阅读更多...
2023/11/21JAVAweb学习(HTML,vscode插件,css选择器,span标签,超链接,页面布局,div标签,表格标签)

2023/11/21JAVAweb学习(HTML,vscode插件,css选择器,span标签,超链接,页面布局,div标签,表格标签)

优先级高低id > 类 > 元素 格式化ctrl alt L
阅读更多...
小学语文老师重点工作

小学语文老师重点工作

小学语文老师是学生在语言学习过程中的关键引导者&#xff0c;他们的主要职责是帮助学生建立正确的语言基础&#xff0c;培养良好的阅读习惯&#xff0c;并提高学生的语文素养。以下是小学语文老师的一些重点工作。 一、教授语言知识 小学语文老师首要的任务是教授学生语言知识…
阅读更多...
【深度学习】卷积神经网络结构组成与解释

【深度学习】卷积神经网络结构组成与解释

卷积神经网络是以卷积层为主的深度网路结构&#xff0c;网络结构包括有卷积层、激活层、BN层、池化层、FC层、损失层等。卷积操作是对图像和滤波矩阵做内积&#xff08;元素相乘再求和&#xff09;的操作。 1. 卷积层 常见的卷积操作如下&#xff1a; 卷积操作解释图解标准卷…
阅读更多...
LSTM模型预测时间序列：根据历史销量数据预测商品未来销量

LSTM模型预测时间序列：根据历史销量数据预测商品未来销量

经常会遇到一些需要预测的场景&#xff0c;比如预测品牌销售额&#xff0c;预测产品销量。 时间序列 今天分享一波使用 LSTM 进行端到端时间序列预测的完整代码和详细解释。 我们先来了解两个主题&#xff1a; 什么是时间序列分析&#xff1f; 什么是 LSTM&#xff1f; 时…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023