1. 程式人生 > >Maven pom.xml 各標籤元素 詳細註解樣例檔案

Maven pom.xml 各標籤元素 詳細註解樣例檔案

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <!--父專案的座標。如果專案中沒有規定某個元素的值,那麼父專案中的對應值即為專案的預設值。 座標包括group ID,artifact ID和 version。 -->
    <parent
>
<!--被繼承的父專案的構件識別符號 --> <artifactId /> <!--被繼承的父專案的全球唯一識別符號 --> <groupId /> <!--被繼承的父專案的版本 --> <version /> <!--父專案的pom.xml檔案的相對路徑。相對路徑允許你選擇一個不同的路徑。預設值是../pom.xml。Maven首先在構建當前專案的地方尋找父專案的pom,其次在檔案系統的這個位置(relativePath位置),然後在本地倉庫,最後在遠端倉庫尋找父專案的pom。 -->
<relativePath /> </parent> <!--宣告專案描述符遵循哪一個POM模型版本。模型本身的版本很少改變,雖然如此,但它仍然是必不可少的,這是為了當Maven引入了新的特性或者其他模型變更的時候,確保穩定性。 --> <modelVersion>4.0.0</modelVersion> <!--專案的全球唯一識別符號,通常使用全限定的包名區分該專案和其他專案。並且構建時生成的路徑也是由此生成, 如com.mycompany.app生成的相對路徑為:/com/mycompany/app -->
<groupId>asia.banseon</groupId> <!--構件的識別符號,它和group ID一起唯一標識一個構件。換句話說,你不能有兩個不同的專案擁有同樣的artifact ID和groupID;在某個特定的group ID下,artifact ID也必須是唯一的。構件是專案產生的或使用的一個東西,Maven為專案產生的構件包括:JARs,原始碼,二進位制釋出和WARs等。 --> <artifactId>banseon-maven2</artifactId> <!--專案產生的構件型別,例如jar、war、ear、pom。外掛可以建立他們自己的構件型別,所以前面列的不是全部構件型別 --> <packaging>jar</packaging> <!--專案當前版本,格式為:主版本.次版本.增量版本-限定版本號 --> <version>1.0-SNAPSHOT</version> <!--專案的名稱, Maven產生的文件用 --> <name>banseon-maven</name> <!--專案主頁的URL, Maven產生的文件用 --> <url>http://www.baidu.com/banseon</url> <!--專案的詳細描述, Maven 產生的文件用。 當這個元素能夠用HTML格式描述時(例如,CDATA中的文字會被解析器忽略,就可以包含HTML標籤), 不鼓勵使用純文字描述。如果你需要修改產生的web站點的索引頁面,你應該修改你自己的索引頁檔案,而不是調整這裡的文件。 --> <description>A maven project to study maven.</description> <!--描述了這個專案構建環境中的前提條件。 --> <prerequisites> <!--構建該專案或使用該外掛所需要的Maven的最低版本 --> <maven /> </prerequisites> <!--專案的問題管理系統(Bugzilla, Jira, Scarab,或任何你喜歡的問題管理系統)的名稱和URL,本例為 jira --> <issueManagement> <!--問題管理系統(例如jira)的名字, --> <system>jira</system> <!--該專案使用的問題管理系統的URL --> <url>http://jira.xxxx.com/xxxx</url> </issueManagement> <!--專案持續整合資訊 --> <ciManagement> <!--持續整合系統的名字,例如continuum --> <system /> <!--該專案使用的持續整合系統的URL(如果持續整合系統有web介面的話)。 --> <url /> <!--構建完成時,需要通知的開發者/使用者的配置項。包括被通知者資訊和通知條件(錯誤,失敗,成功,警告) --> <notifiers> <!--配置一種方式,當構建中斷時,以該方式通知使用者/開發者 --> <notifier> <!--傳送通知的途徑 --> <type /> <!--發生錯誤時是否通知 --> <sendOnError /> <!--構建失敗時是否通知 --> <sendOnFailure /> <!--構建成功時是否通知 --> <sendOnSuccess /> <!--發生警告時是否通知 --> <sendOnWarning /> <!--不贊成使用。通知傳送到哪裡 --> <address /> <!--擴充套件配置項 --> <configuration /> </notifier> </notifiers> </ciManagement> <!--專案建立年份,4位數字。當產生版權資訊時需要使用這個值。 --> <inceptionYear /> <!--專案相關郵件列表資訊 --> <mailingLists> <!--該元素描述了專案相關的所有郵件列表。自動產生的網站引用這些資訊。 --> <mailingList> <!--郵件的名稱 --> <name>Demo</name> <!--傳送郵件的地址或連結,如果是郵件地址,建立文件時,mailto: 連結會被自動建立 --> <post>[email protected]</post> <!--訂閱郵件的地址或連結,如果是郵件地址,建立文件時,mailto: 連結會被自動建立 --> <subscribe>[email protected]</subscribe> <!--取消訂閱郵件的地址或連結,如果是郵件地址,建立文件時,mailto: 連結會被自動建立 --> <unsubscribe>[email protected]</unsubscribe> <!--你可以瀏覽郵件資訊的URL --> <archive>http://localhost:8080/demo/dev/</archive> </mailingList> </mailingLists> <!--專案開發者列表 --> <developers> <!--某個專案開發者的資訊 --> <developer> <!--SCM裡專案開發者的唯一識別符號 --> <id>HELLO WORLD</id> <!--專案開發者的全名 --> <name>youname</name> <!--專案開發者的email --> <email>[email protected]</email> <!--專案開發者的主頁的URL --> <url /> <!--專案開發者在專案中扮演的角色,角色元素描述了各種角色 --> <roles> <role>Project Manager</role> <role>Architect</role> </roles> <!--專案開發者所屬組織 --> <organization>demo</organization> <!--專案開發者所屬組織的URL --> <organizationUrl>http://www.xxx.com/</organizationUrl> <!--專案開發者屬性,如即時訊息如何處理等 --> <properties> <dept>No</dept> </properties> <!--專案開發者所在時區, -11到12範圍內的整數。 --> <timezone>+8</timezone> </developer> </developers> <!--專案的其他貢獻者列表 --> <contributors> <!--專案的其他貢獻者。參見developers/developer元素 --> <contributor> <name /> <email /> <url /> <organization /> <organizationUrl /> <roles /> <timezone /> <properties /> </contributor> </contributors> <!--該元素描述了專案所有License列表。 應該只列出該專案的license列表,不要列出依賴專案的 license列表。如果列出多個license,使用者可以選擇它們中的一個而不是接受所有license。 --> <licenses> <!--描述了專案的license,用於生成專案的web站點的license頁面,其他一些報表和validation也會用到該元素。 --> <license> <!--license用於法律上的名稱 --> <name>Apache 2</name> <!--官方的license正文頁面的URL --> <url>http://www.xxxx.com/LICENSE-2.0.txt</url> <!--專案分發的主要方式: repo,可以從Maven庫下載 manual, 使用者必須手動下載和安裝依賴 --> <distribution>repo</distribution> <!--關於license的補充資訊 --> <comments>A business-friendly OSS license</comments> </license> </licenses> <!--SCM(Source Control Management)標籤允許你配置你的程式碼庫,供Maven web站點和其它外掛使用。 --> <scm> <!--SCM的URL,該URL描述了版本庫和如何連線到版本庫。欲知詳情,請看SCMs提供的URL格式和列表。該連線只讀。 --> <connection> scm:svn:http://svn.xxxx.com/maven/xxxxx-maven2-trunk(dao-trunk) </connection> <!--給開發者使用的,類似connection元素。即該連線不僅僅只讀 --> <developerConnection> scm:svn:http://svn.xxxx.com/maven/dao-trunk </developerConnection> <!--當前程式碼的標籤,在開發階段預設為HEAD --> <tag /> <!--指向專案的可瀏覽SCM庫(例如ViewVC或者Fisheye)的URL。 --> <url>http://svn.xxxxx.com/</url> </scm> <!--描述專案所屬組織的各種屬性。Maven產生的文件用 --> <organization> <!--組織的全名 --> <name>demo</name> <!--組織主頁的URL --> <url>http://www.xxxxxx.com/</url> </organization> <!--構建專案需要的資訊 --> <build> <!--該元素設定了專案原始碼目錄,當構建專案的時候,構建系統會編譯目錄裡的原始碼。該路徑是相對於pom.xml的相對路徑。 --> <sourceDirectory /> <!--該元素設定了專案指令碼原始碼目錄,該目錄和原始碼目錄不同:絕大多數情況下,該目錄下的內容 會被拷貝到輸出目錄(因為指令碼是被解釋的,而不是被編譯的)。 --> <scriptSourceDirectory /> <!--該元素設定了專案單元測試使用的原始碼目錄,當測試專案的時候,構建系統會編譯目錄裡的原始碼。該路徑是相對於pom.xml的相對路徑。 --> <testSourceDirectory /> <!--被編譯過的應用程式class檔案存放的目錄。 --> <outputDirectory /> <!--被編譯過的測試class檔案存放的目錄。 --> <testOutputDirectory /> <!--使用來自該專案的一系列構建擴充套件 --> <extensions> <!--描述使用到的構建擴充套件。 --> <extension> <!--構建擴充套件的groupId --> <groupId /> <!--構建擴充套件的artifactId --> <artifactId /> <!--構建擴充套件的版本 --> <version /> </extension> </extensions> <!--當專案沒有規定目標(Maven2 叫做階段)時的預設值 --> <defaultGoal /> <!--這個元素描述了專案相關的所有資源路徑列表,例如和專案相關的屬性檔案,這些資源被包含在最終的打包檔案裡。 --> <resources> <!--這個元素描述了專案相關或測試相關的所有資源路徑 --> <resource> <!--描述了資源的目標路徑。該路徑相對target/classes目錄(例如${project.build.outputDirectory})。舉個例子,如果你想資源在特定的包裡(org.apache.maven.messages),你就必須該元素設定為org/apache/maven/messages。然而,如果你只是想把資源放到原始碼目錄結構裡,就不需要該配置。 --> <targetPath /> <!--是否使用引數值代替引數名。引數值取自properties元素或者檔案裡配置的屬性,檔案在filters元素裡列出。 --> <filtering /> <!--描述存放資源的目錄,該路徑相對POM路徑 --> <directory /> <!--包含的模式列表,例如**/*.xml. --> <includes /> <!--排除的模式列表,例如**/*.xml --> <excludes /> </resource> </resources> <!--這個元素描述了單元測試相關的所有資源路徑,例如和單元測試相關的屬性檔案。 --> <testResources> <!--這個元素描述了測試相關的所有資源路徑,參見build/resources/resource元素的說明 --> <testResource> <targetPath /> <filtering /> <directory /> <includes /> <excludes /> </testResource> </testResources> <!--構建產生的所有檔案存放的目錄 --> <directory /> <!--產生的構件的檔名,預設值是${artifactId}-${version}。 --> <finalName /> <!--當filtering開關開啟時,使用到的過濾器屬性檔案列表 --> <filters /> <!--子專案可以引用的預設外掛資訊。該外掛配置項直到被引用時才會被解析或繫結到生命週期。給定外掛的任何本地配置都會覆蓋這裡的配置 --> <pluginManagement> <!--使用的外掛列表 。 --> <plugins> <!--plugin元素包含描述外掛所需要的資訊。 --> <plugin> <!--外掛在倉庫裡的group ID --> <groupId /> <!--外掛在倉庫裡的artifact ID --> <artifactId /> <!--被使用的外掛的版本(或版本範圍) --> <version /> <!--是否從該外掛下載Maven擴充套件(例如打包和型別處理器),由於效能原因,只有在真需要下載時,該元素才被設定成enabled。 --> <extensions /> <!--在構建生命週期中執行一組目標的配置。每個目標可能有不同的配置。 --> <executions> <!--execution元素包含了外掛執行需要的資訊 --> <execution> <!--執行目標的識別符號,用於標識構建過程中的目標,或者匹配繼承過程中需要合併的執行目標 --> <id /> <!--綁定了目標的構建生命週期階段,如果省略,目標會被繫結到源資料裡配置的預設階段 --> <phase /> <!--配置的執行目標 --> <goals /> <!--配置是否被傳播到子POM --> <inherited /> <!--作為DOM物件的配置 --> <configuration /> </execution> </executions> <!--專案引入外掛所需要的額外依賴 --> <dependencies> <!--參見dependencies/dependency元素 --> <dependency>......</dependency> </dependencies> <!--任何配置是否被傳播到子專案 --> <inherited /> <!--作為DOM物件的配置 --> <configuration /> </plugin> </plugins> </pluginManagement> <!--使用的外掛列表 --> <plugins> <!--參見build/pluginManagement/plugins/plugin元素 --> <plugin> <groupId /> <artifactId /> <version /> <extensions /> <executions> <execution> <id /> <phase /> <goals /> <inherited /> <configuration /> </execution> </executions> <dependencies> <!--參見dependencies/dependency元素 --> <dependency>......</dependency> </dependencies> <goals /> <inherited /> <configuration /> </plugin> </plugins> </build> <!--在列的專案構建profile,如果被啟用,會修改構建處理 --> <profiles> <!--根據環境引數或命令列引數啟用某個構建處理 --> <profile> <!--構建配置的唯一識別符號。即用於命令列啟用,也用於在繼承時合併具有相同識別符號的profile。 --> <id /> <!--自動觸發profile的條件邏輯。Activation是profile的開啟鑰匙。profile的力量來自於它 能夠在某些特定的環境中自動使用某些特定的值;這些環境通過activation元素指定。activation元素並不是啟用profile的唯一方式。 --> <activation> <!--profile預設是否啟用的標誌 --> <activeByDefault /> <!--當匹配的jdk被檢測到,profile被啟用。例如,1.4啟用JDK1.4,1.4.0_2,而!1.4啟用所有版本不是以1.4開頭的JDK。 --> <jdk /> <!--當匹配的作業系統屬性被檢測到,profile被啟用。os元素可以定義一些作業系統相關的屬性。 --> <os> <!--啟用profile的作業系統的名字 --> <name>Windows XP</name> <!--啟用profile的作業系統所屬家族(如 'windows') --> <family>Windows</family> <!--啟用profile的作業系統體系結構 --> <arch>x64</arch> <!--啟用profile的作業系統版本 --> <version>6.1.7100</version> </os> <!--如果Maven檢測到某一個屬性(其值可以在POM中通過${名稱}引用),其擁有對應的名稱和值,Profile就會被啟用。如果值 欄位是空的,那麼存在屬性名稱欄位就會啟用profile,否則按區分大小寫方式匹配屬性值欄位 --> <property> <!--啟用profile的屬性的名稱 --> <name>mavenVersion</name> <!--啟用profile的屬性的值 --> <value>2.0.3</value> </property> <!--提供一個檔名,通過檢測該檔案的存在或不存在來啟用profile。missing檢查檔案是否存在,如果不存在則啟用 profile。另一方面,exists則會檢查檔案是否存在,如果存在則啟用profile。 --> <file> <!--如果指定的檔案存在,則啟用profile。 --> <exists>/usr/local/xxxx/xxxx-home/tomcat/maven-guide-zh-to-production/workspace/ </exists> <!--如果指定的檔案不存在,則啟用profile。 --> <missing>/usr/local/xxxx/xxxx-home/tomcat/maven-guide-zh-to-production/workspace/ </missing> </file> </activation> <!--構建專案所需要的資訊。參見build元素 --> <build> <defaultGoal /> <resources> <resource> <targetPath /> <filtering /> <directory /> <includes /> <excludes /> </resource> </resources> <testResources> <testResource> <targetPath /> <filtering /> <directory /> <includes /> <excludes /> </testResource> </testResources> <directory /> <finalName /> <filters /> <pluginManagement> <plugins> <!--參見build/pluginManagement/plugins/plugin元素 --> <plugin> <groupId /> <artifactId /> <version /> <extensions /> <executions> <execution> <id /> <phase /> <goals /> <inherited /> <configuration /> </execution> </executions> <dependencies> <!--參見dependencies/dependency元素 --> <dependency>......</dependency> </dependencies> <goals /> <inherited /> <configuration /> </plugin> </plugins> </pluginManagement> <plugins> <!--參見build/pluginManagement/plugins/plugin元素 --> <plugin> <groupId /> <artifactId /> <version /> <extensions /> <executions> <execution> <id /> <phase /> <goals /> <inherited /> <configuration /> </execution> </executions> <dependencies> <!--參見dependencies/dependency元素 --> <dependency>......</dependency> </dependencies> <goals /> <inherited /> <configuration /> </plugin> </plugins> </build> <!--模組(有時稱作子專案) 被構建成專案的一部分。列出的每個模組元素是指向該模組的目錄的相對路徑 --> <modules /> <!--發現依賴和擴充套件的遠端倉庫列表。 --> <repositories> <!--參見repositories/repository元素 --> <repository> <releases> <enabled /> <updatePolicy /> <checksumPolicy /> </releases> <snapshots> <enabled /> <updatePolicy /> <checksumPolicy /> </snapshots> <id /> <name /> <url /> <layout /> </repository> </repositories> <!--發現外掛的遠端倉庫列表,這些外掛用於構建和報表 --> <pluginRepositories> <!--包含需要連線到遠端外掛倉庫的資訊.參見repositories/repository元素 --> <pluginRepository> <releases> <enabled /> <updatePolicy /> <checksumPolicy /> </releases> <snapshots> <enabled /> <updatePolicy /> <checksumPolicy /> </snapshots> <id /> <name /> <url /> <layout /> </pluginRepository> </pluginRepositories> <!--該元素描述了專案相關的所有依賴。 這些依賴組成了專案構建過程中的一個個環節。它們自動從專案定義的倉庫中下載。要獲取更多資訊,請看專案依賴機制。 --> <dependencies> <!--參見dependencies/dependency元素 --> <dependency>......</dependency> </dependencies> <!--不贊成使用. 現在Maven忽略該元素. --> <reports /> <!--該元素包括使用報表外掛產生報表的規範。當用戶執行“mvn site”,這些報表就會執行。 在頁面導航欄能看到所有報表的連結。參見reporting元素 --> <reporting>......</reporting> <!--參見dependencyManagement元素 --> <dependencyManagement> <dependencies> <!--參見dependencies/dependency元素 --> <dependency>......</dependency> </dependencies> </dependencyManagement> <!--參見distributionManagement元素 --> <distributionManagement>......</distributionManagement> <!--參見properties元素 --> <properties /> </profile> </profiles> <!--模組(有時稱作子專案) 被構建成專案的一部分。列出的每個模組元素是指向該模組的目錄的相對路徑 --> <modules /> <!--發現依賴和擴充套件的遠端倉庫列表。 --> <repositories> <!--包含需要連線到遠端倉庫的資訊 --> <repository> <!--如何處理遠端倉庫裡釋出版本的下載 --> <releases> <!--true或者false表示該倉庫是否為下載某種型別構件(釋出版,快照版)開啟。 --> <enabled /> <!--該元素指定更新發生的頻率。Maven會比較本地POM和遠端POM的時間戳。這裡的選項是:always(一直),daily(預設,每日),interval:X(這裡X是以分鐘為單位的時間間隔),或者never(從不)。 --> <updatePolicy /> <!--當Maven驗證構件校驗檔案失敗時該怎麼做:ignore(忽略),fail(失敗),或者warn(警告)。 --> <checksumPolicy /> </releases> <!--如何處理遠端倉庫裡快照版本的下載。有了releases和snapshots這兩組配置,POM就可以在每個單獨的倉庫中,為每種型別的構件採取不同的策略。例如,可能有人會決定只為開發目的開啟對快照版本下載的支援。參見repositories/repository/releases元素 --> <snapshots> <enabled /> <updatePolicy /> <checksumPolicy /> </snapshots> <!--遠端倉庫唯一識別符號。可以用來匹配在settings.xml檔案裡配置的遠端倉庫 --> <id>banseon-repository-proxy</id> <!--遠端倉庫名稱 --> <name>banseon-repository-proxy</name> <!--遠端倉庫URL,按protocol://hostname/path形式 --> <url>http://10.10.10.123:8080/repository/</url> <!--用於定位和排序構件的倉庫佈局型別-可以是default(預設)或者legacy(遺留)。Maven 2為其倉庫提供了一個預設的佈局;然而,Maven 1.x有一種不同的佈局。我們可以使用該元素指定佈局是default(預設)還是legacy(遺留)。 --> <layout>default</layout> </repository> </repositories> <!--發現外掛的遠端倉庫列表,這些外掛用於構建和報表 --> <pluginRepositories> <!--包含需要連線到遠端外掛倉庫的資訊.參見repositories/repository元素 --> <pluginRepository>......</pluginRepository> </pluginRepositories> <!--該元素描述了專案相關的所有依賴。 這些依賴組成了專案構建過程中的一個個環節。它們自動從專案定義的倉庫中下載。要獲取更多資訊,請看專案依賴機制。 --> <dependencies> <dependency> <!--依賴的group ID --> <groupId>org.apache.maven</groupId> <!--依賴的artifact ID --> <artifactId>maven-artifact</artifactId> <!--依賴的版本號。 在Maven 2裡, 也可以配置成版本號的範圍。 --> <version>3.8.1</version> <!--依賴型別,預設型別是jar。它通常表示依賴的檔案的副檔名,但也有例外。一個型別可以被對映成另外一個副檔名或分類器。型別經常和使用的打包方式對應,儘管這也有例外。一些型別的例子:jar,war,ejb-client和test-jar。如果設定extensions為 true,就可以在plugin裡定義新的型別。所以前面的型別的例子不完整。 --> <type>jar</type> <!--依賴的分類器。分類器可以區分屬於同一個POM,但不同構建方式的構件。分類器名被附加到檔名的版本號後面。例如,如果你想要構建兩個單獨的構件成JAR,一個使用Java 1.4編譯器,另一個使用Java 6編譯器,你就可以使用分類器來生成兩個單獨的JAR構件。 --> <classifier></classifier> <!--依賴範圍。在專案釋出過程中,幫助決定哪些構件被包括進來。欲知詳情請參考依賴機制。 - compile :預設範圍,用於編譯 - provided:類似於編譯,但支援你期待jdk或者容器提供,類似於classpath - runtime: 在執行時需要使用 - test: 用於test任務時使用 - system: 需要外在提供相應的元素。通過systemPath來取得 - systemPath: 僅用於範圍為system。提供相應的路徑 - optional: 當專案自身被依賴時,標註依賴是否傳遞。用於