初学maven(5)-使用assembly plugin实现自定义打包

初学maven(5)-使用assembly plugin实现自定义打包

http://skydream.javaeye.com/blog/437937

 

关键字: maven assembly

在上一篇文章中,讨论到在对maven的机制不熟悉的情况下,为了实现自己需要的打包格式而使用maven ant task以maven + ant的方式来实现非标准打包,而现在要介绍的是maven中针对打包任务而提供的标准插件:assembly plugin。

    依然以上文(初学maven(4)-使用maven ant task实现非标准打包)的项目为例,要打包的程序如下:

    demo1
    |____lib
    |_____demo1.jar
    |_____*****.jar
    |_____*****.jar
    |____config
    |_____*****.properties
    |_____*****.xml
    |____log
    |_____*****.log
    |____run.bat
    |____run.sh

    类似的建立java项目,文件结构如下:

    demo1
    |____src/main/java
    |____src/main/config
    |____src/main/bin
    |____src/main/resources
    |____src/main/assemble
    |____src/test/java
    |____src/test/resources
    |____target
    |____pom.xml

    除开增加了src/main/assemble目录和没有ant的build文件外,其他内容完全一样:其中src/main/java下放java代码;src/main/resources下放一个*.properties文件,这个资源文件是打包到 jar中,内容打包之后不需要改变的。src/main/config下放一个标准的log4j.xml,这个是有在安装运行前临时修改的需要的。src /main/bin下放置可执行文件。

    assembly plugin的使用方式比较简单,主要有:

1. 修改pom.xml

    pom.xml中设置如下:

< build >
        
< plugins >
            
< plugin >
                
< artifactId > maven-assembly-plugin artifactId >
                
< configuration >
                    

                    
< appendAssemblyId > false appendAssemblyId >
                    
< descriptors >
                        
< descriptor > src/main/assemble/package.xml descriptor >
                    
descriptors >
                
configuration >
                
< executions >
                    
< execution >
                        
< id > make-assembly id >
                        
< phase > package phase >
                        
< goals >
                           
< goal > single goal >
                        
goals >
                    
execution >
                
executions >
            
plugin >
        
plugins >
    
build >


    其中maven-assembly-plugin的maven-assembly-plugin是这个插件的标准命名,在maven2.0.*中带的默认版本是

    appendAssemblyId属性控制是否在生成的打包文件的文件名中包含assembly id。
   
    descriptor属性指定maven-assembly-plugin的配置文件,当然我设置的是src/main/assemble/package.xml.容许使用多个,功能强大当然用法也复杂,对于简单情况一个足矣。

    execution的设置是为了将maven-assembly-plugin继承到标准的maven打包过程中,这样在运行maven-package时就会执行maven-assembly-plugin的操作,从而实现我们需要的自定义打包。
2. assemble descriptor file

    我的src/main/assemble/package.xml内容如下:

< assembly  xmlns ="http://maven.apache.org/POM/4.0.0"  xmlns:xsi ="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation
="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/assembly-1.0.0.xsd" >
    
< id > package id >
    
< formats >
        
< format > zip format >
    
formats >
    
< includeBaseDirectory > true includeBaseDirectory >
    
< fileSets >
        
< fileSet >
            
< directory > src/main/bin directory >
            
< outputDirectory > / outputDirectory >
        
fileSet >
        
< fileSet >
            
< directory > src/main/config directory >
            
< outputDirectory > config outputDirectory >
        
fileSet >
    
fileSets >
    
< dependencySets >
        
< dependencySet >
            
< outputDirectory > lib outputDirectory >
            
< scope > runtime scope >
        
dependencySet >
    
dependencySets >
assembly >


   
    详细的语法不介绍了,请参考官方指南,有非常详尽的说明:Assembly Descriptor Format reference

    简单解释一下:

    1) format
    format=zip设置打包的最终文件格式为zip.
    支持的其他格式还有gz,tar,tar.gz,tar.bz2。

    2)  fileset

     < fileSet >
            
< directory > src/main/bin directory >
            
< outputDirectory > / outputDirectory >
    
fileSet >  

 
    将src/main/bin目录下的文件打包到根目录(/)下.

< fileSet >
            
< directory > src/main/config directory >
            
< outputDirectory > config outputDirectory >
fileSet >


    将src/main/config目录下的文件打包到config下.

    3) dependencySets

     < dependencySet >
            
< outputDirectory > lib outputDirectory >
            
< scope > runtime scope >
   
dependencySet >


    将scope为runtime的依赖包打包到lib目录下。


    总结一下,pom.xml中引入maven-assembly-plugin,然后assemble descriptor file按需设置,最后在eclipse中执行Run As -> Maven package,在target目录下就会出现***.zip文件,里面的格式和要求的完全一致。

    够简单明了吧?感觉比使用maven ant task要轻快不少,看来maven还是很强大的,继续学习......

你可能感兴趣的:(assembly,maven,descriptor,plugins,ant,build)