【Maven】使用maven-jar、maven-assembly、maven-shade优雅的实现第三方依赖一同打Jar包

2024-03-21 06:44
文章标签 maven 实现 使用 依赖 优雅 第三方 jar assembly shade 一同

本文主要是介绍【Maven】使用maven-jar、maven-assembly、maven-shade优雅的实现第三方依赖一同打Jar包，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

文章目录

  • 一.前言
  • 二.常规Jar 打包：maven-jar-plugin
  • 三.Shade 打包：maven-shade-plugin
    • 1.如何使用
    • 2.将部分jar包添加或排除
    • 3.将依赖jar包内部资源添加或排除
    • 4.自动将所有不使用的类排除
    • 5.将依赖的类重命名并打包进来 （隔离方案）
    • 6.修改包的后缀名
    • 7.异常：Invalid signature file digest for Manifest main attributes
  • 四.Assembly 打包方式：maven-assembly-plugin
  • 五.IDEA使用 Maven Assembly 插件的具体实现

一.前言

maven提供的打包插件有如下三种

  • maven-jar-plugin maven 默认打包插件【springboot默认使用该方式打包】，用来创建 project jar
  • maven-shade-plugin 用来打可执行包，executable(fat) jar
  • maven-assembly-plugin 支持定制化打包方式，例如 apache 项目的打包方式

二.常规Jar 打包：maven-jar-plugin

  • 使用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><!-- 可执行jar包需要指定入口函数 然后通过java -jar执行 --><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选择的打包某些内容

三.Shade 打包：maven-shade-plugin

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

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

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

1.如何使用

  • maven-shade-plugin 只存在一个goal ：shade: ，需要将其绑定到 package的生命周期上面 上
    <build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.2.4</version><executions><execution><phase>package</phase><!-- 绑定到package生命周期阶段上 --><goals><goal>shade</goal></goals><configuration><!--默认情况下，通过mvn package生成的jar包中因为没有指定Main-Class属性，因此并不能使用-jar配置直接运行。需要配置Main-Class。--><!--mainClass可有可无,加上的话则直接生成可运行jar包 通过java -jar xxx.jar执行--><!--<transformers><transformerimplementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><mainClass>com.example.App</mainClass></transformer></transformers>--></configuration></execution></executions></plugin></plugins></build>
  • 打包后target 目录下会生成可执行 Jar包。该包里面包含项目中使用了和没使用的的所有第三方包代码

2.将部分jar包添加或排除

        <plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.2.4</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>
  • jar包以 groupId : artifactId[[:type] : classifier]的形式表示
  • 1.3版本后插件支持通配符 ‘*’ and ‘?’

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

        <plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.2.4</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>

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

        <plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.2.4</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><minimizeJar>true</minimizeJar> <!--这里--></configuration></execution></executions></plugin>

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

            <plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.2.4</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>
  • 将org.codehaus.plexus.util重命名为org.shaded.plexus.util，原始jar包中的org.codehaus.plexus.util.xml.Xpp3Dom和org.codehaus.plexus.util.xml.pull不会被重命名到目的包中

6.修改包的后缀名

  • 会生成一个以 “-oyjp”为结尾的jar包
        <plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.2.4</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><shadedArtifactAttached>true</shadedArtifactAttached><shadedClassifierName>oyjp</shadedClassifierName> <!--这里 --></configuration></execution></executions></plugin>

7.异常：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；

在生成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>

四.Assembly 打包方式：maven-assembly-plugin

  • 使用maven-assembly-plugin插件 。

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

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

src/main/assembly/编写描述符文件assembly.xml

<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>

在这里插入图片描述

五.IDEA使用 Maven Assembly 插件的具体实现

1.修改pom.xml文件

    <build><plugins><plugin><artifactId>maven-assembly-plugin</artifactId><version>2.6</version><configuration><descriptorRefs><descriptorRef>jar-with-dependencies</descriptorRef></descriptorRefs><archive><!--mainClass可有可无,加上的话则直接生成可运行jar包 通过java -jar xxx.jar执行--><manifest><mainClass>Main.Main</mainClass></manifest></archive></configuration><executions><execution><id>make-assembly</id><phase>package</phase><goals><goal>single</goal></goals></execution></executions></plugin></plugins></build>
  • 在执行 Maven 打包命令 (mvn clean package) 会在target 目录下找到一个包含所有依赖项的可执行 *-with-dependencies.jar包。
    • 注： 最终的 jar包可能非常大，因为它包含了所有依赖包。如果只想打包应用程序本身而不包含其他依赖，可以考虑编写描述符文件或者使用 Maven Shade 插件来进行定制。

2.使用assembly打包 先使用clean清除 然后使用assembly打包
在这里插入图片描述

3.打完包会在target目录下生成两个jar包，如果你有用maven引用外部jar，使用*-with-dependencies.jar包即可。

在这里插入图片描述

