節選自O‘Reilly出版的<<開(kāi)發(fā)人員的筆記本:Maven>>
作者:帝默西 M.奧波萊恩,文森特.馬索爾。
翻譯：phynalica
如有問(wèn)題，或發(fā)現錯誤及不妥之處，請聯(lián)系筆者：saluteDragon@Gmail.com
使用Eclipse的Maven插件
Eclipse有一個(gè)很不錯的Maven插件。這個(gè)插件支持很多有趣的特性，如編輯project.xml文件的功能、支持對Maven進(jìn)行定制以及一個(gè)Maven庫瀏覽器(Repository Browser)等。
步驟
Mevenide(http://mevenide.codehaus.org/mevenide-ui-eclipse/update/index.html)是一個(gè)Eclipse插件，有了它，你就可以在Eclipse中使用Maven了。你可以按照以下的說(shuō)明到Eclipse的更新網(wǎng)站上去下載這個(gè)插件。
1. 啟動(dòng)Eclipse。
2. 從菜單欄上選擇幫助(Help)?軟件更新(Software Updates)?找到并安裝(Find and Install)。
3. 在“安裝/更新(Install/Update)”對話(huà)框上，選擇“Search for new feature to install”，然后單擊“下一步”。
4. 在“安裝(Intall)”對話(huà)框上，單擊“新建遠程站點(diǎn)(New Remote Site)”。
5. 在“新的更新站點(diǎn)”對話(huà)框上，在“名稱(chēng)”字段中輸入Mevenide，在“URL”字段中，輸入Eclipse更新站點(diǎn)的位置。Mevenide的Eclipse更新站點(diǎn)是：http://mevenide.codehaus.org/release/eclipse/update/site.xml。
6. 當Mevenide這個(gè)單詞出現在“安裝”對話(huà)框中時(shí)，選中兩個(gè)子項：Maven和Mevenide，然后單擊“下一步”。
7. Maven和Mevenide下載完畢并安裝后，重新啟動(dòng)Eclipse。
你首先會(huì )注意到，Mevenide把一個(gè)綠色圖標作為每個(gè)project.xml文件的標記。你可以在項目對象模型編輯器中打開(kāi)project.xml文件，方法是：用鼠標選中任意project.xml文件，單擊右鍵，選擇“打開(kāi)方式(Open With…)”?“項目對象模型編輯器(Project Object Model Editor”。這個(gè)編輯器將顯示如圖1-3中所示的面板。
<junit printsummary="yes" haltonfailure="yes">
<classpath>
<pathelement location="${build.tests}"/>
<pathelement path="${java.class.path}"/>
</classpath>
<formatter type="plain"/>
<test name="my.test.TestCase" haltonfailure="no" outfile="result">
<formatter type="xml"/>
</test>
<batchtest fork="yes" todir="${reports.tests}">
<fileset dir="${src.tests}">
<include name="**/*Test*.java"/>
<exclude name="**/AllTests.java"/>
</fileset>
</batchtest>
</junit>
這個(gè)片斷忽略了不同路徑和變量的定義，如build.tests和java.class.path，還忽略了Ant target的定義。除了某些單元測試target，你還需要定義一個(gè)target來(lái)編譯源代碼和單元測試，定義一個(gè)target來(lái)創(chuàng )建目標目錄。每個(gè)項目都需要定義相同的邏輯來(lái)進(jìn)行單元測試。多數Ant項目使用相似的目錄結構，并通過(guò)把target定義復制到build.xml文件中來(lái)重用編譯邏輯。隨著(zhù)時(shí)間的流逝，項目變得更復雜，可定制性更強，因而目錄標準也要進(jìn)化，每一個(gè)項目都可能不同的方法來(lái)進(jìn)行編譯、測試和打包；隨著(zhù)時(shí)間的流逝，build.xml文件本身也變成了一個(gè)項目。經(jīng)過(guò)定制的Ant build文件越大， 編譯過(guò)程中的平均信息量也會(huì )更大。.與其說(shuō)Ant是一個(gè)編譯工具，倒不如說(shuō)它是提供了build-specific API的一種語(yǔ)言。Ant1.6已經(jīng)有了Ant庫和宏，但是Ant要實(shí)現像Maven中那樣的全局重用性，還有很長(cháng)的路要走。
在Maven中，Test插件定義了所有項目共有的邏輯，這些項目需要編譯和執行單元測試。
Test插件已經(jīng)獲得了編譯和執行單元測試的最佳方法，并使這些方法可以在所有項目中可用。當你運行maven test命令時(shí)，Maven把信息從POM傳遞到Test插件，Test插件依賴(lài)于一個(gè)Java插件的Maven命令來(lái)進(jìn)行編譯。你沒(méi)有在Maven中顯式地告訴編譯容器如何去執行一個(gè)JUnit測試。如果你有這么做，你就會(huì )遇到與Ant中相同的問(wèn)題。正如你不會(huì )告訴一個(gè)Servlet容器如何取出打開(kāi)WAR文件，并取出其中的文件，你也不會(huì )告訴Maven如何編譯項目。Maven是一個(gè)編譯容器，它提供了一個(gè)抽象層，這個(gè)抽象層把編譯邏輯與項目分離。許多人一開(kāi)始被Maven吸引是因為它提供了管理依賴(lài)項的功能，但Maven最大的好處是，它提供了一種橫跨多個(gè)項目的標準的“開(kāi)發(fā)基礎設施”。 依賴(lài)項管理只是這個(gè)“開(kāi)發(fā)基礎設施”的一個(gè)副產(chǎn)品。
提示
Maven提供了一個(gè)開(kāi)發(fā)基礎設施和統一的項目布局，在本節結束的時(shí)候，你應該嘗
試著(zhù)讓Maven來(lái)管理編譯過(guò)程的多數細節。你應該使用Maven插件，并集中精力
編寫(xiě)程序，而不是花費寶貴的時(shí)間來(lái)編寫(xiě)編譯腳本。
接下來(lái)的章節將教你如何對Maven做一些小的修改以及如何定制Maven。但前提是，你沒(méi)有把Maven當作另一個(gè)Ant。建立一個(gè)很大的工程，這個(gè)工程有一個(gè)很大的，用Jelly script編寫(xiě)的maven.xml，它相當于A(yíng)nt的build.xml，這樣的情況是很有可能的；如果你真的這么做了，你就錯過(guò)了使用Maven所帶來(lái)的好處。如果你發(fā)現在使用Maven編譯項目時(shí)，包含了大量與編譯相關(guān)的邏輯，那你就需要重新考慮一下Maven的用法了。高度定制的Maven編譯并不一定好用；當需要的時(shí)候，請盡量使用現有的插件。例如，如果你的項目需要編譯Java源代碼并創(chuàng )建一個(gè)JAR文件，請使用Java插件和JAR插件。如果你忽略了插件的使用，而去使用Maven的Ant集成，建議你干脆不要使用Maven。不要錯誤地使用Maven，要按照Maven的方式來(lái)使用它。
文森特說(shuō)：“尼奧，吃了那個(gè)紅藥片…。”,提姆說(shuō)：“抵抗是沒(méi)有用的。”
生成項目文檔
如果你正在開(kāi)發(fā)一個(gè)Java應用程序或視一個(gè)類(lèi)庫，你可能需要生成JavaDoc。
步驟
只要執行了javadoc命令，Maven就會(huì )生成項目文檔。以下是執行javadoc命令的輸出結果：
C:\dev\mavenbook\code\genapp\test-application>maven javadoc
__ __
| \/ |__ _Apache__ ___
| |\/| / _` \ V / -_) ‘ \ ~ intelligent projects ~
|_| |_\__,_|\_/\___|_||_| v. 1.0.2
build:start:
xdoc:init:
maven-javadoc-plugin:report:
[mkdir] Created dir: C:\dev\mavenbook\code\genapp\test-application\
target\javadoc\src
[javadoc] Generating Javadoc
[javadoc] Javadoc execution
[javadoc] Loading source files for package mdn.testapp...
[javadoc] Constructing Javadoc information...
[javadoc] Standard Doclet version 1.5.0_01
[javadoc] Building tree for all the packages and classes...
[javadoc] Generating C:\dev\mavenbook\code\genapp\test-application\
target\docs\apidocs\constant-values.html...
[javadoc] Copying file C:\Documents and Settings\tobrien\.maven\cache\
maven-javadoc-plugin-1.7\plugin-resources\stylesheet.css to file C:\dev\
mavenbook\code\genapp\test-application\target\docs\apidocs\stylesheet.css...
[javadoc] Building index for all the packages and classes...
[javadoc] Building index for all classes...
[delete] Deleting directory C:\dev\mavenbook\code\genapp\test-
application\target\javadoc\src
BUILD SUCCESSFUL
Total time: 7 seconds
一旦這個(gè)Maven命令被執行，JavaDoc將被放置在tes-application/target/javadoc/src目錄下。
總結
Maven又完成了“繁重”的任務(wù)。你需要JavaDoc，然后告訴Maven生成JavaDoc，僅此而已。需要強調的是，你并沒(méi)有向Maven傳遞任何關(guān)于項目的信息，它知道怎么辦。Maven的大部分功能就像這樣簡(jiǎn)單直接。你只需告訴Maven關(guān)于項目的信息，你要做的事就所剩無(wú)幾了；Maven自會(huì )處理細節。
讓Maven了解你的團隊
Maven 是一款很好用的進(jìn)行合作開(kāi)發(fā)的工具。你可以使用它來(lái)生成開(kāi)發(fā)人員活動(dòng)報告以及項目投稿人列表和郵件列表。
步驟
很多項目都有郵件列表，人們用它來(lái)討論架構于實(shí)現。像Tomcat、Maven和Ant這樣的項目都是由一個(gè)社區的開(kāi)發(fā)者共同開(kāi)發(fā)的，他們共同訂閱同一個(gè)郵件列表。并不只是開(kāi)源項目有郵件列表，很多組織已經(jīng)開(kāi)始使用在開(kāi)源的、公開(kāi)的項目中所使用的合作模型。因為郵件列表是合作中極為重要的一部分，所以Maven提供了一種在project.xml文件中指定項目郵件列表的方法。以下是project.xml文件的一部分，它向project.xml文件中添加了mailingLists元素：
<mailingLists>
<mailingList>
<name>Maven User List</name>
<subscribe>users-subscribe@maven.apache.org</subscribe>
<unsubscribe>users-unsubscribe@maven.apache.org</unsubscribe>
<archive>http://marc.theaimsgroup.com/?l=turbine-maven-user</archive>
</mailingList>
<mailingList>
<name>Maven Developer List</name>
<subscribe>dev-subscribe@maven.apache.org</subscribe>
<unsubscribe>dev-unsubscribe@maven.apache.org</unsubscribe>
<archive>http://marc.theaimsgroup.com/?l=turbine-maven-dev</archive>
</mailingList>
</mailingLists>
Maven項目中有兩種類(lèi)型的隊員：投稿者與開(kāi)發(fā)者。然而，在你的項目中，這個(gè)定義可能要改變了。投稿者通常是指開(kāi)源社區中提供補丁和文檔的成員，開(kāi)發(fā)者是項目的核心成員。在A(yíng)SF中，投稿者與執行者(committers)都可以給項目投稿，但投稿者沒(méi)有對源代碼庫的寫(xiě)入權限，也沒(méi)有對項目中重大決定的表決權。以下是project.xml文件的一部分，它向project.xml文件添加一個(gè)contributor元素和一個(gè)developer元素：
<developers>
<developer>
<name>Vincent Massol</name>
<id>vmassol</id>
<email>vmassol@apache.org</email>
<organization>Apache Software Foundation</organization>
<roles>
<role>Author</role>
<role>Developer</role>
</roles>
<url>http://www.massol.net</url>
<timezone>+1</timezone>
</developer>
</developers>
<contributors>
<contributor>
<name>Tim OBrien</name>
<email>tobrien@apache.org</email>
<organization>Apache Software Foundation</organization>
<roles>
<role>Author</role>
<role>Developer</role>
</roles>
<url>http://www.oreillynet.com/pub/au/1738</url>
<timezone>-6</timezone>
</contributor>
</contributors>
總結
你得告訴Maven誰(shuí)在為項目工作，一旦我們生成了項目網(wǎng)站，這么做就會(huì )有用了。生成網(wǎng)站的插件和從源代碼控制系統生成報表的很多插件都將使用這個(gè)POM中所列出了開(kāi)發(fā)者和投稿者的信息。
把Maven指向源代碼控制系統
你使用源代碼控制系統嗎？把源代碼控制系統的相關(guān)信息告訴Maven，你就可以生成一些有趣的報表，這將在本書(shū)后面的部分學(xué)習。把項目與一個(gè)源代碼庫聯(lián)系在一起，你就可以使用Maven的源代碼控制管理(SCM)插件了，這個(gè)插件提供可以用來(lái)從從版本控制系統(如CVS或Subversion)更新和釋放源代碼的Maven命令(goals)。
步驟
首先你得在project.xml文件中添加一個(gè)repository元素。以下repository元素來(lái)自Apache Struts項目，它指向了位于http://svn.apache.org/repos/asf/struts/core/trunk的Subversion 中的源代碼庫：
<repository>
<connection>
scm:svn:http://svn.apache.org/repos/asf/struts/core/trunk
</connection>
<developerConnection>
scm:svn:https://svn.apache.org/repos/asf/struts/core/trunk
</developerConnection>
<url>http://svn.apache.org/repos/asf/struts/core/trunk</url>
</repository>
connection元素告訴Maven SCM的位置，這個(gè)位置是只讀的。SCM把這個(gè)URL標識為一個(gè)SCM位置，svn告訴Maven位于這個(gè)URL的是一個(gè)Subversion庫，URL的最后一部分表示項目主體的位置。你還可以指定developerConnection元素；當你想要把相關(guān)人員分成有源代碼寫(xiě)入權限的和無(wú)源代碼寫(xiě)入權限的，你就會(huì )用到developerConnection
url元素提供的URL，可以用來(lái)瀏覽源代碼庫。在Struts中，Struts自己已經(jīng)指向一個(gè)Subversion庫，因為用常規瀏覽器就可以瀏覽。Struts團隊也可以選擇指向ViewCVS的實(shí)例，它被配置為指向ASF Subversion庫，這個(gè)庫位于以下URL：
http://cvs.apache.org/viewcvs.cgi/struts/core/trunk?root=Apache-SVN。
當你把一個(gè)project.xml文件指向一個(gè)特定的源代碼控制系統時(shí)，你還可以指定某一特定項目的不同版本和不同分支。以下XML片段顯示了Apache Struts的project.xml中versions元素和branches元素的精簡(jiǎn)版本：
<versions>
<version>
<id>1.2.0</id>
<name>1.2.0</name>
<tag>STRUTS_1_2_0</tag>
</version>
<version>
<id>1.2.6</id>
<name>1.2.6</name>
<tag>STRUTS_1_2_6</tag>
</version>
</versions>
<branches>
<branch>
<tag>STRUTS_1_1_BRANCH</tag>
</branch>
<branch>
<tag>STRUTS_1_2_BRANCH</tag>
</branch>
</branches>
版本(Versions)會(huì )被一些插件使用，例如，Announcements插件，它為每個(gè)版本創(chuàng )建釋放記錄。
關(guān)于CVS
許多公司和開(kāi)源項目已經(jīng)轉為使用Subversion，一些像JBoss這樣的主要的開(kāi)源項目也已經(jīng)轉為使用Subversion。如果你的項目正在使用CVS，你得添加一個(gè)repository元素，這個(gè)元素類(lèi)似于Jakarta Cactus項目中的repository元素，以下是Jakarta Cactus項目中的repository元素：
<repository>
<connection>
scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:jakarta-cactus
</connection>
<url>http://cvs.apache.org/viewcvs.cgi/jakarta-cactus/</url>
</repository>
如果你要使用CVS的pserver來(lái)暴露你的庫，以上的repository元素會(huì )很合適。如果你要通過(guò)SSH來(lái)訪(fǎng)問(wèn)CVS，你得設定環(huán)境變量CVS_RSH的值為ssh，語(yǔ)法如下：
<repository>
<connection>
scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:jakarta-cactus
</connection>
<url>http://cvs.apache.org/viewcvs.cgi/jakarta-cactus/</url>
<developerConnection>
scm:cvs:ext:tobrien@somehost:/home/cvs/repository:modulename
</developerConnection>
</repository>
生成Maven項目網(wǎng)站
Maven可以用項目的規律和項目的相關(guān)信息，創(chuàng )建一個(gè)項目網(wǎng)頁(yè)。
步驟
要想創(chuàng )建一個(gè)Maven項目網(wǎng)站，請使用以下Maven命令來(lái)運行Site插件：
C:\dev\mavenbook\code\genapp\test-application> maven site
運行Site插件，將會(huì )在默認網(wǎng)站輸出目錄下創(chuàng )建項目網(wǎng)站：test-application/target/docs/index.html。如果你加載這個(gè)HTML頁(yè)，你就會(huì )看到一個(gè)帶有獨特的Maven外觀(guān)的網(wǎng)站。圖1-5顯示了一個(gè)略微經(jīng)過(guò)定制的Maven網(wǎng)站，上面有定制的組織徽標和項目徽標。這不是一個(gè)認為編寫(xiě)的網(wǎng)站，你所看到是一個(gè)名為Jaxen的項目的網(wǎng)站，這個(gè)項目把Maven當作編譯系統來(lái)使用。
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="jaxen" repository="jaxen" >
<links>
<item name="The Werken Company" />
</links>
<menu name="jaxen">
<item name="Overview" href="/index.html"/>
<item name="FAQ" href="/faq.html"/>
<item name="Releases" href="/releases.html"/>
<item name="CVS Access" href="/cvs-usage.html"/>
<item name="Status" href="/status.html"/>
</menu>
</properties>
<section name="News">
<p>
Added the slidedeck from my
<a href="/pdf/intro-slides.pdf">SD-West presentation</a>.
</p>
<p>
Check out these
<a >Performance
Benchmarks</a> comparing dom4j and Jaxen against Xerces and Xalan.
</p>
</section>
[...]
</document>
一旦生成了項目網(wǎng)站，你就可以在瀏覽器中加載target/docs/index.html來(lái)打開(kāi)你的項目網(wǎng)站。
關(guān)于這些文件的語(yǔ)法
你可以在Maven XDoc插件FAQ站點(diǎn)找到更多關(guān)于navigation.xml文件的語(yǔ)法和格式的信息，站點(diǎn)的 URL: http://maven.apache.org/reference/plugins/xdoc/faq.html。你還可以在Maven XDoc插件主頁(yè)找到更多關(guān)于個(gè)人主頁(yè)格式的信息，URL如下：
http://maven.apache.org/reference/plugins/xdoc/index.html。這個(gè)插件的主頁(yè)還包含更多關(guān)于如何定制Site插件的輸出和行為的指導。
本書(shū)的第四章將更加深入地分析能夠使項目的行為和結構煥發(fā)光彩的多種報表。
定制網(wǎng)站報表
網(wǎng)站的生成創(chuàng )建了許多有用的報表。但是，根據不同的風(fēng)格，你可能需要某些報表處于非激活狀態(tài)。
步驟
要改變Maven在生成網(wǎng)站時(shí)創(chuàng )建的報表，就得修改project.xml文件中reports元素的內容。以下是一個(gè)reports元素，其中有幾個(gè)report項是激活的：
<reports>
<report>maven-changelog-plugin</report>
<report>maven-changes-plugin</report>
<report>maven-checkstyle-plugin</report>
<report>maven-clover-plugin</report>
<report>maven-cruisecontrol-plugin</report>
<report>maven-developer-activity-plugin</report>
<report>maven-faq-plugin</report>
<report>maven-file-activity-plugin</report>
<report>maven-license-plugin</report>
<report>maven-linkcheck-plugin</report>
<report>maven-javadoc-plugin</report>
<report>maven-jdepend-plugin</report>
<report>maven-jira-plugin</report>
<report>maven-junit-report-plugin</report>
<report>maven-jxr-plugin</report>
<report>maven-pmd-plugin</report>
<report>maven-simian-plugin</report>
<report>maven-tasklist-plugin</report>
</reports>
要把一個(gè)報表在Maven生成網(wǎng)站時(shí)排除在外，只要從reports元素中移除這個(gè)報表plug-in元素。沒(méi)有制定reports元素的項目會(huì )生成一組默認報表：jdepend、Checkstyle、changes、changelog、developer-activity、file-activity、license、javadoc、jxr、junit、linkcheck以及tasklist。當你在項目的project.xml文件中添加一個(gè)reports元素時(shí)，你必須列出所有你想要生成的報表。
回顧
reports元素列出了所有的報表，但你可能想知道這些報表到底有什么功能。表1-1列出了對這些報表的簡(jiǎn)要描述。
表1-1 報表插件
報表插件 描述
maven-changelog-plugin Changelog是一個(gè)使用repository元素
創(chuàng )建報表的插件，所創(chuàng )建的報表記錄源代碼
控制系統中最近的變化。
maven-changes-plugin 格式化xdocs目錄中的changes.xml
maven-checkstyle-plugin 關(guān)于Java代碼風(fēng)格的報表
maven-clover-plugin 使用一款商業(yè)的覆蓋率測試工具為項目的單元
測試覆蓋率生成HTML頁(yè)。
maven-cruisecontrol-plugin 這個(gè)插件將在第四章中討論。
maven-developer-activity-plugin 創(chuàng )建一個(gè)報表，它記錄最近源代碼控制系統中開(kāi)發(fā)者的活動(dòng)情況。
maven-faq-plugin 格式化xdocs目錄下，項目的FAQ文檔。
maven-file-activity-plugin 創(chuàng )建一個(gè)報表來(lái)記錄源代碼控制系統中文件的活動(dòng)情況。
maven-filebugs-plugin 找出Java代碼中常見(jiàn)的有漏洞的模式。
maven-license-plugin 包括一個(gè)鏈接，它鏈接到項目報表中的項目許可
maven-linkcheck-plugin
maven-javadoc-plugin 向生成的Maven網(wǎng)站中添加JavaDoc
maven-jcoverage-plugin 生成有關(guān)單元測試覆蓋率的報表和圖象。
maven-jdepend-plugin 創(chuàng )建一個(gè)報表，它列出了包之間的依賴(lài)項
maven-jira-plugin 從一款名為Jira的商業(yè)發(fā)布追蹤系統讀取公開(kāi)的發(fā)布,并創(chuàng )建報表。
maven-junit-report-plugin 創(chuàng )建一個(gè)聚集JUnit結果的報表。
maven-jxr-plugin 以注釋的形式生成JAVA源代碼的 相互參照項
maven-pmd-plugin 為潛在的編碼錯誤生成報表，如未使用的本地變量和復雜的表達式等。
maven-simian-plugin 找出源代碼樹(shù)中重復的代碼。
maven-statecvs-plugin 生成CVS活動(dòng)的統計和圖象。
maven-tasklist-plugin 在源代碼中搜索@todo標簽。
獲取插件和報表更詳盡的列表，請訪(fǎng)問(wèn)：
.Maven插件：http://maven.apache.org/reference/plugins/index.html
.Maven的插件沙盒：http://maven.apache.org/plugins-sandbox/index.html
.SourceForge上的Maven插件：http://maven-plugins.sourceforge.net/
.第三方Maven插件：http://maven.apache.org/reference/3rdparty.html
聯(lián)系客服
