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

更新时间：2024年02月20日 09:16:46 作者：老码龙

java项目运行的文件需要jar或者war格式,同时还需要使用Java命令,本文主要介绍了maven插件maven-assembly-plugin打包归纳文件zip/tar使用,具有一定的参考价值,感兴趣的可以了解一下

前言

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>

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使用的文章就介绍到这了,更多相关maven-assembly-plugin打包内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

详解Java如何利用数字描述更多的信息
在数据库里面 ,通常我们会用数字的递进来描述状态等信息 , 但是如果想进行更复杂的操作 , 就有必要对二进制有一定理解了。本文就来趣味性的探讨一下 , 如何通过更少的空间描述更多的信息
2022-09-09
Java关于JDK1.8中的Optional类
本文主要介绍了Optional类的一些常用方法，以及其应用场景，其主要是为了规避空指针异常（NPE）。熟练的运用Optional类可以很大的简化我们的代码，使代码简洁明了。,需要的朋友可以参考下面文章内容
2021-09-09
Java NIO三大组件与ByteBuffer深入理解及使用
这篇文章主要介绍了Java NIO三大组件与ByteBuffer，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧
2023-01-01
一起来了解Java的File类和IO流
这篇文章主要为大家详细介绍了Java File类和IO流，在Java学习中，file类与io流是非常重要的部分，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助
2022-03-03
网易Java程序员两轮面试请问你能答对几个?
为大家分享网易Java程序员两轮面试题，考考大家，这些问题你能答对几个？
2017-11-11
Spring Cloud-Feign服务调用的问题及处理方法
Feign 是一个声明式的 REST 客户端，它用了基于接口的注解方式，很方便实现客户端配置。接下来通过本文给大家介绍Spring Cloud-Feign服务调用,需要的朋友可以参考下
2021-10-10
SpringBoot使用WebSocket的方法实例详解
WebSocket 是 HTML5 开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。这篇文章主要介绍了SpringBoot使用WebSocket,需要的朋友可以参考下
2019-06-06
SpringBoot拦截器实现登录拦截的示例代码
本文主要介绍了SpringBoot拦截器实现登录拦截，文中根据实例编码详细介绍的十分详尽，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-03-03
Spring AOP中三种增强方式的示例详解
AOP （Aspect Orient Programming）,直译过来就是面向切面编程。AOP 是一种编程思想，是面向对象编程（OOP）的一种补充。本文为大家介绍了Spring AOP中三种增强方式，感兴趣的可以了解一下
2022-07-07
Redis如何实现分布式锁详解
分布式锁一般有三种实现方式：1. 数据库乐观锁；2. 基于Redis的分布式锁；3. 基于ZooKeeper的分布式锁.本篇文章将介绍第二种方式,基于Redis实现分布式锁,文中有非常详细的介绍,需要的朋友可以参考下
2021-06-06