本文將使用一個較復雜的實例,講述如何定制目錄布局(即不使用Maven標準目錄布局),以及講述一些關鍵插件的使用(配置)。為了方便其它朋友能夠方便地使用該實例,后臺數據庫使用開源的面向對象數據庫--
db4o
,該數據庫無需安裝,已包含在與本文配套的實例中,文末附有該實例的下載鏈接。(2007.01.02最后更新)
注:轉載時請注明原作者(jiangshachina)及出處(
http://www.blogjava.net/jiangshachina
)!
1 實例的構想
文章開頭的摘要已經講述了,本文仍然將以一個實例描述如何使用Maven, 該實例將使用非Maven標準的目錄結構,并將呈現一些關鍵的Maven插件的配置與應用。 該實例是一個基于db4o的數據庫Web應用。該應用本身十分簡單,即從db4o數據庫中查詢出若干記錄并將它們顯現在Web頁面中。
??? 該實例仍然由一個普通應用工程(demo-app)與一個Web應用工程(demo-web),以及這兩個工程的父工程(demo)構成,最終的目標是將Web應用工程制作成war文件,并部署到JBoss服務器中。啟動服務器后,能夠在頁面中看到正確的查詢結果。
??? 該實例使用Eclipse3.2 + JDK1.5.0_10 + Windows2000開發。當然這僅僅只是我個人的開發平臺,但該實例并不受限于此平臺;由于我選擇使用db4o針對JDK1.5的產品包,所以該實例只能運行在JDK1.5.0或更高版本的JDK/JRE中; 該工程中的所有文件都使用UTF-8編碼方式。
2 demo工程
demo工程是其它兩個工程的父工程,它的主要職責是預定義子工程所需要依賴的jar文件(artifact),以及針對子工程所使用的插件進行通用配置。該工程完整的POM文件如下所示:
??? <modelVersion> 4.0.0 </modelVersion>
??? <groupId>mvn.demo</groupId>
??? <artifactId>demo</artifactId>
??? <packaging>pom</packaging>
??? <version> 1.0 -SNAPSHOT</version>
??? <description>Maven?Demo?Project</description>
??? <modules>
??????? <module>demo-app</module>
??????? <module>demo-web</module>
??? </modules>
??? <dependencyManagement>
??????? <dependencies>
??????????? <dependency>
??????????????? <groupId>mvn.demo</groupId>
??????????????? <artifactId>demo-app</artifactId>
??????????????? <version>${project.version}</version>
??????????? </dependency>
??????????? <dependency>
??????????????? <groupId>mvn.demo</groupId>
??????????????? <artifactId>demo-web</artifactId>
??????????????? <version>${project.version}</version>
??????????? </dependency>
??????????? <dependency>
??????????????? <groupId>com.db4o</groupId>
??????????????? <artifactId>db4o-java5</artifactId>
??????????????? <version> 5.5 </version>
??????????? </dependency>
??????????? <dependency>
??????????????? <groupId>javax.servlet</groupId>
??????????????? <artifactId>servlet-api</artifactId>
??????????????? <version> 2.4 </version>
??????????????? <scope>provided</scope>
??????????? </dependency>
??????????? <dependency>
??????????????? <groupId>commons-configuration</groupId>
??????????????? <artifactId>commons-configuration</artifactId>
??????????????? <version> 1.2 </version>
??????????????? <exclusions>
??????????????????? <exclusion>
??????????????????????? <groupId>dom4j</groupId>
??????????????????????? <artifactId>dom4j</artifactId>
??????????????????? </exclusion>
??????????????????? <exclusion>
??????????????????????? <groupId>xml-apis</groupId>
??????????????????????? <artifactId>xml-apis</artifactId>
??????????????????? </exclusion>
??????????????????? <exclusion>
??????????????????????? <groupId>xalan</groupId>
??????????????????????? <artifactId>xalan</artifactId>
??????????????????? </exclusion>
??????????????????? <exclusion>
??????????????????????? <groupId>xerces</groupId>
??????????????????????? <artifactId>xercesImpl</artifactId>
??????????????????? </exclusion>
??????????????? </exclusions>
??????????? </dependency>
??????? </dependencies>
??? </dependencyManagement>
??? <dependencies>
??????? <dependency>
??????? <groupId>junit</groupId>
???????? <artifactId>junit</artifactId>
?????????? <version> 3.8.1 </version>
????? <scope>test</scope>
??? </dependency>
??? </dependencies>
??? <build>
??????? <plugins>
??????????? <plugin>
??????????????? <groupId>org.apache.maven.plugins</groupId>
??????????????? <artifactId>maven-resources-plugin</artifactId>
??????????????? <configuration>
??????????????????? <encoding>UTF- 8 </encoding>
??????????????? </configuration>
??????????? </plugin>
??????????? <plugin>
??????????????? <groupId>org.apache.maven.plugins</groupId>
??????????????? <artifactId>maven-compiler-plugin</artifactId>
??????????????? <configuration>
??????????????????? <source> 1.5 </source>
??????????????????? <target> 1.5 </target>
??????????????????? <encoding>UTF- 8 </encoding>
??????????????? </configuration>
??????????? </plugin>
??????????? <plugin>
??????????????? <groupId>org.apache.maven.plugins</groupId>
??????????????? <artifactId>maven-jar-plugin</artifactId>
??????????????? <configuration>
??????????????????? <archive>
??????????????????????? <addMavenDescriptor>false</addMavenDescriptor>
??????????????????? </archive>
??????????????? </configuration>
??????????? </plugin>
??????????? <plugin>
??????????????? <groupId>org.apache.maven.plugins</groupId>
??????????????? <artifactId>maven-war-plugin</artifactId>
??????????????? <configuration>
??????????????????? <archive>
??????????????????????? <addMavenDescriptor>false</addMavenDescriptor>
??????????????????? </archive>
??????????????? </configuration>
??????????? </plugin>
??????????? <plugin>
??????????????? <groupId>org.apache.maven.plugins</groupId>
??????????????? <artifactId>maven-javadoc-plugin</artifactId>
??????????????? <configuration>
??????????????????? <charset>UTF16</charset>
??????????????? </configuration>
??????????? </plugin>
??????? </plugins>
??? </build>
</project>

