Maven是服务于项目生命周期的,有些人说它是build工具,但build只是生命周期的一部分,它试图抽象整个项目生命周期,实际上它也做到了。几乎所有的项目都离不开Mave所定义的生命周期阶段(clean compile test package site...)。不止如此,基于这些阶段,Maven通过插件提供了绝大部分的默认实现,它们不用做任何配置或者仅需要很少的配置,就能帮你完成你的工作。

 

先看一个简单的基于Ant的build.xml文件。

 
  1. <SPAN style="FONT-SIZE: 14px"><project name="my-project" default="dist" basedir="."> 
  2.     <description> 
  3.         simple example build file  
  4.     </description> 
  5.   <!-- set global properties for this build --> 
  6.   <property name="src" location="src/main/java"/> 
  7.   <property name="build" location="target/classes"/> 
  8.   <property name="dist"  location="target"/> 
  9.  
  10.   <target name="init"> 
  11.     <!-- Create the time stamp --> 
  12.     <tstamp/> 
  13.     <!-- Create the build directory structure used by compile --> 
  14.     <mkdir dir="${build}"/> 
  15.   </target> 
  16.  
  17.   <target name="compile" depends="init" 
  18.         description="compile the source " > 
  19.     <!-- Compile the java code from ${src} into ${build} --> 
  20.     <javac srcdir="${src}" destdir="${build}"/> 
  21.   </target> 
  22.  
  23.   <target name="dist" depends="compile" 
  24.         description="generate the distribution" > 
  25.     <!-- Create the distribution directory --> 
  26.     <mkdir dir="${dist}/lib"/> 
  27.  
  28.     <!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file --> 
  29.     <jar jarfile="${dist}/lib/MyProject-${DSTAMP}.jar" basedir="${build}"/> 
  30.   </target> 
  31.  
  32.   <target name="clean" 
  33.         description="clean up" > 
  34.     <!-- Delete the ${build} and ${dist} directory trees --> 
  35.     <delete dir="${build}"/> 
  36.     <delete dir="${dist}"/> 
  37.   </target> 
  38. </project> 
  39.  
  40. </SPAN> 

 

这段代码做的事情是清除目录,创建目录,编译源文件,复制依赖至目标目录。这已经十分简单了,但是,为此你还是需要做一些配置:指定源码目录,指定编译字节码目录,指定目标目录,你还需要记住一些ant的配置命令,如delete, mkdir, javac, jar。这看起来没什么问题,至少目前是这样。

 

现在说说Ant或shell/bat存在的问题,首先,有很多配置需要你填写,源码目录,字节码目录……,每一个项目,你都要重复这些劳动;第二,也是更重要的一点,你根本无法保证N个项目的ant配置(或shell)配置使用了相同的风格,后果是,每接受一个项目,开发者都要去学习这份脚本,以了解如何构建项目。如果第一个原因只是为了技术的简化的话,第二个原因更是软件工程的因素,我们不是一个人在开发项目,不是只开发一个项目,所以应该时刻谨记为了别人,为了将来。

 

现在看看使用Maven我们需要什么配置,就一个pom.xml文件:

 
  1. <SPAN style="FONT-SIZE: 14px"><project> 
  2.   <modelVersion>4.0.0</modelVersion> 
  3.   <groupId>org.sonatype.mavenbook</groupId> 
  4.   <artifactId>my-project</artifactId> 
  5.   <version>1.0</version> 
  6. </project></SPAN> 
 

不用惊讶,Maven不会变魔术,它能做到这么简单,是有条件的,条件就是你要遵守Maven约定。pom.xml所在的目录应为项目的根目录,假设该目录为${proj-dir},那么Maven有以下假设:

${proj-dir}/src/main/java —— 存放项目的.java文件。

${proj-dir}/src/main/resources —— 存放项目资源文件,如spring, hibernate配置文件。

${proj-dir}/src/test/jave —— 存放所有测试.java文件,如JUnit测试类。

${proj-dir}/src/test/resources —— 测试资源文件。

${proj-dir}/target —— 项目输出位置。

 

