本文介紹Maven項目構建中,pom.xml文件的生成規則和常用節點的使用方法。pom.xml官方網址:http://maven.apache.org/pom.html
pom簡介
pom作為項目對象模型。通過xml表示maven項目,使用pom.xml來實現。主要描述了項目:包括配置文件;開發者需要遵循的規則,缺陷管理系統,組織和licenses,項目的url,項目的依賴性,以及其他所有的項目相關因素。
pom.xml文件是Maven進行工作的主要配置文件。在這個文件中我們可以配置Maven項目的groupId、artifactId和version等Maven項目必須的元素;可以配置Maven項目需要使用的遠程倉庫;可以定義Maven項目打包的形式;可以定義Maven項目的資源依賴關系等等。對於一個最簡單的pom.xml的定義必須包含modelVersion、groupId、artifactId和version這四個元素,當然這其中的元素也是可以從它的父項目中繼承的。在Maven中,使用groupId、artifactId和version組成groupdId:artifactId:version的形式來唯一確定一個項目。
- groupId:項目或者組織的唯一標志,並且配置時生成路徑也是由此生成,如org.myproject.mojo生成的相對路徑為:/org/myproject/mojo
- artifactId:項目的通用名稱
- version:項目的版本
- packaging:打包機制,如pom,jar,maven-plugin,ejb,war,ear,rar,par
- POM關系:主要為依賴,繼承,聚合。項目聚合要求父級設置packaging為pom模式。
pom包括了所有的項目信息,常用節點解釋如下:

