技术开发 频道

Maven实战指南:“打包”的技巧

  【IT168 技术】“打包“这个词听起来比较土,比较正式的说法应该是”构建项目软件包“,具体说就是将项目中的各种文件,比如源代码、编译生成的字节码、配置文件、文档,按照规范的格式生成归档,最常见的当然就是JAR包和WAR包了,复杂点的例子是Maven官方下载页面的分发包,它有自定义的格式,方便用户直接解压后就在命令行使用。作为一款”打包工具“,Maven自然有义务帮助用户创建各种各样的包,规范的JAR包和WAR包自然不再话下,略微复杂的自定义打包格式也必须支持,本文就介绍一些常用的打包案例以及相关的实现方式,除了前面提到的一些包以外,你还能看到如何生成源码包、Javadoc包、以及从命令行可直接运行的CLI包。

  Packaging的含义

  任何一个Maven项目都需要定义POM元素packaging(如果不写则默认值为jar)。顾名思义,该元素决定了项目的打包方式。实际的情形中,如果你不声明该元素,Maven会帮你生成一个JAR包;如果你定义该元素的值为war,那你会得到一个WAR包;如果定义其值为POM(比如是一个父模块),那什么包都不会生成。除此之外,Maven默认还支持一些其他的流行打包格式,例如ejb3和ear。你不需要了解具体的打包细节,你所需要做的就是告诉Maven,”我是个什么类型的项目“,这就是约定优于配置的力量。

  为了更好的理解Maven的默认打包方式,我们不妨来看看简单的声明背后发生了什么,对一个jar项目执行mvn package操作,会看到如下的输出:

  [INFO] --- maven-jar-plugin:2.3.1:jar (default-jar) @ git-demo ---
  [INFO] Building jar:
/home/juven/git_juven/git-demo/target/git-demo-1.2-SNAPSHOT.jar

  相比之下,对一个war项目执行mvn package操作,输出是这样的:

  [INFO] --- maven-war-plugin:2.1:war (default-war) @ webapp-demo ---
  [INFO] Packaging webapp
  [INFO] Assembling webapp [webapp
-demo] in [/home/juven/git_juven/webapp-demo/target/webapp-demo-1.0-SNAPSHOT]
  [INFO] Processing war project
  [INFO] Copying webapp resources [
/home/juven/git_juven/webapp-demo/src/main/webapp]
  [INFO] Webapp assembled in [
90 msecs]
  [INFO] Building war:
/home/juven/git_juven/webapp-demo/target/webapp-demo-1.0-SNAPSHOT.war

  对应于同样的package生命周期阶段,Maven为jar项目调用了maven-jar-plugin,为war项目调用了maven-war-plugin,换言之,packaging直接影响Maven的构建生命周期。了解这一点非常重要,特别是当你需要自定义打包行为的时候,你就必须知道去配置哪个插件。一个常见的例子就是在打包war项目的时候排除某些web资源文件,这时就应该配置maven-war-plugin如下:

<plugin>
    
<groupId>org.apache.maven.plugins</groupId>
    
<artifactId>maven-war-plugin</artifactId>
    
<version>2.1.1</version>
    
<configuration>
      
<webResources>
        
<resource>          <directory>src/main/webapp</directory>
          
<excludes>
            
<exclude>**/*.jpg</exclude>
          </excludes>
        </resource>
      </webResources>
    </configuration>
  </plugin>

  源码包和Javadoc包

  本专栏的《坐标规划》一文中曾解释过,一个Maven项目只生成一个主构件,当需要生成其他附属构件的时候,就需要用上classifier。源码包和Javadoc包就是附属构件的较好例子。它们有着广泛的用途,尤其是源码包,当你使用一个第三方依赖的时候,有时候会希望在IDE中直接进入该依赖的源码查看其实现的细节,如果该依赖将源码包发布到了Maven仓库,那么像Eclipse就能通过m2eclipse插件解析下载源码包并关联到你的项目中,十分方便。由于生成源码包是极其常见的需求,因此Maven官方提供了一个插件来帮助用户完成这个任务:

<plugin>
    
<groupId>org.apache.maven.plugins</groupId>
    
<artifactId>maven-source-plugin</artifactId>
    
<version>2.1.2</version>
    
<executions>
      
<execution>
        
<id>attach-sources</id>
        
<phase>verify</phase>
        
<goals>
          
<goal>jar-no-fork</goal>
        
</goals>
      
</execution>
    
</executions>
  
</plugin>
0
相关文章