maven-assembly-plugin 入门指南

当你使用 Maven 对项目打包时，你需要了解以下 3 个打包 plugin，它们分别是

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

下面我们就简单介绍一下 maven-assembly-plugin。

使用方法

使用 descriptorRefs(官方提供的定制化打包方式)，官方提供的 descriptorRef 有 bin, jar-with-dependencies, src, project。【不建议使用】


  [...]
  
    [...]
    
      
        
        maven-assembly-plugin
        3.0.0
        
          
            jar-with-dependencies
          
        
        [...]

使用 descriptors，指定打包文件 src/assembly/src.xml，在该配置文件内指定打包操作。


  [...]
  
    [...]
    
      
        maven-assembly-plugin
        3.0.0
        
          
            src/assembly/src.xml
          
        
        [...]

描述符文件元素

id

release

id 标识符，添加到生成文件名称的后缀符。如果指定 id 的话，目标文件则是 ${artifactId}-${id}.tar.gz

formats

maven-assembly-plugin 支持的打包格式有zip、tar、tar.gz (or tgz)、tar.bz2 (or tbz2)、jar、dir、war，可以同时指定多个打包格式

  
    tar.gz
    dir

dependencySets

用来定制工程依赖 jar 包的打包方式，核心元素如下表所示。

元素	类型	作用
outputDirectory	String	指定包依赖目录，该目录是相对于根目录
includes/include*	List	包含依赖
excludes/exclude*	List	排除依赖


    
      /lib

fileSets

管理一组文件的存放位置，核心元素如下表所示。

元素	类型	作用
outputDirectory	String	指定文件集合的输出目录，该目录是相对于根目录
includes/include*	List	包含文件
excludes/exclude*	List	排除文件
fileMode	String	指定文件属性，使用八进制表达，分别为(User)(Group)(Other)所属属性，默认为 0644

files

可以指定目的文件名到指定目录，其他和 fileSets 相同，核心元素如下表所示。

元素	类型	作用
source	String	源文件，相对路径或绝对路径
outputDirectory	String	输出目录
destName	String	目标文件名
fileMode	String	设置文件 UNIX 属性

 
    
      README.txt
      /

样例

工程目录结构

scribe-log4j2-test

pom.xml


  scribe-log4j2-test
  
    
      org.apache.maven.plugins
      maven-compiler-plugin
    

    
      org.apache.maven.plugins
      maven-assembly-plugin
      
        
          src/main/assembly/release.xml
        
      

      
        
          make-assembly 
          package 
          
            single

release.xml



  
    tar.gz
    dir
  

  
    
      /lib
    
  

  
    
      
        bin/**
      
      0755
    

    
      
        /conf/**
        logs
      
    

  

  
    
      README.txt
      /

最终创建生成可执行二进制工程

参考

maven 入门指南
maven 生命周期
Maven 默认插件以及功能
maven 依赖管理
maven-shade-plugin 入门指南
maven-assembly-plugin