3.5.1_2 Maven - pom.xml 添加maven-assembly-plugin(官方标准打包插件)

相关链接


一.官方文档

http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html


二.说明

  • 作用

    • 英文原文:The Assembly Plugin for Maven is primarily intended to allow users to aggregate the project output along with its dependencies, modules, site documentation, and other files into a single distributable archive.
    • 中文翻译:Assembly 插件的主要作用是,允许用户将项目输出与它的依赖项、模块、站点文档、和其他文件一起组装成一个可分发的归档文件。
  • 在Maven中,主要有3个插件可以用来打包:

    • maven-jar-plugin,默认的打包插件,用来打普通的project JAR包;
    • maven-shade-plugin,用来打可执行JAR包,也就是所谓的fat JAR包;
    • maven-assembly-plugin,支持自定义的打包结构,也可以定制依赖项等。
      我们日常使用的以maven-assembly-plugin为最多,因为大数据项目中往往有很多shell脚本、SQL脚本、.properties及.xml配置项等,采用assembly插件可以让输出的结构清晰而标准化。

要使用该插件,就在POM中加入以下内容。


三.pom文件配置示例

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    <build>
        <resources>
            <!--指定src/main/resources资源要过滤-->
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
        <plugins>
            <!-- 可执行jar插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <configuration>
                	<!-- 配置描述符文件 --><!-- 也可以使用Maven预配置的描述符 -->
                    <descriptor>src/main/assembly/assembly.xml</descriptor>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                    <archive>
                        <manifest>
                            <!--指定主程序入口-->
                            <mainClass>com.oracle.JDBCMain</mainClass>
                        </manifest>
                    </archive>
                </configuration>
                <executions>
                    <!--执行器 mvn assembly:assembly-->
                    <execution>
                        <id>make-assembly</id>
                        <!--绑定到package生命周期阶段上-->
                        <phase>package</phase>
                        <goals>
                            <!--该打包任务只运行一次-->
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>6</source>
                    <target>6</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

四.assembly.xml(配置描述符文件示例)

  • assembly插件的打包方式是通过descriptor(描述符)来定义的。
  • Maven预先定义好的描述符有bin,src,project,jar-with-dependencies等。比较常用的是jar-with-dependencies,它是将所有外部依赖JAR都加入生成的JAR包中,比较傻瓜化。
  • 但要真正达到自定义打包的效果,就需要自己写描述符文件,格式为XML。下面是我们的项目中常用的一种配置。
<?xml version="1.0" encoding="utf-8"?>
<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 标识符,添加到生成文件名称的后缀符。如果指定 id 的话(这里指定的是项目的版本),目标文件则是 ${artifactId}-${id}.jar。【如terminal-dispatch-5.0.0.0.jar】 --> 
    <id>assembly</id>
    <!-- 指定打包格式。maven-assembly-plugin插件支持的打包格式有zip、tar、tar.gz (or tgz)、tar.bz2 (or tbz2)、jar、dir、war,可以同时指定多个打包格式 -->
    <formats>
        <format>tar.gz</format>
    </formats>
	<!-- 指定打的包是否包含打包层目录(比如finalName是terminal-dispatch,当值为true,所有文件被放在包内的terminal-dispatch目录下,否则直接放在包的根目录下)-->
    <includeBaseDirectory>true</includeBaseDirectory>
	<!-- 指定将工程依赖的包打到包里的指定目录下 -->
    <dependencySets>
        <dependencySet>
            <unpack>false</unpack> <!--布尔值,false表示将依赖以原来的JAR形式打包,true则表示将依赖解成*.class文件的目录结构打包。-->
            <scope>runtime</scope> <!-- 用于管理依赖的部署,runtime表示只在运行时使用 -->
            <outputDirectory>lib</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact> <!-- 指定打包时是否包含工程自身生成的jar包 -->
            <outputDirectory>lib</outputDirectory> <!-- 指定将这些依赖包打到包里lib目录下 -->
        </dependencySet>
    </dependencySets>
    <fileSets>
        <fileSet>
            <directory>src/main/script/linux/bin</directory> <!-- 指定归档文件(要打的jar包)要包含的目录(下的文件及文件夹) -->
            <outputDirectory>bin</outputDirectory> <!-- 指定要将当前目录(<directory>标签中的目录放在归档文件(要打的jar包)bin目录下) -->
            <includes>
                <include>terminal-dispatch</include> <!-- 精确控制要包含的文件,<exclude>用于精确控制要排除的文件  -->
                <include>server</include>
            </includes>
            <fileMode>0755</fileMode> <!-- 设置文件 UNIX 属性,是一种读写权限 -->
        </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>
</assembly>

4.1 < id>与 < format> 配置

  • <id>: 添加到打包文件名的标识符,用来做后缀。
  • <format> : assembly插件支持的打包文件格式,有zip、tar、tar.gz、tar.bz2、jar、war。可以同时定义多个format。
    <!-- id 标识符,添加到生成文件名称的后缀符。如果指定 id 的话(这里指定的是项目的版本),目标文件则是 ${artifactId}-${id}.jar。【如terminal-dispatch-5.0.0.0.jar】 --> 
    <id>assembly</id>
    <!-- 指定打包格式。maven-assembly-plugin插件支持的打包格式有zip、tar、tar.gz (or tgz)、tar.bz2 (or tbz2)、jar、dir、war,可以同时指定多个打包格式 -->
    <formats>
        <format>tar.gz</format>
    </formats>

如果按上面的配置,生成的文件就是=> artifactId−artifactId−{version}-assembly.tar.gz