??? 預定義工程的依賴關系,就是把會被子工程依賴的artifact的詳細信息(groupId,artifactId,version,...)先聲明到<dependencyManagement>中。然后子工程只需要聲明使用某個artifact就可以了,即那時只需要設置groupId和artifactId(甚至更少)就可以了。
<dependencyManagement>中聲明的artifact并不一定真的會被使用到
。
2.1 聲明依賴關系
??? 根據實際情況, 該實例 需要使用db4o針對java5的產品包(jar文件)。由于該jar文件并不存在于Maven的中央倉庫中,所以我們不能直接通過Maven獲得該jar文件。我們只能另外下載db4o-5.5(Java版)的壓縮包,然后從壓縮包內獲得db4o-java5.jar。得到該jar后,必須先將它安裝到Maven的本地倉庫中(安裝方法參見資源[1],主題"向本地倉庫安裝文件時要生成POM文件"),以備后面的使用。此處將該artifact的groupId定義為com.db4o,artifactId定義為db4o-java5,version自然就是5.5了(請見上述POM腳本)。
??? 由于該實例最終是一個Web應用,所以它至少需要依賴Servlet的包(servlet-api-2.4.jar),還需要commons-configuration-1.2.jar。這兩個artifact都已經存在于Maven中央倉庫中,所以我查找到它們后,按照Maven中央倉庫的命名將它們聲明到了<dependencyManagement>中(請見上述POM腳本)。junit是進行單元測試時使用的artifact,(假設)它肯定會被每個工程使用,所以沒有將它設置到 <dependencyManagement>中,而直接設置到了 <dependency>中。
??? 細心的朋友肯定已經發現了,針對 commons-configuration的依賴聲明處多了一些語句。從表面上看,應該是排除了4個artifact(dom4j,
xml-apis
,
xalan
和
xerces
)。不錯,就是排除了這4個jar文件(artifact)。如果有興趣的話,可以將整個<exclusions>元素刪除,然后再嘗試一下制作war文件。你會發現在WEB-INF/lib目錄下存在著這4個artifact對應的jar文件。那我為什么要將它們“排除”呢?因為,它們是多余的!即,它們對于我的這個Web應用來說,根本就是無用的!
??? Maven2加入了一個很好的特性:
自動加載“依賴的依賴(Transitive Dependency)”
。以commons-configuration為例。為了能夠讓它運行正常,我們實際上還需要其它一些jar(artifact),如commons-collections,commons-lang,...。但這些artifact我都沒有“顯示”地聲明需要依賴它們,但Maven會自動加載,因為 commons-configuration的POM文件將它們聲明為了dependency 。
??? 既然那個4個artifact是commons-configuration的依賴,為什么會認為它們是無用的呢?實際上,它們就不應該被聲明到commons-configuration的依賴關系中。這是commons-configuration開發者的失誤,他們沒有將依賴關系整理清晰,而將一些確實既不是runtime,更不是compile-time需要的artifact放入到了依賴關系中。在Maven中央倉庫中存在著很多這種情況,所以我們有時需要弄清楚“哪些文件是我們真正需要的,哪些是可以被清除的”。但有時候,很難做到一個不漏。正是由于這一原因,自動加載Transitive Dependency這一極好的特性,有時讓人十分無奈 ^_^
2.2 對插件進行基本配置
我們可以把對插件的全局性(如針對整個項目的)設置放到較高層次的POM文件中,因為它們被設置后,子工程們就會自然遵守它們,而且可以使每個子工程的情況都是一樣的。
??? 在第1節中,已經表明該工程使用JDK1.5平臺,并且所有文件都使用UTF-8的編碼方式。而Maven默認使用JDK1.3級別的javac編譯器;默認使用本地編碼方式(簡體中文Windows操作系統默認使用GBK編碼方式)處理文件。這樣就必須對Maven進行適當設置,以滿足工程的實際需要。
??? 針對資源文件的處理,Maven使用maven-resources-plugin插件,需要將它的編碼方式設置為UTF-8。編譯Java源文件,是使用maven-compiler-plugin插件,需要將它的source(Java源文件)與target(class文件)的級別都設置為1.5,另外還要將它的encoding方式設置為UTF-8。(詳細設置請見POM腳本)
3 demo-app工程
demo-app工程是一個普通應用程序工程,它用于處理和數據庫相關的操作,如針對數據庫的增、刪、改、查等基本功能。該工程POM文件的主要內容如下所示:
??? ......
??? <build>
??????? <finalName>app</finalName>
??????? <directory>target</directory>
??????? <sourceDirectory>src/java</sourceDirectory>
??????? <outputDirectory>target/classes</outputDirectory>
??????? <resources>
??????????? <resource>
??????????????? <directory>src/java</directory>
??????????????? <excludes>
??????????????????? <exclude>**/*.java</exclude>
??????????????? </excludes>
??????????? </resource>
??????? </resources>
??????? <testSourceDirectory>src/test/java</testSourceDirectory>
??????? <testOutputDirectory>target/test-classes</testOutputDirectory>
??????? <testResources>
??????????? <testResource>
??????????????? <directory>src/test/java</directory>
??????????????? <excludes>
??????????????????? <exclude>**/*.java</exclude>
??????????????? </excludes>
??????????? </testResource>
??????? </testResources>
??? </build>
</project>
??? 文章的開頭已經提到,本實例將會使用定制的目錄結構,但在前面卻一字不提此事,現在將描述如何定制目錄結構。Maven的標準目錄結構其實是在Super POM中設置的,由于任何POM都會繼承該POM,所以所有的工作都會默認使用標準目錄結構。要定制目錄,其實就是需要重新設置相關參數的值,即用新值覆蓋Super POM中的值。
[1]<finalName>,該元素指定了工程輸出的artifact的名稱,默認值為${artifactId}-${version},此處修改為app。
[2]<directory>,該元素指定了工程輸出的目標目錄。默認值為target,此處未修改變。
[3]<sourceDirectory>,該元素指定了Java源文件所在的目錄。默認值為src/main/java,此處修改為src/java。
[4]<outputDirectory>,該元素指定了編譯后的class文件的放置目錄。默認值為target/classes,此處未作改變。
[5]<resources>
<resource>,該元素指定了Java源文件使用的資源文件的存放目錄。默認值為src/main/resources,此處修改為src/java。由于在編碼Java源文件時,Maven會將資源路徑中的文件全部拷貝到classes目錄。而此時將Java資源文件目錄與Java源文件目錄,設置為同一目錄,所以需要將.java文件排除在資源文件的范疇之外(
<exclude>**/*.java</exclude>
)。
[6]
<testSourceDirectory>,該元素指定了單元測試Java源文件的放置目錄。默認值為src/test/java,此處未作修改。
[7]
<testOutputDirectory>,該元素指定了單元測試Java源文件編譯后的class文件放置目錄。默認值為
target/test-classes,此處未作改變。
[8]
<testResources>
<testResource>,該元素指定了單元測試Java源文件所使用的資源文件的放置目錄。默認值為src/test/resources,此處修改為
src/test/java。并且也做了與
設置<resources>
<resource>時相同的處理(排除Java源文件)。
??? 通過上述設置后,就可以擁有一個定制的Maven工程目錄結構了。
4 demo-web工程
demo-web工程是整個應用最終的目標輸出,因為此處的目的就是制作一個war文件,然后將它部署到JBoss服務器中。與demo-app工程相比,demo-web工程的POM文件主要有如下不同內容:
??? ......
????<build>
??????? ......
????????<plugins>
????????????<plugin>
????????????????<groupId>org.apache.maven.plugins</groupId>
????????????????<artifactId>maven-war-plugin</artifactId>
????????????????<version> 2.0.1 </version>
????????????????<configuration>
????????????????????<webappDirectory>target/${artifactId}</webappDirectory>
????????????????????<warSourceDirectory>src/webapp</warSourceDirectory>
????????????????</configuration>
????????????</plugin>
????????????<plugin>
????????????????<groupId>org.codehaus.mojo</groupId>
????????????????<artifactId>jboss-maven-plugin</artifactId>
????????????????<version> 1.3.1 </version>
????????????????<configuration>
????????????????????<jbossHome>E:/jboss- 4.0.2 </jbossHome>
????????????????????<serverName>default</serverName>
????????????????????<fileName>
????????????????????????${project.build.directory}/${project.build.finalName}.${project.packaging}
????????????????????</fileName>
????????????????</configuration>
????????????</plugin>
????????</plugins>
????</build>
</project>
可以看出不同之處就在于對maven-war-plguin及jboss-maven-plugin插件的配置與使用。
??? Maven使用maven-war-plugin插件對Web工程制作war文件。由于本文使用了定制目錄結構,這樣則會使maven-war-plugin無法找到Web工程的Web Root目錄(默認是src/main/webapp),所以需要對該插件進行適當地配置。<warSourceDirectory>就是Web工程的Web Root目錄,此處設置為;<webappDirectory>是制作war文件之前,相當于是一個被打開(exploded)的war文件的根目錄(默認是target/artifactId-version)。
??? 該工程的腳本中,還使用了一個JBoss插件。該插件可以將制作好的war文件部署(實質上是拷貝)到指定的JBoss部署目錄中。<jbossHome>是JBoss的安裝根目錄,<serverName>指JBoss Server的名稱,<fileName>是被部署war文件的名稱。
參考資源
[1]Maven入門--概念與實例. http://www.blogjava.net/jiangshachina/archive/2006/09/01/67080.html
[2]Maven + Continuum Weed. http://www.blogjava.net/jiangshachina/archive/2006/09/11/68944.aspx
[3]Maven POM Reference. http://maven.apache.org/pom.html
[3]db4o. http://www.db4objects.com
本文實例下載地址--
http://www.blogjava.net/files/jiangshachina/mvn-demo.rar
更多文章、技術交流、商務合作、聯系博主
微信掃碼或搜索:z360901061

微信掃一掃加我為好友
QQ號聯系: 360901061
您的支持是博主寫作最大的動力,如果您喜歡我的文章,感覺我的文章對您有幫助,請用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧,狠狠點擊下面給點支持吧,站長非常感激您!手機微信長按不能支付解決辦法:請將微信支付二維碼保存到相冊,切換到微信,然后點擊微信右上角掃一掃功能,選擇支付二維碼完成支付。
【本文對您有幫助就好】元
