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

相关链接

• Excel目录

---

一.官方文档

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-8project.build.sourceEncoding>
    properties>
    <build>
        <resources>
            
            <resource>
                <directory>src/main/resourcesdirectory>
                <filtering>truefiltering>
            resource>
        resources>
        <plugins>
            
            <plugin>
                <groupId>org.apache.maven.pluginsgroupId>
                <artifactId>maven-assembly-pluginartifactId>
                <configuration>
                	
                    <descriptor>src/main/assembly/assembly.xmldescriptor>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependenciesdescriptorRef>
                    descriptorRefs>
                    <archive>
                        <manifest>
                            
                            <mainClass>com.oracle.JDBCMainmainClass>
                        manifest>
                    archive>
                configuration>
                <executions>
                    
                    <execution>
                        <id>make-assemblyid>
                        
                        <phase>packagephase>
                        <goals>
                            
                            <goal>singlegoal>
                        goals>
                    execution>
                executions>
            plugin>
            <plugin>
                <groupId>org.apache.maven.pluginsgroupId>
                <artifactId>maven-compiler-pluginartifactId>
                <configuration>
                    <source>6source>
                    <target>6target>
                configuration>
            plugin>
        plugins>
    build>

---

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

• assembly插件的打包方式是通过descriptor（描述符）来定义的。
• Maven预先定义好的描述符有bin，src，project，jar-with-dependencies等。比较常用的是jar-with-dependencies，它是将所有外部依赖JAR都加入生成的JAR包中，比较傻瓜化。
• 但要真正达到自定义打包的效果，就需要自己写描述符文件，格式为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>assemblyid>
    
    <formats>
        <format>tar.gzformat>
    formats>
	
    <includeBaseDirectory>trueincludeBaseDirectory>
	
    <dependencySets>
        <dependencySet>
            <unpack>falseunpack> 
            <scope>runtimescope> 
            <outputDirectory>liboutputDirectory>
            <useProjectArtifact>trueuseProjectArtifact> 
            <outputDirectory>liboutputDirectory> 
        dependencySet>
    dependencySets>
    <fileSets>
        <fileSet>
            <directory>src/main/script/linux/bindirectory> 
            <outputDirectory>binoutputDirectory> 
            <includes>
                <include>terminal-dispatchinclude> 
                <include>serverinclude>
            includes>
            <fileMode>0755fileMode> 
        fileSet>
        <fileSet>
            <directory>src/main/confdirectory>
            <outputDirectory>confoutputDirectory>
        fileSet>
        <fileSet>
            <directory>src/main/sqldirectory>
            <includes>
                <include>*.sqlinclude>
            includes>
            <outputDirectory>sqloutputDirectory>
        fileSet>
        <fileSet>
            <directory>target/classes/directory>
            <includes>
                <include>*.propertiesinclude>
                <include>*.xmlinclude>
                <include>*.txtinclude>
            includes>
            <outputDirectory>confoutputDirectory>
        fileSet>
    fileSets>
    <files>
        <file>
            <source>target/${project.artifactId}-${project.version}.jarsource>
            <outputDirectory>.outputDirectory>
        file>
    files>
assembly>

4.1 < id>与 < format> 配置

• : 添加到打包文件名的标识符，用来做后缀。
• : assembly插件支持的打包文件格式，有zip、tar、tar.gz、tar.bz2、jar、war。可以同时定义多个format。

     
    <id>assemblyid>
    
    <formats>
        <format>tar.gzformat>
    formats>

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

4.2 < includeBaseDirectory> 配置

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

	
    <includeBaseDirectory>trueincludeBaseDirectory>

4.3 < dependencySets> 和 < dependencySet> 配置

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

关于scope作用域

序号	取值	意义
1	compile	缺省值,适用于所有阶段,会随着项目一起发布
2	provided	类似compile，期望JDK、容器或使用者会提供这个依赖。如servlet.jar
3	runtime	只在运行时使用，如JDBC驱动，适用运行和测试阶段
4	test	只在测试时使用，用于编译和运行测试代码。不会随项目发布
5	system	类似provided，需要显式提供包含依赖的jar，Maven不会在Repository中查找它

	
    <dependencySets>
        <dependencySet>
            <unpack>falseunpack> 
            <scope>runtimescope> 
            <outputDirectory>liboutputDirectory>
            <useProjectArtifact>trueuseProjectArtifact> 
            <outputDirectory>liboutputDirectory> 
        dependencySet>
    dependencySets>

4.4 < fileStes> 和 < fileSet> 配置

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

4.5 < files> 和 < file> 配置

• 作用 : 用来设置单个文件在打包时的属性
  • 与<fileSets>类似，不过是指定单个文件，并且还可以通过<destName>属性来设置与源文件不同的名称。
  • : 源文件的路径
  • : 生成目录的路径。 .表示当前目录

    <files>
        <file>
            <source>target/${project.artifactId}-${project.version}.jarsource>
            <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