4.2 < includeBaseDirectory> 配置

  • 作用: 指定打的包是否包含打包层目录,比如finalName是terminal-dispatch,当值为true,所有文件被放在包内的terminal-dispatch目录下,否则直接放在包的根目录下
	<!-- 指定打的包是否包含打包层目录(比如finalName是terminal-dispatch,当值为true,所有文件被放在包内的terminal-dispatch目录下,否则直接放在包的根目录下)-->
    <includeBaseDirectory>true</includeBaseDirectory>

4.3 < dependencySets> 和 < dependencySet> 配置

  • 作用 : 用来设置工程依赖文件在打包时的属性。也与fileSets大致相同,不过还有两个特殊的配置:
    • <unpack>:布尔值,false表示将依赖以原来的JAR形式打包,true则表示将依赖解成*.class文件的目录结构打包。
    • <scope>:表示符合依赖的作用域,一般是写runtime。
    • <outputDirectory>:生成目录的路径。
    • <useProjectArtifact> : 指定打包时是否包含工程自身生成的jar包。

关于scope作用域

序号取值意义
1compile缺省值,适用于所有阶段,会随着项目一起发布
2provided类似compile,期望JDK、容器或使用者会提供这个依赖。如servlet.jar
3runtime只在运行时使用,如JDBC驱动,适用运行和测试阶段
4test只在测试时使用,用于编译和运行测试代码。不会随项目发布
5system类似provided,需要显式提供包含依赖的jar,Maven不会在Repository中查找它
	<!-- 指定将工程依赖的包打到包里的指定目录下 -->
    <dependencySets>
        <dependencySet>
            <unpack>false</unpack> <!--布尔值,false表示将依赖以原来的JAR形式打包,true则表示将依赖解成*.class文件的目录结构打包。-->
            <scope>runtime</scope> <!-- 用于管理依赖的部署,runtime表示只在运行时使用 -->
            <outputDirectory>lib</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact> <!-- 指定打包时是否包含工程自身生成的jar包 -->
            <outputDirectory>lib</outputDirectory> <!-- 指定将这些依赖包打到包里lib目录下 -->
        </dependencySet>
    </dependencySets>

4.4 < fileStes> 和 < fileSet> 配置

  • 作用 : 用来设置一组文件在打包时的属性
    • <directory>:源目录的路径。
    • <includes>/<excludes>:设定包含或排除哪些文件,支持通配符。
    • <outputDirectory>:生成目录的路径。
    • <fileMode>:指定该目录下的文件属性,采用Unix八进制描述法,默认值是0644。关于LINUX中的权限 - 点击跳转
      在这里插入图片描述

4.5 < files> 和 < file> 配置

  • 作用 : 用来设置单个文件在打包时的属性
    • 与<fileSets>类似,不过是指定单个文件,并且还可以通过<destName>属性来设置与源文件不同的名称。
    • <source> : 源文件的路径
    • <outputDirectory> : 生成目录的路径。 .表示当前目录
    <files>
        <file>
            <source>target/${project.artifactId}-${project.version}.jar</source>
            <outputDirectory>.</outputDirectory>
        </file>
    </files>     

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


五.基本用法

点击Terminal进入仿真界面,输入

  mvn clean package

演示打包文件非上述(三、四)示例中配置的内容
在这里插入图片描述
在这里插入图片描述
在工作目录下的target目录下(我这里D:\develop\IDEA\workspace\20200528_DatabasesConnectivityTest\target)
生成了最终执行文件
20200528_DatabasesConnectivityTest-1.0-SNAPSHOT-jar-with-dependencies.jar


参考文章

1.Maven assembly实现自定义打包 ---- chenlly99
2.使用maven-assembly-plugin打包,assembly的语法介绍(同时打多个包、排除依赖包、文件更改别名、自定义路径) ---- toocarrie
3.Maven3种打包方式之一maven-assembly-plugin的使用 ---- Hellooorld
4.maven-assembly-plugin插件的使用方法 ---- weixin_33743880
5.IDEA中MAVEN项目打JAR包的简单方法 ---- spring-boot-maven-plugin 阿丙
6.Linux 中的权限 – 0755 和 0644 ---- dijkstar


20/06/05

M

  • 1
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
pom.xml,有三个常用的插件可以用来打包项目。第一个是maven-jar-plugin,它是默认的打包插件,用来打普通的project JAR包。第二个是maven-shade-plugin,它用来打可执行JAR包,也就是所谓的fat JAR包。第三个是maven-assembly-plugin,它支持自定义的打包结构,可以定制依赖项等。在日常使用maven-assembly-plugin是最常用的,特别是在大数据项目,因为它可以让输出的结构清晰而标准化。\[1\] 如果你想要指定可执行JAR包的主方法入口,可以在pom.xml使用maven-shade-plugin,并配置一个ManifestResourceTransformer来指定主类。例如:<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><mainClass>com.yang.MainTest</mainClass></transformer>。\[2\] 这里还有一些关于使用maven-assembly-plugin打包的参考资料,可以帮助你更好地理解和使用这个插件。\[3\] #### 引用[.reference_title] - *1* *3* [3.5.1_2 Maven - pom.xml 添加maven-assembly-plugin(官方标准打包插件)](https://blog.csdn.net/qq_43529621/article/details/106550551)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control,239^v3^insert_chatgpt"}} ] [.reference_item] - *2* [十五、使用maven-shade-plugin插件将项目打成可执行的jar包](https://blog.csdn.net/m0_54849806/article/details/126565315)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值