maven插件maven-assembly-plugin打包归纳文件zip/tar使用详解

2024-02-20 08:04

本文主要是介绍maven插件maven-assembly-plugin打包归纳文件zip/tar使用详解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 前言
  • 一、使用方式
  • 二、assembly配置文件详解
    • 1.id
    • 2.formats
    • 3.includeBaseDirectory
    • 4.fileSet
      • directory
      • outputDirectory
      • includes、excludes
    • 5.dependencySets
      • useProjectArtifact
      • outputDirectory
      • excludes
  • 三、使用assembly打包jar文件
  • 总结


前言

java项目运行的文件需要jar或者war格式,同时还需要使用Java命令。同时还可能包含一些外部的资源文件。因此要运行一个Java项目,需要多个文件配合才能启动。因此再发布的时候,我们可以使用maven-assembly-plugin插件,将我们项目需要的所有资源打包成一个zip或者gz的压缩包,这样我们发布出去的项目就是一整套运行环境,我们常用的一些中间件,比如Tomcat、zookeeper等都这样发布。下面给大家详细介绍通过maven-assembly-plugin来制作自己的发布包。

一、使用方式

和其他插件一样,要使用maven-assembly-plugin插件,我们在pom.xml中进行如下配置:

<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-assembly-plugin</artifactId><version>3.4.2</version><configuration><descriptors><descriptor>assembly/package.xml</descriptor></descriptors></configuration><executions><execution><id>make-assembly</id><phase>package</phase><goals><goal>single</goal></goals></execution></executions>
</plugin>

二、assembly配置文件详解

在上面的配置中descriptor标签引用了一个package.xml文件,这个文件也是assembly插件的解析文件,package.xml的内容如下面所示:

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"><id>win64.vm-${build.version}</id><formats><format>zip</format></formats><includeBaseDirectory>true</includeBaseDirectory><fileSets><fileSet><directory>plugins</directory><outputDirectory>\plugins</outputDirectory><includes><include>plugin.test.dll</include></includes></fileSet><fileSet><directory>prod/jvm</directory><outputDirectory>\</outputDirectory><includes><include>ServiceUpdate.bat</include></includes></fileSet><fileSet><directory>${project.build.directory}</directory><outputDirectory>\</outputDirectory><includes><include>RaspberryAgent.exe</include></includes></fileSet></fileSets>
</assembly>

下面对assembly配置进行详细说明

1.id

id标签可以指定生成的归纳文件名称,但如果我们在插件的configuration标签里面加入:

<configuration><appendAssemblyId>false</appendAssemblyId><finalName>${build.finalName}</finalName><descriptors><descriptor>assembly/package.xml</descriptor></descriptors>
</configuration>

这样ID标签就无效,生成的归纳文件名称由finalName来指定,当我们去掉appendAssemblyId和finalName,那么生成的文件就由id标签来指定,同时descriptors标签下可以添加多个配置文件,因此我们可以在一次构建时打包成多个归纳文件,这个时候就需要使用ID来指定归纳文件的名称。

2.formats

指定归纳文件的格式,支持的格式包含:

  • zip
  • tar
  • tar.gz (or tgz)
  • tar.bz2 (or tbz2)
  • tar.snappy
  • tar.xz (or txz)
  • tar.zst (or tzst)
  • jar
  • dir
  • war

3.includeBaseDirectory

表示生成的归纳文件是否包含根目录,如果包含解压时会生成和文件名相同的根目录

4.fileSet

这里是需要将哪些资源文件打包到归纳文件里面,具体使用如下:

<fileSet><directory>plugins</directory><outputDirectory>\plugins</outputDirectory><includes><include>*.dll</include></includes>
</fileSet>

directory

表示源文件目录

outputDirectory

表示打包到归纳文件后的目录

includes、excludes

过滤作用,includes可以指定需要的文件。excludes可以排除不需要的文件。可以使用正则表达式来进行筛选配置。

5.dependencySets

这个配置可以将所有的jar文件提取出来,常见配置如下:

<dependencySets><dependencySet><useProjectArtifact>true</useProjectArtifact><outputDirectory>lib</outputDirectory><excludes><exclude>${groupId}:${artifactId}</exclude></excludes></dependencySet>
</dependencySets>

这样会在归纳文件中生成一个lib目录,里面包含了项目所依赖的所有jar文件。

useProjectArtifact

是否把本项目添加到依赖文件夹下。

outputDirectory

提取的jar依赖存放的文件夹,当打包成归纳文件时,归纳文件就会生成一个lib的文件夹

excludes

表示要排除的依赖,上面的配置我们是排除了本项目的,这样就不会把本项目的jar文件打入到lib目录下,当然我们也可以不配置excludes,而配置false也能达到同样的效果。如果要排除其他的内库,配置格式: g r o u p I d : {groupId}: groupId:{artifactId}。如下配置:

<dependencySets><dependencySet>....<excludes><exclude>org.apache.commons:commons-lang3</exclude><exclude>org.apache.logging.log4j:log4j-1.2-api</exclude></excludes></dependencySet>....
</dependencySets>