<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.0http://maven.apache.org/maven-v4_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.baidu.com/banseon</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>banseon@126.com</post> <!--訂閱郵件的地址或鏈接,如果是郵件地址,創建文檔時,mailto: 鏈接會被自動創建--> <subscribe>banseon@126.com</subscribe> <!--取消訂閱郵件的地址或鏈接,如果是郵件地址,創建文檔時,mailto: 鏈接會被自動創建--> <unsubscribe>banseon@126.com</unsubscribe> <!--你可以瀏覽郵件信息的URL--> <archive>http:/hi.baidu.com/banseon/demo/dev/</archive> </mailingList> </mailingLists> <!--項目開發者列表--> <developers> <!--某個項目開發者的信息--> <developer> <!--SCM里項目開發者的唯一標識符--> <id>HELLO WORLD</id> <!--項目開發者的全名--> <name>banseon</name> <!--項目開發者的email--> <email>banseon@126.com</email> <!--項目開發者的主頁的URL--> <url/> <!--項目開發者在項目中扮演的角色,角色元素描述了各種角色--> <roles> <role>Project Manager</role> <role>Architect</role> </roles> <!--項目開發者所屬組織--> <organization>demo</organization> <!--項目開發者所屬組織的URL--> <organizationUrl>http://hi.baidu.com/banseon</organizationUrl> <!--項目開發者屬性,如即時消息如何處理等--> <properties> <dept>No</dept> </properties> <!--項目開發者所在時區, -11到12范圍內的整數。--> <timezone>-5</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.baidu.com/banseon/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.baidu.com/banseon/maven/banseon/banseon-maven2-trunk(dao-trunk) </connection> <!--給開發者使用的,類似connection元素。即該連接不僅僅只讀--> <developerConnection> scm:svn:http://svn.baidu.com/banseon/maven/banseon/dao-trunk </developerConnection> <!--當前代碼的標簽,在開發階段默認為HEAD--> <tag/> <!--指向項目的可瀏覽SCM庫(例如ViewVC或者Fisheye)的URL。--> <url>http://svn.baidu.com/banseon</url> </scm> <!--描述項目所屬組織的各種屬性。Maven產生的文檔用--> <organization> <!--組織的全名--> <name>demo</name> <!--組織主頁的URL--> <url>http://www.baidu.com/banseon</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>x86</arch> <!--激活profile的操作系統版本--> <version>5.1.2600</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/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</exists> <!--如果指定的文件不存在,則激活profile。--> <missing>/usr/local/hudson/hudson-home/jobs/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://192.168.1.169:9999/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: 當項目自身被依賴時,標注依賴是否傳遞。用於連續依賴時使用--> <scope>test</scope> <!--僅供system范圍使用。注意,不鼓勵使用這個元素,並且在新的版本中該元素可能被覆蓋掉。該元素為依賴規定了文件系統上的路徑。需要絕對路徑而不是相對路徑。推薦使用屬性匹配絕對路徑,例如${java.home}。--> <systemPath></systemPath> <!--當計算傳遞依賴時, 從依賴構件列表里,列出被排除的依賴構件集。即告訴maven你只依賴指定的項目,不依賴項目的依賴。此元素主要用於解決版本沖突問題--> <exclusions> <exclusion> <artifactId>spring-core</artifactId> <groupId>org.springframework</groupId> </exclusion> </exclusions> <!--可選依賴,如果你在項目B中把C依賴聲明為可選,你就需要在依賴於B的項目(例如項目A)中顯式的引用對C的依賴。可選依賴阻斷依賴的傳遞性。--> <optional>true</optional> </dependency> </dependencies> <!--不贊成使用. 現在Maven忽略該元素.--> <reports></reports> <!--該元素描述使用報表插件產生報表的規范。當用戶執行“mvn site”,這些報表就會運行。 在頁面導航欄能看到所有報表的鏈接。--> <reporting> <!--true,則,網站不包括默認的報表。這包括“項目信息”菜單中的報表。--> <excludeDefaults/> <!--所有產生的報表存放到哪里。默認值是${project.build.directory}/site。--> <outputDirectory/> <!--使用的報表插件和他們的配置。--> <plugins> <!--plugin元素包含描述報表插件需要的信息--> <plugin> <!--報表插件在倉庫里的group ID--> <groupId/> <!--報表插件在倉庫里的artifact ID--> <artifactId/> <!--被使用的報表插件的版本(或版本范圍)--> <version/> <!--任何配置是否被傳播到子項目--> <inherited/> <!--報表插件的配置--> <configuration/> <!--一組報表的多重規范,每個規范可能有不同的配置。一個規范(報表集)對應一個執行目標 。例如,有1,2,3,4,5,6,7,8,9個報表。1,2,5構成A報表集,對應一個執行目標。2,5,8構成B報表集,對應另一個執行目標--> <reportSets> <!--表示報表的一個集合,以及產生該集合的配置--> <reportSet> <!--報表集合的唯一標識符,POM繼承時用到--> <id/> <!--產生報表集合時,被使用的報表的配置--> <configuration/> <!--配置是否被繼承到子POMs--> <inherited/> <!--這個集合里使用到哪些報表--> <reports/> </reportSet> </reportSets> </plugin> </plugins> </reporting> <!-- 繼承自該項目的所有子項目的默認依賴信息。這部分的依賴信息不會被立即解析,而是當子項目聲明一個依賴(必須描述group ID和 artifact ID信息),如果group ID和artifact ID以外的一些信息沒有描述,則通過group ID和artifact ID 匹配到這里的依賴,並使用這里的依賴信息。--> <dependencyManagement> <dependencies> <!--參見dependencies/dependency元素--> <dependency> ...... </dependency> </dependencies> </dependencyManagement> <!--項目分發信息,在執行mvn deploy后表示要發布的位置。有了這些信息就可以把網站部署到遠程服務器或者把構件部署到遠程倉庫。--> <distributionManagement> <!--部署項目產生的構件到遠程倉庫需要的信息--> <repository> <!--是分配給快照一個唯一的版本號(由時間戳和構建流水號)?還是每次都使用相同的版本號?參見repositories/repository元素--> <uniqueVersion/> <id>banseon-maven2</id> <name>banseon maven2</name> <url>file://${basedir}/target/deploy</url> <layout/> </repository> <!--構件的快照部署到哪里?如果沒有配置該元素,默認部署到repository元素配置的倉庫,參見distributionManagement/repository元素--> <snapshotRepository> <uniqueVersion/> <id>banseon-maven2</id> <name>Banseon-maven2 Snapshot Repository</name> <url>scp://svn.baidu.com/banseon:/usr/local/maven-snapshot</url> <layout/> </snapshotRepository> <!--部署項目的網站需要的信息--> <site> <!--部署位置的唯一標識符,用來匹配站點和settings.xml文件里的配置--> <id>banseon-site</id> <!--部署位置的名稱--> <name>business api website</name> <!--部署位置的URL,按protocol://hostname/path形式--> <url> scp://svn.baidu.com/banseon:/var/www/localhost/banseon-web </url> </site> <!--項目下載頁面的URL。如果沒有該元素,用戶應該參考主頁。使用該元素的原因是:幫助定位那些不在倉庫里的構件(由於license限制)。--> <downloadUrl/> <!--如果構件有了新的group ID和artifact ID(構件移到了新的位置),這里列出構件的重定位信息。--> <relocation> <!--構件新的group ID--> <groupId/> <!--構件新的artifact ID--> <artifactId/> <!--構件新的版本號--> <version/> <!--顯示給用戶的,關於移動的額外信息,例如原因。--> <message/> </relocation> <!-- 給出該構件在遠程倉庫的狀態。不得在本地項目中設置該元素,因為這是工具自動更新的。有效的值有:none(默認),converted(倉庫管理員從 Maven 1 POM轉換過來),partner(直接從伙伴Maven 2倉庫同步過來),deployed(從Maven 2實例部 署),verified(被核實時正確的和最終的)。--> <status/> </distributionManagement> <!--以值替代名稱,Properties可以在整個POM中使用,也可以作為觸發條件(見settings.xml配置文件里activation元素的說明)。格式是<name>value</name>。--> <properties/> </project>
pom常用節點使用方法
parent
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.6.RELEASE</version> <relativePath>../my-parent</relativePath> </parent>
relativePath是可選的,maven會首先搜索這個地址,在搜索本地遠程repositories之前。parent節點主要是項目集成,項目聚合時使用。參考Spring Boot的pom文件,一般設置packaging為pom模式。構建一個父親項目,可以不編寫代碼邏輯,只是管理多個項目之間公共的依賴。
dependencyManagement
是用於幫助管理chidren的dependencies的,配置在parent項目中。例如如果parent使用dependencyManagement定義了一個dependencyon junit:junit4.0,那么 它的children就可以只引用 groupId和artifactId,而version就可以通過parent來設置,這樣的好處就是可以集中管理依賴的版本。maven的依賴(dependencies)有傳遞性,為了解決兼容性問題,就用exclusions來排除造成兼容性問題的依賴。參考Spring boot的使用方式:
<dependencyManagement> <dependencies> <dependency> <groupId>com.querydsl</groupId> <artifactId>querydsl-mongodb</artifactId> <version>${querydsl.version}</version> <exclusions> <exclusion> <artifactId>mongo-java-driver</artifactId> <groupId>org.mongodb</groupId> </exclusion> </exclusions> </dependency> <dependency> <groupId>com.rabbitmq</groupId> <artifactId>amqp-client</artifactId> <version>${rabbit-amqp-client.version}</version> </dependency> </dependencies> </dependencyManagement>
dependency
dependency下面包含眾多字標簽。
- type:默認為jar類型,常用的類型有:jar,ejb-client,test-jar...,可設置plugins中的extensions值為true后在增加新類型。
- scope:用來指定當前包的依賴范圍
- compile(編譯范圍),是默認的范圍,編譯范圍依賴在所有的classpath中可用,同時它們也會被打包。
- provided(已提供范圍),只有在當JDK或者一個容器已提供該依賴之后才使用。
- runtime(運行時范圍),在運行和測試系統的時候需要。
- test(測試范圍),在一般的 編譯和運行時都不需要。
- system(系統范圍),與provided類似
- optional:設置指依賴是否可選,默認為false,即子項目默認都繼承,為true,則子項目必需顯示的引入,與dependencyManagement里定義的依賴類似 。
- exclusions:如果X需要A,A包含B依賴,那么X可以聲明不要B依賴,只要在exclusions中聲明exclusion。
- exclusion:將B從依賴樹中刪除,如上配置,alibaba.apollo.webx不想使用com.alibaba.external ,但是alibaba.apollo.webx是集成了com.alibaba.external,r所以就需要排除掉。
dependency是用於具體孩子項目的pom文件中,dependency的應用示例:
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> </dependencies>
<!--
表示引入依賴spring-boot-starter,但不用編寫版本,父親節點控制了版本。同時,剔除父親節點的spring-boot-starter-logging日志依賴。-->
modules
在聚合模式下,pom.xml 中下一部分列出了項目的子模塊。這些模塊在modules元素中定義,每個modules 元素對應了一個simple-parent/目錄下的子目錄。Maven知道去這些子目錄尋找pom.xml 文件,並且,在構建的simp-parent 的時候,它會將這些子模塊包含到要構建的項目中。
對於多模塊的project,outer-module沒有必需考慮inner-module的dependencies,當列出modules的時候,modules的順序是不重要的,因為maven會自動根據依賴關系來拓撲排序,上級pom設置packaging為pom模式。modules例子如下 :
<parent> <groupId>com.epet.microservices</groupId> <artifactId>wl-top</artifactId> <version>2.0.7</version> </parent> <artifactId>wl-parent</artifactId> <version>1.0.0-SNAPSHOT</version> <packaging>pom</packaging> <name>wl-parent</name> <url>http://maven.apache.org</url> <modules> <module>common-wl</module> <module>api-wl</module> <module>microservices-wl</module> </modules>
properties
是為pom定義一些常量,在pom中的其它地方可以直接引用。參考Spring Boot中的定義和使用如下:
<properties> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> <resource.delimiter>@</resource.delimiter> <maven.compiler.source>${java.version}</maven.compiler.source> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.target>${java.version}</maven.compiler.target> </properties>
使用方式 如下 :${java.version}
resources
resources描述工程中資源的位置,一般結合profiles標簽,定義在不同的環境下使用不同的資源配置文件。Spring Boot中該標簽的示例如下:
<resources> <resource> <filtering>true</filtering> <directory>${basedir}/src/main/resources</directory> <includes> <include>**/application*.yml</include> <include>**/application*.yaml</include> <include>**/application*.properties</include> </includes> </resource> <resource> <directory>${basedir}/src/main/resources</directory> <excludes> <exclude>**/application*.yml</exclude> <exclude>**/application*.yaml</exclude> <exclude>**/application*.properties</exclude> </excludes> </resource>
</resources>
結合profiles標簽,可去掉相關的基本配置資源文件后,制定使用激活的配置文件。如:<directory>src/main/resources/${profiles.active}</directory>。
子標簽介紹:
- targetPath:指定build資源具體目錄,默認是base directory。
- filtering:指定是否將filter文件的變量值在這個resource文件有效。即上面說的filters里定義的*.property文件。例如上面就指定那些變量值在configuration文件無效,設置為false。
- directory:指定屬性文件的目錄,build的過程需要找到它,並且將其放到targetPath下,默認的directory是${basedir}/src/main/resources。
- testResources:包含測試資源元素。默認的測試資源路徑是${basedir}/src/test/resources,測試資源是不部署的。
include:
指明需要包括的資源:${basedir}/src/main/resources目錄下的,所有application.*文件都需要包括。exclude:
指代不需要處理的資源,僅處理${basedir}/src/main/resources資源目錄中除application.*之外的資源。
profiles
在開發過程中,軟件會面對不同的運行環境,比如開發環境、測試環境、生產環境,而軟件在不同的環境中,有的配置可能會不一樣,比如數據源配置、日志文件配置、以及一些軟件運行過程中的基本配置,那每次將軟件部署到不同的環境時,都需要修改相應的配置文件,這樣來回修改,很容易出錯,而且浪費勞動力。maven提供了一種方便的解決這種問題的方案,就是profile功能。profile可以定義一系列的配置信息,然后指定其激活條件。這樣就可以定義多個profile,然后每個profile對應不同的激活條件和配置信息,從而達到不同環境使用不同配置信息的效果。針對於特定項目的profile配置可以定義在該項目的pom.xml中。使用舉例如:
<profiles> <profile> <!-- 本地開發環境 --> <id>dev</id> <properties> <profiles.active>dev</profiles.active> </properties> <activation> <!-- 設置默認激活這個配置 --> <activeByDefault>true</activeByDefault> </activation> </profile> <profile> <!-- 發布環境 --> <id>release</id> <properties> <profiles.active>release</profiles.active> </properties> </profile> <profile> <!-- 測試環境 --> <id>beta</id> <properties> <profiles.active>beta</profiles.active> </properties> </profile> </profiles>
配置好profiles文件后,設置filtering為true,表示允許覆蓋。在項目發布時,可通過Maven命令制定激活哪一個具體的配置文件,命令為:maven package -P dev-Dmaven.test.skip=true
<resource> <directory>src/main/resources/${profiles.active}</directory> <!-- 默認delimiter變成了@ --> <filtering>true</filtering> </resource>
pluginManagement
pluginManagement是表示插件聲明,即你在項目中的pluginManagement下聲明了插件,Maven不會加載該插件,pluginManagement聲明可以被繼承。pluginManagement節點必須放在bulid節點下面。一般是用來在父POM中定義,提供給子POM使用,子POM也可以覆蓋這個定義,而且在父POM中定義了版本之后,子模塊中直接應用。groupId和artifactId,而不用指定版本,同時也方便統一管理;而在父POM中的pluginManagement並不會介入到Maven的生命周期。plugins
和 pluginManagement
的區別,類似 dependencies
和 dependencyManagement
的區別。plugins
下的 plugin
是真實使用的,而 pluginManagement
下的 plugins
下的 plugin
則僅僅是一種聲明,子項目中可以對 pluginManagement
下的 plugin
進行信息的選擇、繼承、覆蓋等。Spring Boot中pluginManagement的應用舉例如下:
<pluginManagement> <plugins> <plugin> <groupId>org.apache.johnzon</groupId> <artifactId>johnzon-maven-plugin</artifactId> <version>${johnzon.version}</version> </plugin> <plugin> <groupId>org.jetbrains.kotlin</groupId> <artifactId>kotlin-maven-plugin</artifactId> <version>${kotlin.version}</version> </plugin> </plugins> </pluginManagement>
plugins
plugins就是直接引入一個plugin,而且可以綁定到Maven相關的生命周期上。該標簽必須放在bulid標簽中,使用舉例如下:
<plugins> <plugin> <artifactId>maven-source-plugin</artifactId> <executions> <execution> <id>attach-sources</id> <phase>package</phase> <goals> <goal>jar-no-fork</goal> </goals> </execution> </executions> </plugin> <!-- versions --> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>versions-maven-plugin</artifactId> </plugin> </plugins>
distributionManagement
<distributionManagement>的作用: 負責管理構件的發布。這是一個環境變量 。一般用於將本地的生成的包上傳到遠程私服上去。 <distributionManagement>中的<repository>標簽:
- <uniqueVersion>指定是否產生一個唯一性的version number還是使用address里的其中version部分.(true or false) 。其中標簽id的值與本地Maven配置文件seting.xml中設置的遠程私服的id一樣。
- <id> 庫的id
- <name> 庫的名稱
- <url> 庫的url
- <layout> default或者legacy
<distributionManagement> 中的 <repository> && <snapshotsrepository>各自的含義:maven倉庫分為兩種 release發布倉庫(<repository>) 和 snapshot快照倉庫(<snapshotsrepository>),snapshot快照倉庫用於保存開發過程中的不穩定版本,release正式倉庫用來保存穩定的發行版本。定義一個組件/模塊為快照版本只需要在pom文件中的該模板的版本號后面加上 -SNAPSHOT就可以了。 注意:必須是大寫maven會根據模塊的版本號(pom文件中的<version>版本號</version>)中是否帶有-SNAPSHOT來判斷這個是快照版本還是正式版本.。可通過maven命令:mvn clean deploy。
<distributionManagement> <repository> <uniqueVersion>false</uniqueVersion> <id>corp1</id> <name>Corporate Repository</name> <url>scp://repo/maven2</url> <layout>default</layout> </repository> <snapshotRepository> <uniqueVersion>true</uniqueVersion> <id>propSnap</id> <name>Propellors Snapshots</name> <url>sftp://propellers.net/maven</url> <layout>legacy</layout> </snapshotRepository> </distributionManagement>
mvn打包命令
- mvn clean package依次執行了clean、resources、compile、testResources、testCompile、test、jar(打包)等7個階段。
- mvn clean install依次執行了clean、resources、compile、testResources、testCompile、test、jar(打包)、install等8個階段。
- mvn clean deploy依次執行了clean、resources、compile、testResources、testCompile、test、jar(打包)、install、deploy等9個階段。
由上面的分析可知主要區別如下,
- package命令完成了項目編譯、單元測試、打包功能,但沒有把打好的可執行jar包(war包或其它形式的包)布署到本地maven倉庫和遠程maven私服倉庫。
- install命令完成了項目編譯、單元測試、打包功能,同時把打好的可執行jar包(war包或其它形式的包)布署到本地maven倉庫,但沒有布署到遠程maven私服倉庫。
- deploy命令完成了項目編譯、單元測試、打包功能,同時把打好的可執行jar包(war包或其它形式的包)布署到本地maven倉庫和遠程maven私服倉庫。
build
- defaultGoal :默認的目標,必須跟命令行上的參數相同,如:jar:jar,或者與時期parse相同,例如install。
- directory:指定build target目標的目錄,默認為$(basedir}/target,即項目根目錄下的target。
- finalName:指定去掉后綴的工程名字,例如:默認為${artifactId}-${version}。
- filters:定義指定filter屬性的位置,例如filter元素賦值filters/filter1.properties,那么這個文件里面就可以定義name=value對,這個name=value對的值就可以在工程pom中通過${name}引用,默認的filter目錄是${basedir}/src/main/fiters/。
reporting設置
reporting包含site生成階段的一些元素,某些maven plugin可以生成reports並且在reporting下配置。reporting里面的reportSets和build里面的executions的作用都是控制pom的不同粒度去控制build的過程,我們不單要配置plugins,還要配置那些plugins單獨的goals。樣例如下:
<reporting> <plugins> <plugin> ... <reportSets> <reportSet> <id>sunlink</id> <reports> <report>javadoc</report> </reports> <inherited>true</inherited> <configuration> <links> <link>http://java.sun.com/j2se/1.5.0/docs/api/</link> </links> </configuration> </reportSet> </reportSets> </plugin> </plugins> </reporting>
參考網址
- pom.xml參考網址:https://www.cnblogs.com/wkrbky/p/6353285.html
- pom.xml文件示例:https://cloud.tencent.com/developer/article/1328093
- Maven-dependencyManagement的使用:https://www.jianshu.com/p/e867ac845e11
- Maven properities:https://www.jianshu.com/p/82233bdc917c
- Maven module:https://blog.csdn.net/T2080305/article/details/80545880
- Maven profile動態配置文件:https://www.cnblogs.com/0201zcr/p/6262762.html
- Maven學習<distributionManagement>:https://www.cnblogs.com/liu2-/p/9035181.html
- Maven學習<distributionManagement>:https://blog.csdn.net/taiyangdao/article/details/52389790
- nexus建立maven倉庫私服:https://www.cnblogs.com/zhongshengzhen/p/nexus_maven.html
- pom.xml文件:https://www.cnblogs.com/hyhnet/p/7956197.html