4.如果要打包的项目依赖其他项目打包的jar，需要添加file -> project-structure... -> Libraries，点击+号添加对应的jar到项目，还需要再pom.xml再引用一下`
在这里插入图片描述
5.如果项目中使用junit，导致打包失败

在这里插入图片描述

这篇关于【Maven】使用maven-jar、maven-assembly、maven-shade优雅的实现第三方依赖一同打Jar包的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/832012。

相关文章

中文分词jieba库的使用与实景应用（一）

中文分词jieba库的使用与实景应用（一）

知识星球：https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义： 精确模式（默认模式）： 全模式： 搜索引擎模式： paddle 模式（基于深度学习的分词模式）： 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取
阅读更多...
使用SecondaryNameNode恢复NameNode的数据

使用SecondaryNameNode恢复NameNode的数据

1）需求： NameNode进程挂了并且存储的数据也丢失了，如何恢复NameNode 此种方式恢复的数据可能存在小部分数据的丢失。 2）故障模拟 （1）kill -9 NameNode进程 [lytfly@hadoop102 current]$ kill -9 19886 （2）删除NameNode存储的数据（/opt/module/hadoop-3.1.4/data/tmp/dfs/na
阅读更多...
Hadoop数据压缩使用介绍

Hadoop数据压缩使用介绍

一、压缩原则 （1）运算密集型的Job，少用压缩 （2）IO密集型的Job，多用压缩 二、压缩算法比较 三、压缩位置选择 四、压缩参数配置 1）为了支持多种压缩/解压缩算法，Hadoop引入了编码/解码器 2）要在Hadoop中启用压缩，可以配置如下参数
阅读更多...
Makefile简明使用教程

Makefile简明使用教程

文章目录 规则makefile文件的基本语法：加在命令前的特殊符号：.PHONY伪目标: Makefilev1 直观写法v2 加上中间过程v3 伪目标v4 变量 make 选项-f-n-C Make 是一种流行的构建工具，常用于将源代码转换成可执行文件或者其他形式的输出文件(如库文件、文档等)。Make 可以自动化地执行编译、链接等一系列操作。 规则 makefile文件
阅读更多...
每天认识几个maven依赖（ActiveMQ+activemq-jaxb+activesoap+activespace+adarwin）

每天认识几个maven依赖（ActiveMQ+activemq-jaxb+activesoap+activespace+adarwin）

八、ActiveMQ 1、是什么？ ActiveMQ 是一个开源的消息中间件（Message Broker），由 Apache 软件基金会开发和维护。它实现了 Java 消息服务（Java Message Service, JMS）规范，并支持多种消息传递协议，包括 AMQP、MQTT 和 OpenWire 等。 2、有什么用？ 可靠性：ActiveMQ 提供了消息持久性和事务支持，确保消
阅读更多...
hdu1043（八数码问题，广搜 + hash（实现状态压缩） ）

hdu1043（八数码问题，广搜 + hash（实现状态压缩） ）

利用康拓展开将一个排列映射成一个自然数，然后就变成了普通的广搜题。 #include<iostream>#include<algorithm>#include<string>#include<stack>#include<queue>#include<map>#include<stdio.h>#include<stdlib.h>#include<ctype.h>#inclu
阅读更多...
使用opencv优化图片（画面变清晰）

使用opencv优化图片（画面变清晰）

文章目录 需求影响照片清晰度的因素 实现降噪测试代码 锐化空间锐化Unsharp Masking频率域锐化对比测试 对比度增强常用算法对比测试 需求 对图像进行优化，使其看起来更清晰，同时保持尺寸不变，通常涉及到图像处理技术如锐化、降噪、对比度增强等 影响照片清晰度的因素 影响照片清晰度的因素有很多，主要可以从以下几个方面来分析 1. 拍摄设备 相机传感器：相机传
阅读更多...
【C++】_list常用方法解析及模拟实现

【C++】_list常用方法解析及模拟实现

相信自己的力量，只要对自己始终保持信心，尽自己最大努力去完成任何事，就算事情最终结果是失败了，努力了也不留遗憾。💓💓💓 目录   ✨说在前面 🍋知识点一：什么是list？ •🌰1.list的定义 •🌰2.list的基本特性 •🌰3.常用接口介绍 🍋知识点二：list常用接口 •🌰1.默认成员函数 🔥构造函数（⭐） 🔥析构函数 •🌰2.list对象
阅读更多...
【Prometheus】PromQL向量匹配实现不同标签的向量数据进行运算

【Prometheus】PromQL向量匹配实现不同标签的向量数据进行运算

✨✨ 欢迎大家来到景天科技苑✨✨ 🎈🎈 养成好习惯，先赞后看哦~🎈🎈 🏆 作者简介：景天科技苑 🏆《头衔》：大厂架构师，华为云开发者社区专家博主，阿里云开发者社区专家博主，CSDN全栈领域优质创作者，掘金优秀博主，51CTO博客专家等。 🏆《博客》：Python全栈，前后端开发，小程序开发，人工智能，js逆向，App逆向，网络系统安全，数据分析，Django，fastapi
阅读更多...
让树莓派智能语音助手实现定时提醒功能

让树莓派智能语音助手实现定时提醒功能

最初的时候是想直接在rasa 的chatbot上实现，因为rasa本身是带有remindschedule模块的。不过经过一番折腾后，忽然发现，chatbot上实现的定时，语音助手不一定会有响应。因为，我目前语音助手的代码设置了长时间无应答会结束对话，这样一来，chatbot定时提醒的触发就不会被语音助手获悉。那怎么让语音助手也具有定时提醒功能呢？ 我最后选择的方法是用threading.Time
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2