这样就会把commons-lang3和log4j-1.2-api的依赖去掉

三、使用assembly打包jar文件

在assembly的配置中可以选择jar和war格式的文件。因此assembly也可以用来进行jar打包,能实现maven-jar-plugin插件的功能。

如果我们只打包一个内库的jar文件,可以添加如下配置:

<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-assembly-plugin</artifactId><version>3.4.2</version><configuration><descriptorRefs><descriptorRef>jar-with-dependencies</descriptorRef></descriptorRefs></configuration><executions><execution><id>make-assembly</id><phase>package</phase><goals><goal>single</goal></goals></execution></executions>
</plugin>

另外我还可以使用assembly打包一个可执行的jar文件,配置如下:

<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-assembly-plugin</artifactId><version>3.4.2</version><configuration><archive><manifest><mainClass>com.example.testmvnpkgexespringboot.TestMvnPkgExeSpringbootApplication</mainClass></manifest></archive><descriptorRefs><descriptorRef>jar-with-dependencies</descriptorRef></descriptorRefs></configuration><executions><execution><id>make-assembly</id><phase>package</phase><goals><goal>single</goal></goals></execution></executions>
</plugin>

注意这两种配置方式都会将项目依赖的所有依赖都会打包到这个jar文件中,我们可以解压打包的jar文件,内容如下:

在这里插入图片描述

同样,如果我要打包可执行的jar文件时,manifest的配置和maven-jar-plugin的配置一样,大家可以参照我的上一篇文章【maven插件maven-jar-plugin构建jar文件详细使用

总结

使用assembly来打包可执行的jar文件,目前貌似只能用于普通的Java项目,如果要打包springboot项目还有一些问题,如果要定制化springboot项目的jar文件,还是需要借助maven-jar-plugin插件,有兴趣的同学可参照我的另外一篇文章:【使用maven对springboot项目进行瘦身分离jar的多种处理方案

这篇关于maven插件maven-assembly-plugin打包归纳文件zip/tar使用详解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/727524

相关文章

一文详解SpringBoot中控制器的动态注册与卸载

《一文详解SpringBoot中控制器的动态注册与卸载》在项目开发中,通过动态注册和卸载控制器功能,可以根据业务场景和项目需要实现功能的动态增加、删除,提高系统的灵活性和可扩展性,下面我们就来看看Sp... 目录项目结构1. 创建 Spring Boot 启动类2. 创建一个测试控制器3. 创建动态控制器注

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

Python使用vllm处理多模态数据的预处理技巧

《Python使用vllm处理多模态数据的预处理技巧》本文深入探讨了在Python环境下使用vLLM处理多模态数据的预处理技巧,我们将从基础概念出发,详细讲解文本、图像、音频等多模态数据的预处理方法,... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

C#读写文本文件的多种方式详解

《C#读写文本文件的多种方式详解》这篇文章主要为大家详细介绍了C#中各种常用的文件读写方式,包括文本文件,二进制文件、CSV文件、JSON文件等,有需要的小伙伴可以参考一下... 目录一、文本文件读写1. 使用 File 类的静态方法2. 使用 StreamReader 和 StreamWriter二、二进

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Conda与Python venv虚拟环境的区别与使用方法详解

《Conda与Pythonvenv虚拟环境的区别与使用方法详解》随着Python社区的成长,虚拟环境的概念和技术也在不断发展,:本文主要介绍Conda与Pythonvenv虚拟环境的区别与使用... 目录前言一、Conda 与 python venv 的核心区别1. Conda 的特点2. Python v

Spring Boot中WebSocket常用使用方法详解

《SpringBoot中WebSocket常用使用方法详解》本文从WebSocket的基础概念出发,详细介绍了SpringBoot集成WebSocket的步骤,并重点讲解了常用的使用方法,包括简单消... 目录一、WebSocket基础概念1.1 什么是WebSocket1.2 WebSocket与HTTP

C#中Guid类使用小结

《C#中Guid类使用小结》本文主要介绍了C#中Guid类用于生成和操作128位的唯一标识符,用于数据库主键及分布式系统,支持通过NewGuid、Parse等方法生成,感兴趣的可以了解一下... 目录前言一、什么是 Guid二、生成 Guid1. 使用 Guid.NewGuid() 方法2. 从字符串创建

Python使用python-can实现合并BLF文件

《Python使用python-can实现合并BLF文件》python-can库是Python生态中专注于CAN总线通信与数据处理的强大工具,本文将使用python-can为BLF文件合并提供高效灵活... 目录一、python-can 库:CAN 数据处理的利器二、BLF 文件合并核心代码解析1. 基础合

java中反射Reflection的4个作用详解

《java中反射Reflection的4个作用详解》反射Reflection是Java等编程语言中的一个重要特性,它允许程序在运行时进行自我检查和对内部成员(如字段、方法、类等)的操作,本文将详细介绍... 目录作用1、在运行时判断任意一个对象所属的类作用2、在运行时构造任意一个类的对象作用3、在运行时判断