原作者:Rob Herbst
当您的项目逐渐变得庞大和复杂时,最好使用一种构建工具来自动构建您的项目。例如,一个典型的java项目,每次构建时都要经历编译java源代码,把class文件打成.jar包,生成javadocs文档等步骤。这些步骤都可以用构建工具帮您自动完成。说到构建工具,大家肯定都知道make,但make是依赖具体操作系统的。Java-centric选择了Ant,一种可以跨平台的使用xml来替换Makefile糟糕语法的构建工具。
来自Apache软件组织的构建工具Maven更可能成为您的选择,Maven不仅提供了out-of-the-box的解决方案来统一处理构建相关的任务,还提供了信息统计的功能。使您的开发团队可以更好地跟踪项目的进展情况。
Maven的原理
作为构建工具,Maven和Ant一样,利用构建配置文件进行编译,打包,测试等操作。您可以用Maven自带的功能进行任何的操作,但前提是做好了相应的配置。当然,修改已有的模板来开始新的项目是个好方法。除非您在写特有的task,不然都会有target重用的问题。
Maven进行了一些改进。您将项目配置内容写成XML文件,并且可以使用很多Maven自带的功能。另外还可以在Maven项目中调用任何Ant的task。
Maven自带的"goals"有以下功能:
编译源代码
产生Javadoc文档
运行unit测试
源代码文法分析
产生违反团队编码规范的详细报告
产生CVS最新提交报告
产生CVS更改最频繁的文件报告和提交最频繁的开发人员报告
产生可以交叉引用的HTML格式的源代码,等等。
Maven的功能是通过众多的插件来实现的。在Maven的网站上可以找到一个Maven插件列表。例如,创建EAR包和控制J2EE应用服务器的插件。
Maven的另外一个特色是利用中央构建资源库去访问您项目中需要的.jars(像Perl's CPAN)。您只用列出需要的.jars及相应版本,Maven会自动下载。当第一次运行Maven,或者运行一个新的goal时,可以在控制台上看到中央构建资源库下载.jars的详细过程。这一功能不仅使Maven更加容易使用,而且能帮您省下不少搜集维护本地或远程构建资源库中.jars版本的时间和精力。
Maven的易用性来源于配置过程的自然性。Out of the box,不仅提供了项目构建的基本步骤,还可以自定义项目对象模型(POM)。POM基于易于编辑的XML格式,由不同元素的名称和属性组成。一旦您完成POM的配置,就可以在构造过程中使用很多Maven自带的激动人心的功能。
Maven也易于自定义,特别是当您已经熟悉Ant后。您可以增加新的功能或钩子到已有的构造过程以添加自定义的步骤。通过修改maven.xml文件可以添加自定义的功能。
Maven概述
Maven最基本的运行单位是goal。例如,当您在控制台运行如下命令:
Maven会去访问并执行generate goal of site插件。如果想要查看配置文件中所有的goals,输入:
对于任何一个团队,运行maven site:generate的goal生成的站点可以给团队成员展示项目当前的状态。第一页是单元测试的报告,提供单元测试的技术统计结果。
Checkstyle插件对于在团队中坚持编码规范很有帮组。产生的报告中列出了在多少个文件里面出现了多少个违反编码规范的统计信息,并列出了相应文件和行号。通过点击相应链接,可以轻易的找到代码中违反编码规范的地方。
事实上,Maven的开发者也在自己的项目中使用Maven来管理,所以你可以看到在开发Maven过程中产生的Checkstyle报告,如图一
图一. Checkstyle报告摘要
在摘要之后就是按照文件为单位组织的违反编码规范的报告,如图二。
图二. Checkstyle详细报告
CVS插件可以产生关于代码提交的统计报告,包括以下内容:
更改日志报告:列出最新提交的文件及提交日期,作者和注释。
文件活跃度报告:提供更改最频繁文件的详细内容
开发人员活跃度报告:提供最新提交文件的统计报告及每个开发人员提交的文件数。
以上报告文档同样使用在Maven开发项目中,最新的一次更改日志报告如图三。
图三. 更改日志报告
试一试 如果您已经准备好要使用Maven,下面是安装的步骤.
到Apache下载Maven的最新版本.
解压到系统的某个目录,比如C:\maven或者~/maven.
设置MAVEN_HOME环境变量指向解压到的目录.
确认您已经配置好JAVA_HOME环境变量.
在系统path环境变量中添加MAVEN_HOME/bin.
现在,在控制台输入
您可以看到下面的输出:
__ __
| \/ |__ _Apache__ ___
| |\/| / _` \ V / -_) ' \ ~ intelligent projects ~
|_| |_\__,_|\_/\___|_||_| v. 1.0-beta-10
Maven可以工作了!想看所有可用的Maven选项,输入:
所有可用的goals:
您将看到可用的插件列表及其提供的goals:
Available [Plugins] / Goals
```````````````````````````
[ant] : Generate an Ant build file
generate-build ............. Generate an Ant
build file
[antlr] ( NO DEFAULT GOAL )
generate ................... Generate source
from antlr grammars
prepare-filesystem ......... Make any necessary
directories for antlr
processing
再往下,可以看到[wizard]插件和其goal ui。想运行那个goal就输入:
您可以在控制台上看到Maven自动到中央构建资源库或网上下载需要的.jar包.
我们在进一步,创建一个简单的项目。例如,创建一个名为maven-sample的目录(~/maven-sample或者C:\maven-sample)。运行如下命令:
maven -D package=com.oreillynet.mavensample genapp |
maven会自动创建一个标准的项目文件。上面的package属性是必须的,如果输入错误或不输会编译错误。
现在,运行命令:
Maven会依据配置好的POM文件(project.xml)为您项目生成相应的站点。如果是第一次运行,还可以看到Maven会到中央构建资源库或网上下载必须的.jars包。
运行这个goal,Maven会为您编译源代码,拷贝conf目录里的资源文件到类文件classes的目录,生成Javadoc文档以及项目分析报告。可以看到,一个目标含有很多的功能!
进入target目录,您可以看到site:generate goal生成的文件。target目录下的docs目录存放着Maven为您的项目产生的报告文档。
Maven中使用Ant任务 要整合Ant任务到Maven中,您需要创建名为maven.xml的文件并存放到project.xml文件的目录。在maven.xml文件中写入:
<project default="myGoal"> <goal name="myGoal"> <echo>Hello Maven!</echo> </goal> </project> |
其中
是Ant中用于输出的task。同样,在自定义的goals中也可以运行任何Ant task。
保存maven.xml文件,在project.xml和maven.xml所在的目录中运行
您可以看到以下输出:
myGoal:
[echo] Hello Maven!
BUILD SUCCESSFUL
Total time: 1 seconds
自定义Maven 到目前为止,您已经看到一个简单的项目是怎样运行的,您还可以按需要自定义Maven。在您最喜欢文本编辑器中打开project.xml文件,可以看到带有注释的项目文件。您可以把这作为扩展的基础,根据项目的需要添加需要的代码和资源。
如果要使用Checkstyle插件,需要在project.properties文件中指定使用的编码规范。默认使用的是标准的Sun和Turbine的编码规范。您也可以通过设置
maven.checkstyle.properties=team-checkstyle.xml |
来使用团队自己的编码规范。
Checksytle插件会使用team-checkstyle.xml文件作为编码规范检查的依据。要创建自己的编码规范文件,可以使用Eclipse插件,或者修改标准的编码规范。解压MAVEN_HOME/plugins目录下的maven-checkstyle-plugin.jar文件,在解压目录中的plugin-resources目录中可以找到sun_checks.xml和tuibine_checks.xml两个文件。选择和您团队最接近的编码规范再根据需要修改一下就可以了。
要更改项目产生的站点的默认颜色,可以在project.properites文件中修改。颜色属性要用标准的HTML语法。
maven.ui.section.background=#cfcfbb maven.ui.banner.border.top=#cfcfbb maven.ui.banner.background=#cfcfbb maven.ui.source.background=#cfcfbb |
如果您想定义在ibiblio.org的Maven构建资源库中没有的公司自己的项目相关性,您可以照下面定义
<dependency> <id>SomeJar</id> <jar>someJar1.2.jar</jar> </dependency> |
然后,您需要将somJar1.2.jar文件放到您自己的中央构建资源库目录中。该目录由project.properties文件中的maven.repo.local属性指定。默认为${maven.home.local}/repository或${user.home}/.maven。在project.xml文件中添加下列<reports>元素还可以自定义生成的报告文档
<reports> <report>maven-checkstyle-plugin</report> <report>maven-changelog-plugin</report> <report>maven-developer-activity-plugin</report> <report>maven-file-activity-plugin</report> <report>maven-javadoc-plugin</report> <report>maven-jdepend-plugin</report> <report>maven-junit-report-plugin</report> <report>maven-jxr-plugin</report> <report>maven-statcvs-plugin</report> <report>maven-simian-plugin</report> </reports> |
除了最后两个,其他都是默认配置的。maven-statcvs-plugin产生CVS统计报告,maven-simian-plugin可以识辨程序里重复的代码。一旦您自己定义了一个
元素,将会覆盖掉所有默认文档配置。
总结 本文介绍了Maven的基本功能。用Maven来管理您的项目可以改善团队开发过程并可以让您更好的了解当前项目的情况。
在此感谢Maven的开发者及开发社区的朋友,是他们创造出了这么卓越的构建工具!