运行一条mvn clean package命令,Maven会帮你清除target目录,重新建一个空的,编译src/main/java类至target/classes,复制src/main/resources的文件至target/classes,编译src/test/java至target/test-classes,复制src/test/resources的文件至target/test-classes;然后运行所有测试;测试通过后,使用jar命令打包,存储于target目录。Maven做的事情一点也不少,只是都对用户隐蔽起来了,它只要求你遵循它的约定。

 

这么做有什么好处呢?第一,显而易见,配置大量减少了,随着项目变得越复杂,这种优势就越明显。第二,我这里要强调的是,对于软件工程来说,所有使用Maven的项目,对外都暴露统一的命令集。如mvn clean install。只要项目被正确配置好了,任何一个新人,输入一行Maven命令,就能将项目构建起来了,这大大减少了交流学习的时间。

 

这时可能会有人说,我不想遵守这种约定呢?我要把源码放在${proj-dir}/src/code目录下。首先,问自己三遍,你真的需要这样做么?如果仅仅是因为喜好,那么别耍个性,个性意味着牺牲通用性,意味着增加无谓的复杂度。以下是一个“个性”的例子:

 
  1. <SPAN style="FONT-SIZE: 14px"><project> 
  2.   <modelVersion>4.0.0</modelVersion> 
  3.   <groupId>org.sonatype.mavenbook</groupId> 
  4.   <artifactId>my-project</artifactId> 
  5.   <version>1.0</version> 
  6.   <build> 
  7.     <sourceDirectory>src/java</sourceDirectory> 
  8.     <testSourceDirectory>src/test</testSourceDirectory> 
  9.     <outputDirectory>output/classes</outputDirectory> 
  10.     <testOutputDirectory>output/test-classes</testOutputDirectory> 
  11.     <directory>target/jar</directory> 
  12.   </build> 
  13. </project></SPAN> 

很显然,Maven允许你自定义,比如这个例子中,Maven就被配置成从src/java目录寻找源码,编译class文件至output/classes,从src/test寻找测试源码,编译至output/test-classes目录,最后,打包jar文件至target/jar目录。Maven允许你这么做,但不推荐你这么做。因为一旦你使用这种自定义,习惯Maven约定的人一开始会觉得奇怪,src/main/java目录去哪里了?target下面怎么没有我要的jar文件?这些都造成了无谓的交流成本提高。只有一些特殊的情况,这些自定义手段能帮你解决实际的问题,比如你在处理遗留代码,你没办法改变源码目录结构,这个时候只有让Maven妥协。

 

下面总结一些Maven的默认值,也就是说,虽然你没做什么配置,但是你应该知道Maven假设它们成立,也就是所谓的约定:

目录src/main/java java源码目录 目录src/main/resources 资源文件目录 目录src/test/java 测试java源码目录 目录src/test/resources 测试资源文件目录 目录target 打包输出目录 目录target/classes 编译输出目录 目录target/test-classes 测试编译输出目录 目录target/site 项目site输出目录 目录src/main/webapp web应用文件目录(当打包为war时),如WEB-INF/web.xml jar 默认打包格式 *Test.java Maven只会自动运行符合该命名规则的测试类 %user_home%/.m2 Maven默认的本地仓库目录位置 中央仓库 Maven默认使用远程中央仓库:http://repo1.maven.org/maven2 1.3 Maven Compiler插件默认以1.3编译,因此需要额外配置支持1.5

 

 

其实基本上所有的约定,或者说默认配置,都可以在Maven的超级POM(super pom)中找到。由于所有的POM都继承了这个超级POM(类似于java中所有类都继承于Object),因此它的默认配置就被继承了。以Maven 2.0.9为例,你可以在%m2_home%/lib/下看到一个名为maven-2.0.9-uber.jar的文件,打开这个文件,可以找到org/apache/maven/project/pom-4.0.0.xml这个文件,这就是超级POM。

Maven提供了一套科学的默认配置,它要求你遵循这些配置约定,然后它就会帮你处理日常的事务compile, test, package等等。使用Maven的时候,你应该尽可能遵循它的配置约定,一方面可以简化配置,另一方面可建立起一种标准,减少交流学习成本。一旦你习惯了这种约定,你得到的回报是巨大的。反之,恣意的做自定义,想要Maven像Ant一样听你的话,那么你会讨厌Maven,Maven也会讨厌你。

 

原帖地址: