一舱禽、概述
Maven是 Apache 下的一個(gè)純 Java 開(kāi)發(fā)的開(kāi)源項(xiàng)目避凝∥杼眩基于項(xiàng)目對(duì)象模型(縮寫(xiě):POM)概念眨补,Maven利用一個(gè)中央信息片斷能管理一個(gè)項(xiàng)目的構(gòu)建、報(bào)告和文檔等步驟倒脓。
Maven 是一個(gè)項(xiàng)目管理工具撑螺,可以對(duì) Java 項(xiàng)目進(jìn)行構(gòu)建、依賴管理崎弃。
Maven 也可被用于構(gòu)建和管理各種項(xiàng)目甘晤,例如 C#,Ruby饲做,Scala 和其他語(yǔ)言編寫(xiě)的項(xiàng)目安皱。Maven 曾是 Jakarta 項(xiàng)目的子項(xiàng)目,現(xiàn)為由 Apache 軟件基金會(huì)主持的獨(dú)立 Apache 項(xiàng)目艇炎。
1酌伊、Maven功能
Maven 能夠幫助開(kāi)發(fā)者完成以下工作:
- 構(gòu)建
- 文檔生成
- 報(bào)告
- 依賴
- SCMs
- 發(fā)布
- 分發(fā)
- 郵件列表
2、約定配置
Maven 提倡使用一個(gè)共同的標(biāo)準(zhǔn)目錄結(jié)構(gòu)缀踪,Maven 使用約定優(yōu)于配置的原則居砖,大家盡可能的遵守這樣的目錄結(jié)構(gòu)。如下所示:
目錄 | 目的 |
---|---|
${basedir} | 存放pom.xml和所有的子目錄 |
${basedir}/src/main/java | 項(xiàng)目的java源代碼 |
${basedir}/src/main/resources. | 項(xiàng)目的資源驴娃,比如說(shuō)property文件奏候,springmvc.xml. |
${basedir}/src/test/java | 項(xiàng)目的測(cè)試類,比如說(shuō)Junit代碼 |
${basedir}/src/test/resources | 測(cè)試用的資源 |
${basedir}/src/main/webapp/WEB-INF | web應(yīng)用文件目錄唇敞,web項(xiàng)目的信息蔗草,比如存放web.xml、本地圖片疆柔、jsp視圖頁(yè)面 |
${basedir}/target | 打包輸出目錄 |
${basedir}/target/classes | 編譯輸出目錄 |
${basedir}/target/test-classes | 測(cè)試編譯輸出目錄 |
Test.java | Maven只會(huì)自動(dòng)運(yùn)行符合該命名規(guī)則的測(cè)試類 |
~/.m2/repository | Maven默認(rèn)的本地倉(cāng)庫(kù)目錄位置 |
3咒精、Maven 特點(diǎn)
項(xiàng)目設(shè)置遵循統(tǒng)一的規(guī)則。
任意工程中共享旷档。
依賴管理包括自動(dòng)更新模叙。
一個(gè)龐大且不斷增長(zhǎng)的庫(kù)。
可擴(kuò)展鞋屈,能夠輕松編寫(xiě) Java 或腳本語(yǔ)言的插件范咨。
只需很少或不需要額外配置即可即時(shí)訪問(wèn)新功能。
基于模型的構(gòu)建 ? Maven能夠?qū)⑷我鈹?shù)量的項(xiàng)目構(gòu)建到預(yù)定義的輸出類型中厂庇,如 JAR渠啊,WAR 或基于項(xiàng)目元數(shù)據(jù)的分發(fā),而不需要在大多數(shù)情況下執(zhí)行任何腳本权旷。
項(xiàng)目信息的一致性站點(diǎn) ? 使用與構(gòu)建過(guò)程相同的元數(shù)據(jù)替蛉,Maven 能夠生成一個(gè)網(wǎng)站或PDF,包括您要添加的任何文檔,并添加到關(guān)于項(xiàng)目開(kāi)發(fā)狀態(tài)的標(biāo)準(zhǔn)報(bào)告中灭返。
發(fā)布管理和發(fā)布單獨(dú)的輸出 ? Maven 將不需要額外的配置盗迟,就可以與源代碼管理系統(tǒng)(如 Subversion 或 Git)集成,并可以基于某個(gè)標(biāo)簽管理項(xiàng)目的發(fā)布熙含。它也可以將其發(fā)布到分發(fā)位置供其他項(xiàng)目使用罚缕。Maven 能夠發(fā)布單獨(dú)的輸出,如 JAR怎静,包含其他依賴和文檔的歸檔邮弹,或者作為源代碼發(fā)布。
向后兼容性 ? 您可以很輕松的從舊版本 Maven 的多個(gè)模塊移植到 Maven 3 中蚓聘。
子項(xiàng)目使用父項(xiàng)目依賴時(shí)腌乡,正常情況子項(xiàng)目應(yīng)該繼承父項(xiàng)目依賴,無(wú)需使用版本號(hào)夜牡,
并行構(gòu)建 ? 編譯的速度能普遍提高20 - 50 %与纽。
更好的錯(cuò)誤報(bào)告 ? Maven 改進(jìn)了錯(cuò)誤報(bào)告,它為您提供了 Maven wiki 頁(yè)面的鏈接塘装,您可以點(diǎn)擊鏈接查看錯(cuò)誤的完整描述急迂。
二、POM詳解
POM(Project Object Model蹦肴, 項(xiàng)目對(duì)象模型)是Maven工程的基本工作單元僚碎,是一個(gè)XML文件, 包含了項(xiàng)目的基本信息阴幌, 用于描述項(xiàng)目如何構(gòu)建勺阐、聲明項(xiàng)目依賴等。執(zhí)行任務(wù)或目標(biāo)時(shí)矛双, Maven會(huì)從項(xiàng)目中尋找POM渊抽。它讀取POM,獲取所需的配置信息,然后執(zhí)行目標(biāo)背零。
POM中可以指定以下配置:
- 項(xiàng)目依賴
- 插件
- 執(zhí)行目標(biāo)
- 項(xiàng)目構(gòu)建Profile
- 版本信息
- 項(xiàng)目開(kāi)發(fā)者列表
- 相關(guān)郵件列表等信息
等等腰吟。
2.1无埃、POM文件格式
POM文件的格式由Maven的XSD文件定義徙瓶, 如[maven-4.0.0.xsd](http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd):
<?xml version="1.0" encoding="UTF-8"?>
<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">
<!--父項(xiàng)目的坐標(biāo)。如果項(xiàng)目中沒(méi)有規(guī)定某個(gè)元素的值嫉称,那么父項(xiàng)目中的對(duì)應(yīng)值即為項(xiàng)目的默認(rèn)值侦镇。坐標(biāo)包括group ID,artifact ID和version织阅。 -->
<parent>
<!--被繼承的父項(xiàng)目的構(gòu)件標(biāo)識(shí)符 -->
<artifactId>good-java</artifactId>
<!--被繼承的父項(xiàng)目的全球唯一標(biāo)識(shí)符 -->
<groupId>org.example</groupId>
<!--被繼承的父項(xiàng)目的版本 -->
<version>1.0-SNAPSHOT</version>
<!-- 父項(xiàng)目的pom.xml文件的相對(duì)路徑壳繁。相對(duì)路徑允許你選擇一個(gè)不同的路徑。默認(rèn)值是../pom.xml。Maven首先在構(gòu)建當(dāng)前項(xiàng)目的地方尋找父項(xiàng)
目的pom闹炉,其次在文件系統(tǒng)的這個(gè)位置(relativePath位置)蒿赢,然后在本地倉(cāng)庫(kù),最后在遠(yuǎn)程倉(cāng)庫(kù)尋找父項(xiàng)目的pom渣触。 -->
<relativePath />
</parent>
<!--聲明項(xiàng)目描述符遵循哪一個(gè)POM模型版本羡棵。模型本身的版本很少改變,雖然如此嗅钻,但它仍然是必不可少的皂冰,這是為了當(dāng)Maven引入了新的特性或者其他模型變更的時(shí)候,確保穩(wěn)定性养篓。 -->
<modelVersion>4.0.0</modelVersion>
<!--項(xiàng)目的全球唯一標(biāo)識(shí)符秃流,通常使用全限定的包名區(qū)分該項(xiàng)目和其他項(xiàng)目。并且構(gòu)建時(shí)生成的路徑也是由此生成柳弄, 如com.mycompany.app生成的相對(duì)路徑為:/com/mycompany/app -->
<groupId>org.example</groupId>
<!-- 構(gòu)件的標(biāo)識(shí)符舶胀,它和group ID一起唯一標(biāo)識(shí)一個(gè)構(gòu)件。換句話說(shuō)碧注,你不能有兩個(gè)不同的項(xiàng)目擁有同樣的artifact ID和groupID峻贮;在某個(gè)
特定的group ID下,artifact ID也必須是唯一的应闯。構(gòu)件是項(xiàng)目產(chǎn)生的或使用的一個(gè)東西纤控,Maven為項(xiàng)目產(chǎn)生的構(gòu)件包括:JARs,源 碼碉纺,二進(jìn)制發(fā)布和WARs等船万。 -->
<artifactId>good-java-spring</artifactId>
<!--項(xiàng)目產(chǎn)生的構(gòu)件類型,例如jar骨田、war耿导、ear、pom态贤。插件可以創(chuàng)建他們自己的構(gòu)件類型舱呻,所以前面列的不是全部構(gòu)件類型 -->
<packaging>jar</packaging>
<!--項(xiàng)目當(dāng)前版本,格式為:主版本.次版本.增量版本-限定版本號(hào) -->
<version>1.0-SNAPSHOT</version>
<!--項(xiàng)目的名稱, Maven產(chǎn)生的文檔用 -->
<name>good-java-spring</name>
<!--項(xiàng)目主頁(yè)的URL, Maven產(chǎn)生的文檔用 -->
<url>http://www.baidu.com/dipper</url>
<!-- 項(xiàng)目的詳細(xì)描述, Maven 產(chǎn)生的文檔用悠汽。 當(dāng)這個(gè)元素能夠用HTML格式描述時(shí)(例如箱吕,CDATA中的文本會(huì)被解析器忽略,就可以包含HTML標(biāo)
簽)柿冲, 不鼓勵(lì)使用純文本描述茬高。如果你需要修改產(chǎn)生的web站點(diǎn)的索引頁(yè)面,你應(yīng)該修改你自己的索引頁(yè)文件假抄,而不是調(diào)整這里的文檔怎栽。 -->
<description>項(xiàng)目描述信息</description>
<!--以值替代名稱丽猬,Properties可以在整個(gè)POM中使用,也可以作為觸發(fā)條件(見(jiàn)settings.xml配置文件里activation元素的說(shuō)明)熏瞄。格式是<name>value</name>脚祟。 -->
<properties>
<maven.compiler.version>8</maven.compiler.version>
</properties>
<!--描述了這個(gè)項(xiàng)目構(gòu)建環(huán)境中的前提條件。 -->
<prerequisites>
<!--構(gòu)建該項(xiàng)目或使用該插件所需要的Maven的最低版本 -->
<maven />
</prerequisites>
<!--項(xiàng)目的問(wèn)題管理系統(tǒng)(Bugzilla, Jira, Scarab,或任何你喜歡的問(wèn)題管理系統(tǒng))的名稱和URL强饮,本例為 jira -->
<issueManagement>
<!--問(wèn)題管理系統(tǒng)(例如jira)的名字愚铡, -->
<system>jira</system>
<!--該項(xiàng)目使用的問(wèn)題管理系統(tǒng)的URL -->
<url>http://jira.baidu.com/dipper</url>
</issueManagement>
<!--項(xiàng)目持續(xù)集成信息 -->
<ciManagement>
<!--持續(xù)集成系統(tǒng)的名字,例如continuum -->
<system>ci</system>
<!--該項(xiàng)目使用的持續(xù)集成系統(tǒng)的URL(如果持續(xù)集成系統(tǒng)有web接口的話)胡陪。 -->
<url>http://127.0.0.1:8080/</url>
<!--構(gòu)建完成時(shí)沥寥,需要通知的開(kāi)發(fā)者/用戶的配置項(xiàng)。包括被通知者信息和通知條件(錯(cuò)誤柠座,失敗邑雅,成功,警告) -->
<notifiers>
<!--配置一種方式妈经,當(dāng)構(gòu)建中斷時(shí)淮野,以該方式通知用戶/開(kāi)發(fā)者 -->
<notifier>
<!--傳送通知的途徑 -->
<type>mail</type>
<!--發(fā)生錯(cuò)誤時(shí)是否通知 -->
<sendOnError>true</sendOnError>
<!--構(gòu)建失敗時(shí)是否通知 -->
<sendOnFailure>true</sendOnFailure>
<!--構(gòu)建成功時(shí)是否通知 -->
<sendOnSuccess>false</sendOnSuccess>
<!--發(fā)生警告時(shí)是否通知 -->
<sendOnWarning>false</sendOnWarning>
<!--不贊成使用。通知發(fā)送到哪里 -->
<address/>
<!--擴(kuò)展配置項(xiàng) -->
<configuration>
<message.prefix>test</message.prefix>
</configuration>
</notifier>
</notifiers>
</ciManagement>
<!--項(xiàng)目創(chuàng)建年份吹泡,4位數(shù)字骤星。當(dāng)產(chǎn)生版權(quán)信息時(shí)需要使用這個(gè)值。 -->
<inceptionYear>2021</inceptionYear>
<!--項(xiàng)目相關(guān)郵件列表信息 -->
<mailingLists>
<!--該元素描述了項(xiàng)目相關(guān)的所有郵件列表爆哑。自動(dòng)產(chǎn)生的網(wǎng)站引用這些信息洞难。 -->
<mailingList>
<!--郵件的名稱 -->
<name>Demo</name>
<!--發(fā)送郵件的地址或鏈接,如果是郵件地址揭朝,創(chuàng)建文檔時(shí)队贱,mailto: 鏈接會(huì)被自動(dòng)創(chuàng)建 -->
<post>test@126.com</post>
<!--訂閱郵件的地址或鏈接,如果是郵件地址潭袱,創(chuàng)建文檔時(shí)柱嫌,mailto: 鏈接會(huì)被自動(dòng)創(chuàng)建 -->
<subscribe>test@126.com</subscribe>
<!--取消訂閱郵件的地址或鏈接,如果是郵件地址屯换,創(chuàng)建文檔時(shí)编丘,mailto: 鏈接會(huì)被自動(dòng)創(chuàng)建 -->
<unsubscribe>test@126.com</unsubscribe>
<!--你可以瀏覽郵件信息的URL -->
<archive>http:/hi.baidu.com/test/demo/dev/</archive>
</mailingList>
</mailingLists>
<!--項(xiàng)目開(kāi)發(fā)者列表 -->
<developers>
<!--某個(gè)項(xiàng)目開(kāi)發(fā)者的信息 -->
<developer>
<!--SCM里項(xiàng)目開(kāi)發(fā)者的唯一標(biāo)識(shí)符 -->
<id>dipper</id>
<!--項(xiàng)目開(kāi)發(fā)者的全名 -->
<name>skyeye</name>
<!--項(xiàng)目開(kāi)發(fā)者的email -->
<email>skyeye@126.com</email>
<!--項(xiàng)目開(kāi)發(fā)者的主頁(yè)的URL -->
<url/>
<!--項(xiàng)目開(kāi)發(fā)者在項(xiàng)目中扮演的角色,角色元素描述了各種角色 -->
<roles>
<role>Project Manager</role>
<role>Architect</role>
</roles>
<!--項(xiàng)目開(kāi)發(fā)者所屬組織 -->
<organization>demo</organization>
<!--項(xiàng)目開(kāi)發(fā)者所屬組織的URL -->
<organizationUrl>http://hi.baidu.com/dipper</organizationUrl>
<!--項(xiàng)目開(kāi)發(fā)者屬性彤悔,如即時(shí)消息如何處理等 -->
<properties>
<dept>No</dept>
</properties>
<!--項(xiàng)目開(kāi)發(fā)者所在時(shí)區(qū)嘉抓, -11到12范圍內(nèi)的整數(shù)。 -->
<timezone>-5</timezone>
</developer>
</developers>
<!--項(xiàng)目的其他貢獻(xiàn)者列表 -->
<contributors>
<!--項(xiàng)目的其他貢獻(xiàn)者蜗巧。參見(jiàn)developers/developer元素 -->
<contributor>
<name>none</name>
<email>none@163.com</email>
<url>http://www.baidu.com/none</url>
<organization>none</organization>
<organizationUrl/>
<roles/>
<timezone/>
<properties/>
</contributor>
</contributors>
<!--該元素描述了項(xiàng)目所有License列表掌眠。 應(yīng)該只列出該項(xiàng)目的license列表,不要列出依賴項(xiàng)目的 license列表幕屹。如果列出多個(gè)license蓝丙,用戶可以選擇它們中的一個(gè)而不是接受所有l(wèi)icense。 -->
<licenses>
<!--描述了項(xiàng)目的license望拖,用于生成項(xiàng)目的web站點(diǎn)的license頁(yè)面渺尘,其他一些報(bào)表和validation也會(huì)用到該元素。 -->
<license>
<!--license用于法律上的名稱 -->
<name>Apache 2</name>
<!--官方的license正文頁(yè)面的URL -->
<url>http://www.baidu.com/dipper/LICENSE-2.0.txt</url>
<!--項(xiàng)目分發(fā)的主要方式: repo说敏,可以從Maven庫(kù)下載 manual: 用戶必須手動(dòng)下載和安裝依賴 -->
<distribution>repo</distribution>
<!--關(guān)于license的補(bǔ)充信息 -->
<comments>A business-friendly OSS license</comments>
</license>
</licenses>
<!--SCM(Source Control Management)標(biāo)簽允許你配置你的代碼庫(kù)鸥跟,供Maven web站點(diǎn)和其它插件使用。 -->
<scm>
<!--SCM的URL,該URL描述了版本庫(kù)和如何連接到版本庫(kù)盔沫。欲知詳情医咨,請(qǐng)看SCMs提供的URL格式和列表。該連接只讀架诞。 -->
<connection>
scm:svn:http://svn.baidu.com/dipper/maven/dipper/dipper-maven2-trunk(dao-trunk)
</connection>
<!--給開(kāi)發(fā)者使用的拟淮,類似connection元素。即該連接不僅僅只讀 -->
<developerConnection>
scm:svn:http://svn.baidu.com/dipper/maven/dipper/dao-trunk
</developerConnection>
<!--當(dāng)前代碼的標(biāo)簽谴忧,在開(kāi)發(fā)階段默認(rèn)為HEAD -->
<tag/>
<!--指向項(xiàng)目的可瀏覽SCM庫(kù)(例如ViewVC或者Fisheye)的URL很泊。 -->
<url>http://svn.baidu.com/dipper</url>
</scm>
<!--描述項(xiàng)目所屬組織的各種屬性。Maven產(chǎn)生的文檔用 -->
<organization>
<!--組織的全名 -->
<name>demo</name>
<!--組織主頁(yè)的URL -->
<url>http://www.baidu.com/dipper</url>
</organization>
<!--在列的項(xiàng)目構(gòu)建profile沾谓,如果被激活委造,會(huì)修改構(gòu)建處理 -->
<profiles>
<!--根據(jù)環(huán)境參數(shù)或命令行參數(shù)激活某個(gè)構(gòu)建處理 -->
<profile>
<!--構(gòu)建配置的唯一標(biāo)識(shí)符。即用于命令行激活均驶,也用于在繼承時(shí)合并具有相同標(biāo)識(shí)符的profile昏兆。 -->
<id>prod</id>
<!--自動(dòng)觸發(fā)profile的條件邏輯。Activation是profile的開(kāi)啟鑰匙妇穴。profile的力量來(lái)自于它 能夠在某些特定的環(huán)境中自動(dòng)使用某些特定的值亮垫;這些環(huán)境通過(guò)activation元素指定。activation元素并不是激活profile的唯一方式伟骨。 -->
<activation>
<!--profile默認(rèn)是否激活的標(biāo)志 -->
<activeByDefault>true</activeByDefault>
<!--當(dāng)匹配的jdk被檢測(cè)到饮潦,profile被激活。例如携狭,1.4激活JDK1.4继蜡,1.4.0_2,而!1.4激活所有版本不是以1.4開(kāi)頭的JDK逛腿。 -->
<jdk/>
<!--當(dāng)匹配的操作系統(tǒng)屬性被檢測(cè)到稀并,profile被激活。os元素可以定義一些操作系統(tǒng)相關(guān)的屬性单默。 -->
<os>
<!--激活profile的操作系統(tǒng)的名字 -->
<name>Windows XP</name>
<!--激活profile的操作系統(tǒng)所屬家族(如 'windows') -->
<family>Windows</family>
<!--激活profile的操作系統(tǒng)體系結(jié)構(gòu) -->
<arch>x86</arch>
<!--激活profile的操作系統(tǒng)版本 -->
<version>5.1.2600</version>
</os>
<!--如果Maven檢測(cè)到某一個(gè)屬性(其值可以在POM中通過(guò)${名稱}引用)碘举,其擁有對(duì)應(yīng)的名稱和值,Profile就會(huì)被激活搁廓。如果值 字段是空的引颈,那么存在屬性名稱字段就會(huì)激活profile耕皮,否則按區(qū)分大小寫(xiě)方式匹配屬性值字段 -->
<property>
<!--激活profile的屬性的名稱 -->
<name>mavenVersion</name>
<!--激活profile的屬性的值 -->
<value>2.0.3</value>
</property>
<!--提供一個(gè)文件名,通過(guò)檢測(cè)該文件的存在或不存在來(lái)激活profile蝙场。missing檢查文件是否存在凌停,如果不存在則激活 profile。另一方面售滤,exists則會(huì)檢查文件是否存在罚拟,如果存在則激活profile。 -->
<file>
<!--如果指定的文件存在完箩,則激活profile赐俗。 -->
<exists>/usr/local/test</exists>
<!--如果指定的文件不存在,則激活profile弊知。 -->
<missing>/usr/local/test</missing>
</file>
</activation>
<!--構(gòu)建項(xiàng)目所需要的信息阻逮。參見(jiàn)build元素 -->
<build>
</build>
<!--模塊(有時(shí)稱作子項(xiàng)目) 被構(gòu)建成項(xiàng)目的一部分。列出的每個(gè)模塊元素是指向該模塊的目錄的相對(duì)路徑 -->
<modules/>
<!--發(fā)現(xiàn)依賴和擴(kuò)展的遠(yuǎn)程倉(cāng)庫(kù)列表吉捶。 -->
<repositories>
</repositories>
<!--發(fā)現(xiàn)插件的遠(yuǎn)程倉(cāng)庫(kù)列表夺鲜,這些插件用于構(gòu)建和報(bào)表 -->
<pluginRepositories>
</pluginRepositories>
<!--該元素描述了項(xiàng)目相關(guān)的所有依賴。 這些依賴組成了項(xiàng)目構(gòu)建過(guò)程中的一個(gè)個(gè)環(huán)節(jié)呐舔。它們自動(dòng)從項(xiàng)目定義的倉(cāng)庫(kù)中下載币励。要獲取更多信息,請(qǐng)看項(xiàng)目依賴機(jī)制珊拼。 -->
<dependencies>
</dependencies>
<!--不贊成使用. 現(xiàn)在Maven忽略該元素. -->
<reports />
<!--該元素包括使用報(bào)表插件產(chǎn)生報(bào)表的規(guī)范食呻。當(dāng)用戶執(zhí)行"mvn site",這些報(bào)表就會(huì)運(yùn)行澎现。 在頁(yè)面導(dǎo)航欄能看到所有報(bào)表的鏈接仅胞。參見(jiàn)reporting元素 -->
<reporting>
</reporting>
<!--參見(jiàn)dependencyManagement元素 -->
<dependencyManagement>
</dependencyManagement>
<!--參見(jiàn)distributionManagement元素 -->
<distributionManagement>
</distributionManagement>
<!--參見(jiàn)properties元素 -->
<properties />
</profile>
</profiles>
<!--構(gòu)建項(xiàng)目需要的信息 -->
<build>
<!--該元素設(shè)置了項(xiàng)目源碼目錄,當(dāng)構(gòu)建項(xiàng)目的時(shí)候剑辫,構(gòu)建系統(tǒng)會(huì)編譯目錄里的源碼干旧。該路徑是相對(duì)于pom.xml的相對(duì)路徑。 -->
<sourceDirectory>/src/main/java</sourceDirectory>
<!--該元素設(shè)置了項(xiàng)目腳本源碼目錄妹蔽,該目錄和源碼目錄不同:絕大多數(shù)情況下椎眯,該目錄下的內(nèi)容 會(huì)被拷貝到輸出目錄(因?yàn)槟_本是被解釋的,而不是被編譯的)胳岂。 -->
<scriptSourceDirectory>/src/main/java</scriptSourceDirectory>
<!--該元素設(shè)置了項(xiàng)目單元測(cè)試使用的源碼目錄编整,當(dāng)測(cè)試項(xiàng)目的時(shí)候,構(gòu)建系統(tǒng)會(huì)編譯目錄里的源碼乳丰。該路徑是相對(duì)于pom.xml的相對(duì)路徑掌测。 -->
<testSourceDirectory>/src/test/java</testSourceDirectory>
<!--被編譯過(guò)的應(yīng)用程序class文件存放的目錄。 -->
<outputDirectory>/target</outputDirectory>
<!--被編譯過(guò)的測(cè)試class文件存放的目錄产园。 -->
<testOutputDirectory>/target/test</testOutputDirectory>
<!--使用來(lái)自該項(xiàng)目的一系列構(gòu)建擴(kuò)展 -->
<extensions>
<!--描述使用到的構(gòu)建擴(kuò)展汞斧。 -->
<extension>
<!--構(gòu)建擴(kuò)展的groupId -->
<groupId>org.example</groupId>
<!--構(gòu)建擴(kuò)展的artifactId -->
<artifactId>good-java-annotation</artifactId>
<!--構(gòu)建擴(kuò)展的版本 -->
<version>1.0-SNAPSHOT</version>
</extension>
</extensions>
<!--當(dāng)項(xiàng)目沒(méi)有規(guī)定目標(biāo)(Maven2 叫做階段)時(shí)的默認(rèn)值 -->
<defaultGoal>test-compile</defaultGoal>
<!--這個(gè)元素描述了項(xiàng)目相關(guān)的所有資源路徑列表夜郁,例如和項(xiàng)目相關(guān)的屬性文件,這些資源被包含在最終的打包文件里断箫。 -->
<resources>
<!--這個(gè)元素描述了項(xiàng)目相關(guān)或測(cè)試相關(guān)的所有資源路徑 -->
<resource>
<!-- 描述了資源的目標(biāo)路徑拂酣。該路徑相對(duì)target/classes目錄(例如${project.build.outputDirectory})秋冰。舉個(gè)例
子仲义,如果你想資源在特定的包里(org.apache.maven.messages),你就必須該元素設(shè)置為org/apache/maven /messages剑勾。然而埃撵,如果你只是想把資源放到源碼目錄結(jié)構(gòu)里,就不需要該配置虽另。 -->
<targetPath>config</targetPath>
<!--是否使用參數(shù)值代替參數(shù)名暂刘。參數(shù)值取自properties元素或者文件里配置的屬性,文件在filters元素里列出捂刺。 -->
<filtering>true</filtering>
<!--描述存放資源的目錄谣拣,該路徑相對(duì)POM路徑 -->
<directory>/profile/${profile.id}</directory>
<!--包含的模式列表,例如**/*.xml. -->
<includes>
<include>*</include>
</includes>
<!--排除的模式列表族展,例如**/*.xml -->
<excludes>
<exclude>*.bak</exclude>
</excludes>
</resource>
</resources>
<!--這個(gè)元素描述了單元測(cè)試相關(guān)的所有資源路徑森缠,例如和單元測(cè)試相關(guān)的屬性文件。 -->
<testResources>
<!--這個(gè)元素描述了測(cè)試相關(guān)的所有資源路徑仪缸,參見(jiàn) build/resources/resource元素的說(shuō)明 -->
<testResource>
</testResource>
</testResources>
<!--構(gòu)建產(chǎn)生的所有文件存放的目錄 -->
<directory>/target</directory>
<!--產(chǎn)生的構(gòu)件的文件名贵涵,默認(rèn)值是${artifactId}-${version}。 -->
<finalName>${artifactId}</finalName>
<!--當(dāng)filtering開(kāi)關(guān)打開(kāi)時(shí)恰画,使用到的過(guò)濾器屬性文件列表 -->
<filters>
<filter>/profile/${profile.id}</filter>
</filters>
<!--子項(xiàng)目可以引用的默認(rèn)插件信息宾茂。該插件配置項(xiàng)直到被引用時(shí)才會(huì)被解析或綁定到生命周期。給定插件的任何本地配置都會(huì)覆蓋這里的配置 -->
<pluginManagement>
<!--使用的插件列表 拴还。 -->
<plugins>
<!--plugin元素包含描述插件所需要的信息跨晴。 -->
<plugin>
<!--插件在倉(cāng)庫(kù)里的group ID -->
<groupId>org.apache.maven.plugins</groupId>
<!--插件在倉(cāng)庫(kù)里的artifact ID -->
<artifactId >maven-compiler-plugin</artifactId>
<!--被使用的插件的版本(或版本范圍) -->
<version >3.8.1</version>
<!--是否從該插件下載Maven擴(kuò)展(例如打包和類型處理器),由于性能原因片林,只有在真需要下載時(shí)端盆,該元素才被設(shè)置成enabled。 -->
<extensions>true</extensions>
<!--在構(gòu)建生命周期中執(zhí)行一組目標(biāo)的配置拇厢。每個(gè)目標(biāo)可能有不同的配置爱谁。 -->
<executions>
<!--execution元素包含了插件執(zhí)行需要的信息 -->
<execution>
<!--執(zhí)行目標(biāo)的標(biāo)識(shí)符,用于標(biāo)識(shí)構(gòu)建過(guò)程中的目標(biāo)孝偎,或者匹配繼承過(guò)程中需要合并的執(zhí)行目標(biāo) -->
<id>default</id>
<!--綁定了目標(biāo)的構(gòu)建生命周期階段访敌,如果省略,目標(biāo)會(huì)被綁定到源數(shù)據(jù)里配置的默認(rèn)階段 -->
<phase>compile</phase>
<!--配置的執(zhí)行目標(biāo) -->
<goals/>
<!--配置是否被傳播到子POM -->
<inherited>true</inherited>
<!--作為DOM對(duì)象的配置 -->
<configuration>
<test>test</test>
</configuration>
</execution>
</executions>
<!--項(xiàng)目引入插件所需要的額外依賴 -->
<dependencies>
<!--參見(jiàn)dependencies/dependency元素 -->
<dependency>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
</dependency>
</dependencies>
<!--任何配置是否被傳播到子項(xiàng)目 -->
<inherited>true</inherited>
<goals/>
<!--作為DOM對(duì)象的配置 -->
<configuration/>
</plugin>
</plugins>
</pluginManagement>
<!--使用的插件列表 -->
<plugins>
<!--參見(jiàn)build/pluginManagement/plugins/plugin元素 -->
<plugin>
<!--插件在倉(cāng)庫(kù)里的group ID -->
<groupId>org.apache.maven.plugins</groupId>
<!--插件在倉(cāng)庫(kù)里的artifact ID -->
<artifactId >maven-compiler-plugin</artifactId>
<!--被使用的插件的版本(或版本范圍) -->
<version >3.8.1</version>
<!--是否從該插件下載Maven擴(kuò)展(例如打包和類型處理器)衣盾,由于性能原因寺旺,只有在真需要下載時(shí)爷抓,該元素才被設(shè)置成enabled。 -->
<extensions>true</extensions>
<!--在構(gòu)建生命周期中執(zhí)行一組目標(biāo)的配置阻塑。每個(gè)目標(biāo)可能有不同的配置蓝撇。 -->
<executions>
<!--execution元素包含了插件執(zhí)行需要的信息 -->
<execution>
<!--執(zhí)行目標(biāo)的標(biāo)識(shí)符,用于標(biāo)識(shí)構(gòu)建過(guò)程中的目標(biāo)陈莽,或者匹配繼承過(guò)程中需要合并的執(zhí)行目標(biāo) -->
<id>default</id>
<!--綁定了目標(biāo)的構(gòu)建生命周期階段渤昌,如果省略,目標(biāo)會(huì)被綁定到源數(shù)據(jù)里配置的默認(rèn)階段 -->
<phase>compile</phase>
<!--配置的執(zhí)行目標(biāo) -->
<goals/>
<!--配置是否被傳播到子POM -->
<inherited>true</inherited>
<!--作為DOM對(duì)象的配置 -->
<configuration>
<test>test</test>
</configuration>
</execution>
</executions>
<!--項(xiàng)目引入插件所需要的額外依賴 -->
<dependencies>
<!--參見(jiàn)dependencies/dependency元素 -->
<dependency>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
</dependency>
</dependencies>
<!--任何配置是否被傳播到子項(xiàng)目 -->
<inherited>true</inherited>
<!--作為DOM對(duì)象的配置 -->
<configuration/>
<goals/>
</plugin>
</plugins>
</build>
<!--模塊(有時(shí)稱作子項(xiàng)目) 被構(gòu)建成項(xiàng)目的一部分。列出的每個(gè)模塊元素是指向該模塊的目錄的相對(duì)路徑 -->
<modules>
<module>../good-java-example</module>
</modules>
<!--發(fā)現(xiàn)依賴和擴(kuò)展的遠(yuǎn)程倉(cāng)庫(kù)列表。 -->
<repositories>
<!--包含需要連接到遠(yuǎn)程倉(cāng)庫(kù)的信息 -->
<repository>
<!--如何處理遠(yuǎn)程倉(cāng)庫(kù)里發(fā)布版本的下載 -->
<releases>
<!--true或者false表示該倉(cāng)庫(kù)是否為下載某種類型構(gòu)件(發(fā)布版春缕,快照版)開(kāi)啟。 -->
<enabled>true</enabled>
<!--該元素指定更新發(fā)生的頻率忌栅。Maven會(huì)比較本地POM和遠(yuǎn)程POM的時(shí)間戳。這里的選項(xiàng)是:always(一直)曲稼,daily(默認(rèn)索绪,每日),interval:X(這里X是以分鐘為單位的時(shí)間間隔)贫悄,或者never(從不)瑞驱。 -->
<updatePolicy>always</updatePolicy>
<!--當(dāng)Maven驗(yàn)證構(gòu)件校驗(yàn)文件失敗時(shí)該怎么做:ignore(忽略),fail(失斍迮)钱烟,或者warn(警告)。 -->
<checksumPolicy>warn</checksumPolicy>
</releases>
<!-- 如何處理遠(yuǎn)程倉(cāng)庫(kù)里快照版本的下載嫡丙。有了releases和snapshots這兩組配置拴袭,POM就可以在每個(gè)單獨(dú)的倉(cāng)庫(kù)中,為每種類型的構(gòu)件采取不同的
策略曙博。例如拥刻,可能有人會(huì)決定只為開(kāi)發(fā)目的開(kāi)啟對(duì)快照版本下載的支持。參見(jiàn)repositories/repository/releases元素 -->
<snapshots>
</snapshots>
<!--遠(yuǎn)程倉(cāng)庫(kù)唯一標(biāo)識(shí)符父泳“愫撸可以用來(lái)匹配在settings.xml文件里配置的遠(yuǎn)程倉(cāng)庫(kù) -->
<id>default</id>
<!--遠(yuǎn)程倉(cāng)庫(kù)名稱 -->
<name>default</name>
<!--遠(yuǎn)程倉(cāng)庫(kù)URL,按protocol://hostname/path形式 -->
<url>http://192.168.1.169:9999/repository/</url>
<!-- 用于定位和排序構(gòu)件的倉(cāng)庫(kù)布局類型-可以是default(默認(rèn))或者legacy(遺留)惠窄。Maven 2為其倉(cāng)庫(kù)提供了一個(gè)默認(rèn)的布局蒸眠;然
而,Maven 1.x有一種不同的布局杆融。我們可以使用該元素指定布局是default(默認(rèn))還是legacy(遺留)楞卡。 -->
<layout>default</layout>
</repository>
</repositories>
<!--發(fā)現(xiàn)插件的遠(yuǎn)程倉(cāng)庫(kù)列表,這些插件用于構(gòu)建和報(bào)表 -->
<pluginRepositories>
<!--包含需要連接到遠(yuǎn)程插件倉(cāng)庫(kù)的信息.參見(jiàn)repositories/repository元素 -->
</pluginRepositories>
<!--該元素描述了項(xiàng)目相關(guān)的所有依賴。 這些依賴組成了項(xiàng)目構(gòu)建過(guò)程中的一個(gè)個(gè)環(huán)節(jié)蒋腮。它們自動(dòng)從項(xiàng)目定義的倉(cāng)庫(kù)中下載淘捡。要獲取更多信息,請(qǐng)看項(xiàng)目依賴機(jī)制池摧。 -->
<dependencies>
<dependency>
<!--依賴的group ID -->
<groupId>org.apache.maven</groupId>
<!--依賴的artifact ID -->
<artifactId>maven-artifact</artifactId>
<!--依賴的版本號(hào)焦除。 在Maven 2里, 也可以配置成版本號(hào)的范圍。 -->
<version>3.8.1</version>
<!-- 依賴類型作彤,默認(rèn)類型是jar膘魄。它通常表示依賴的文件的擴(kuò)展名,但也有例外宦棺。一個(gè)類型可以被映射成另外一個(gè)擴(kuò)展名或分類器瓣距。類型經(jīng)常和使用的打包方式對(duì)應(yīng)黔帕,
盡管這也有例外代咸。一些類型的例子:jar,war成黄,ejb-client和test-jar呐芥。如果設(shè)置extensions為 true,就可以在 plugin里定義新的類型奋岁。所以前面的類型的例子不完整思瘟。 -->
<type>jar</type>
<!-- 依賴的分類器。分類器可以區(qū)分屬于同一個(gè)POM闻伶,但不同構(gòu)建方式的構(gòu)件滨攻。分類器名被附加到文件名的版本號(hào)后面。例如蓝翰,如果你想要構(gòu)建兩個(gè)單獨(dú)的構(gòu)件成
JAR光绕,一個(gè)使用Java 1.4編譯器,另一個(gè)使用Java 6編譯器畜份,你就可以使用分類器來(lái)生成兩個(gè)單獨(dú)的JAR構(gòu)件诞帐。 -->
<classifier></classifier>
<!--依賴范圍。在項(xiàng)目發(fā)布過(guò)程中爆雹,幫助決定哪些構(gòu)件被包括進(jìn)來(lái)停蕉。欲知詳情請(qǐng)參考依賴機(jī)制。 - compile :默認(rèn)范圍钙态,用于編譯 - provided:類似于編譯慧起,但支持你期待jdk或者容器提供,類似于classpath
- runtime: 在執(zhí)行時(shí)需要使用 - test: 用于test任務(wù)時(shí)使用 - system: 需要外在提供相應(yīng)的元素册倒。通過(guò)systemPath來(lái)取得
- systemPath: 僅用于范圍為system蚓挤。提供相應(yīng)的路徑 - optional: 當(dāng)項(xiàng)目自身被依賴時(shí),標(biāo)注依賴是否傳遞。用于連續(xù)依賴時(shí)使用 -->
<scope>test</scope>
<!--僅供system范圍使用屈尼。注意册着,不鼓勵(lì)使用這個(gè)元素,并且在新的版本中該元素可能被覆蓋掉脾歧。該元素為依賴規(guī)定了文件系統(tǒng)上的路徑甲捏。需要絕對(duì)路徑而不是相對(duì)路徑。推薦使用屬性匹配絕對(duì)路徑鞭执,例如${java.home}司顿。 -->
<!-- <systemPath/>-->
<!--當(dāng)計(jì)算傳遞依賴時(shí), 從依賴構(gòu)件列表里兄纺,列出被排除的依賴構(gòu)件集大溜。即告訴maven你只依賴指定的項(xiàng)目,不依賴項(xiàng)目的依賴估脆。此元素主要用于解決版本沖突問(wèn)題 -->
<exclusions>
<exclusion>
<artifactId>spring-core</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
</exclusions>
<!--可選依賴钦奋,如果你在項(xiàng)目B中把C依賴聲明為可選,你就需要在依賴于B的項(xiàng)目(例如項(xiàng)目A)中顯式的引用對(duì)C的依賴疙赠「恫模可選依賴阻斷依賴的傳遞性。 -->
<optional>true</optional>
</dependency>
</dependencies>
<!--不贊成使用. 現(xiàn)在Maven忽略該元素. -->
<reports></reports>
<!--該元素描述使用報(bào)表插件產(chǎn)生報(bào)表的規(guī)范圃阳。當(dāng)用戶執(zhí)行"mvn site"厌衔,這些報(bào)表就會(huì)運(yùn)行。 在頁(yè)面導(dǎo)航欄能看到所有報(bào)表的鏈接捍岳。 -->
<reporting>
<!--true富寿,則,網(wǎng)站不包括默認(rèn)的報(bào)表锣夹。這包括"項(xiàng)目信息"菜單中的報(bào)表页徐。 -->
<excludeDefaults>true</excludeDefaults>
<!--所有產(chǎn)生的報(bào)表存放到哪里。默認(rèn)值是${project.build.directory}/site晕城。 -->
<outputDirectory>/site</outputDirectory>
<!--使用的報(bào)表插件和他們的配置泞坦。 -->
<plugins>
<!--plugin元素包含描述報(bào)表插件需要的信息 -->
<plugin>
<!--報(bào)表插件在倉(cāng)庫(kù)里的group ID -->
<groupId>org.apache.maven.plugins</groupId>
<!--報(bào)表插件在倉(cāng)庫(kù)里的artifact ID -->
<artifactId>maven-compiler-plugin</artifactId>
<!--被使用的報(bào)表插件的版本(或版本范圍) -->
<version >3.8.1</version>
<!--任何配置是否被傳播到子項(xiàng)目 -->
<inherited>true</inherited>
<!--報(bào)表插件的配置 -->
<configuration/>
<!--一組報(bào)表的多重規(guī)范,每個(gè)規(guī)范可能有不同的配置砖顷。一個(gè)規(guī)范(報(bào)表集)對(duì)應(yīng)一個(gè)執(zhí)行目標(biāo) 贰锁。例如,有1滤蝠,2豌熄,3,4物咳,5锣险,6,7,8芯肤,9個(gè)報(bào)表巷折。1,2崖咨,5構(gòu)成A報(bào)表集锻拘,對(duì)應(yīng)一個(gè)執(zhí)行目標(biāo)。2击蹲,5署拟,8構(gòu)成B報(bào)表集,對(duì)應(yīng)另一個(gè)執(zhí)行目標(biāo) -->
<reportSets>
<!--表示報(bào)表的一個(gè)集合歌豺,以及產(chǎn)生該集合的配置 -->
<reportSet>
<!--報(bào)表集合的唯一標(biāo)識(shí)符推穷,POM繼承時(shí)用到 -->
<id>default</id>
<!--產(chǎn)生報(bào)表集合時(shí),被使用的報(bào)表的配置 -->
<configuration/>
<!--配置是否被繼承到子POMs -->
<inherited>true</inherited>
<!--這個(gè)集合里使用到哪些報(bào)表 -->
<reports>
<report>1</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
<!-- 繼承自該項(xiàng)目的所有子項(xiàng)目的默認(rèn)依賴信息类咧。這部分的依賴信息不會(huì)被立即解析,而是當(dāng)子項(xiàng)目聲明一個(gè)依賴(必須描述group ID和 artifact
ID信息)馒铃,如果group ID和artifact ID以外的一些信息沒(méi)有描述,則通過(guò)group ID和artifact ID 匹配到這里的依賴轮听,并使用這里的依賴信息骗露。 -->
<dependencyManagement>
<dependencies>
</dependencies>
</dependencyManagement>
<!--項(xiàng)目分發(fā)信息,在執(zhí)行mvn deploy后表示要發(fā)布的位置血巍。有了這些信息就可以把網(wǎng)站部署到遠(yuǎn)程服務(wù)器或者把構(gòu)件部署到遠(yuǎn)程倉(cāng)庫(kù)。 -->
<distributionManagement>
<!--部署項(xiàng)目產(chǎn)生的構(gòu)件到遠(yuǎn)程倉(cāng)庫(kù)需要的信息 -->
<repository>
<!--是分配給快照一個(gè)唯一的版本號(hào)(由時(shí)間戳和構(gòu)建流水號(hào))珊随?還是每次都使用相同的版本號(hào)述寡?參見(jiàn)repositories/repository元素 -->
<uniqueVersion>true</uniqueVersion>
<id>maven2</id>
<name>maven2</name>
<url>file://${basedir}/target/deploy</url>
<layout>default</layout>
</repository>
<!--構(gòu)件的快照部署到哪里?如果沒(méi)有配置該元素叶洞,默認(rèn)部署到repository元素配置的倉(cāng)庫(kù)鲫凶,參見(jiàn)distributionManagement/repository元素 -->
<snapshotRepository>
<uniqueVersion>true</uniqueVersion>
<id>maven2</id>
<name>maven2 Snapshot Repository</name>
<url>scp://svn.baidu.com/dipper:/usr/local/maven-snapshot</url>
<layout>default</layout>
</snapshotRepository>
<!--部署項(xiàng)目的網(wǎng)站需要的信息 -->
<site>
<!--部署位置的唯一標(biāo)識(shí)符,用來(lái)匹配站點(diǎn)和settings.xml文件里的配置 -->
<id>dipper-site</id>
<!--部署位置的名稱 -->
<name>business api website</name>
<!--部署位置的URL衩辟,按protocol://hostname/path形式 -->
<url>
scp://svn.baidu.com/dipper:/var/www/localhost/dipper-web
</url>
</site>
<!--項(xiàng)目下載頁(yè)面的URL螟炫。如果沒(méi)有該元素,用戶應(yīng)該參考主頁(yè)艺晴。使用該元素的原因是:幫助定位那些不在倉(cāng)庫(kù)里的構(gòu)件(由于license限制)昼钻。 -->
<downloadUrl/>
<!--如果構(gòu)件有了新的group ID和artifact ID(構(gòu)件移到了新的位置),這里列出構(gòu)件的重定位信息封寞。 -->
<relocation>
<!--構(gòu)件新的group ID -->
<groupId/>
<!--構(gòu)件新的artifact ID -->
<artifactId/>
<!--構(gòu)件新的版本號(hào) -->
<version/>
<!--顯示給用戶的然评,關(guān)于移動(dòng)的額外信息,例如原因狈究。 -->
<message/>
</relocation>
<!-- 給出該構(gòu)件在遠(yuǎn)程倉(cāng)庫(kù)的狀態(tài)碗淌。不得在本地項(xiàng)目中設(shè)置該元素,因?yàn)檫@是工具自動(dòng)更新的。有效的值有:none(默認(rèn))亿眠,converted(倉(cāng)庫(kù)管理員從
Maven 1 POM轉(zhuǎn)換過(guò)來(lái))碎罚,partner(直接從伙伴Maven 2倉(cāng)庫(kù)同步過(guò)來(lái)),deployed(從Maven 2實(shí)例部 署)纳像,verified(被核實(shí)時(shí)正確的和最終的)魂莫。 -->
<status>none</status>
</distributionManagement>
</project>
2.2、POM 重要標(biāo)簽簡(jiǎn)介
-
project.parent
: 父項(xiàng)目的坐標(biāo)爹耗。 -
project.groupId
: 項(xiàng)目的全球唯一標(biāo)識(shí)符耙考。 -
project.artifactId
: 項(xiàng)目的標(biāo)識(shí)符, 它和groupId一起唯一標(biāo)識(shí)一個(gè)項(xiàng)目 -
project.version
: 項(xiàng)目的版本號(hào)潭兽, 它和groupId倦始、artifactId一起構(gòu)成項(xiàng)目的三元組, 代表項(xiàng)目唯一的一個(gè)版本山卦。 -
project.packaging
: 項(xiàng)目的構(gòu)建類型鞋邑, 默認(rèn)包括jar、war账蓉、ear枚碗、pom等, 但不是全部铸本, 通過(guò)其他插件還可以構(gòu)建其他的構(gòu)建類型肮雨, 比如tar等等。
-project.properties
: 可以自定義元素箱玷, 在其他的元素中進(jìn)行應(yīng)用怨规, 本質(zhì)上是一個(gè)聲明變量的地方, 比如jdk版本號(hào)之類的锡足。 -
project.profiles
: 針對(duì)項(xiàng)目不同運(yùn)行環(huán)境聲明不同的構(gòu)建方式波丰, 如果被激活, 會(huì)修改項(xiàng)目的構(gòu)建方式舶得。比如開(kāi)發(fā)時(shí)一般會(huì)區(qū)分為dev掰烟、test、prod等環(huán)境沐批,不同的環(huán)境之間默認(rèn)一般會(huì)隔離纫骑,所以它的資源的加載方式都不一樣, 就需要用profile分別定義珠插, 用到哪個(gè)環(huán)境惧磺, 就激活哪個(gè)環(huán)境。它主要會(huì)影響project
中默認(rèn)定義的build
捻撑、repositories
磨隘、pluginRepositories
缤底、dependencyManagement
、distributionManagement
番捂、dependencies
等元素个唧。 -
project.build
: 構(gòu)建項(xiàng)目需要的信息, 主要包含構(gòu)建項(xiàng)目的源文件路徑设预、目標(biāo)目錄徙歼、資源文件目錄、構(gòu)建擴(kuò)展鳖枕、資源文件包含列表魄梯、插件列表、構(gòu)建目標(biāo)等等宾符。 -
project.modules
: 模塊或子項(xiàng)目酿秸, 時(shí)構(gòu)建的一部分。 -
project.repositories
: 發(fā)現(xiàn)依賴的遠(yuǎn)程倉(cāng)庫(kù)列表魏烫。 -
project.pluginRepositories
: 發(fā)現(xiàn)插件的遠(yuǎn)程倉(cāng)庫(kù)列表辣苏。 -
project.dependencies
: 描述項(xiàng)目構(gòu)建的所有依賴情況。 -
project.dependencyManagement
: 繼承自該項(xiàng)目的子項(xiàng)目的默認(rèn)依賴信息哄褒, 如果子項(xiàng)目聲明一個(gè)依賴某些信息未描述稀蟋, 就會(huì)使用這里的依賴信息。 -
project.distributionManagement
: 項(xiàng)目分發(fā)信息呐赡, 表示項(xiàng)目構(gòu)建完成后發(fā)布的倉(cāng)庫(kù)位置退客。
2.3、POM 重要標(biāo)簽詳解
1. dependency標(biāo)簽
<dependency>
<groupId></groupId>
<artifactId></artifactId>
<version></version>
<type></type>
<scope></scope>
<classifier></classifier>
<optional></optional>
<systemPath></systemPath>
<exclusions>
<exclusion>
<groupId></groupId>
<artifactId></artifactId>
</exclusion>
</exclusions>
</dependency>
dependency
標(biāo)簽標(biāo)識(shí)了項(xiàng)目依賴的某個(gè)組件的信息罚舱, 包含被依賴組件的唯一標(biāo)識(shí)三元組groupId
井辜、artifactId
、version
管闷。
type
表示依賴的類型, 可選值和project.packaging
類似窃肠, 默認(rèn)是jar
, 可以通過(guò)設(shè)置extensions
構(gòu)建新的類型包个。
scope
表示依賴的范圍, 主要包含:
test
表示應(yīng)用程序的正常使用不需要依賴冤留,只在測(cè)試編譯和執(zhí)行階段可用碧囊。此作用域不可傳遞。通常纤怒,此范圍用于測(cè)試庫(kù)糯而,例如 JUnit 和 Mockito。runtime
表示被依賴項(xiàng)目無(wú)需參與項(xiàng)目的編譯泊窘,但是會(huì)參與到項(xiàng)目的測(cè)試和運(yùn)行熄驼。與compile相比像寒,被依賴項(xiàng)目無(wú)需參與項(xiàng)目的編譯。
例如瓜贾,在編譯的時(shí)候我們不需要 JDBC API 的 jar 包诺祸,而在運(yùn)行的時(shí)候我們才需要 JDBC 驅(qū)動(dòng)包。compile
compile 是默認(rèn)值祭芦,如果沒(méi)有指定 scope 值筷笨,該元素的默認(rèn)值為 compile。被依賴項(xiàng)目需要參與到當(dāng)前項(xiàng)目的編譯龟劲,測(cè)試胃夏,打包,運(yùn)行等階段昌跌。打包的時(shí)候通常會(huì)包含被依賴項(xiàng)目仰禀。system
system 元素與 provided 元素類似,但是被依賴項(xiàng)不會(huì)從 maven 倉(cāng)庫(kù)中查找避矢,而是從本地系統(tǒng)中獲取悼瘾,systemPath
元素用于制定本地系統(tǒng)中 jar 文件的路徑。provided
被依賴項(xiàng)目理論上可以參與編譯审胸、測(cè)試亥宿、運(yùn)行等階段,相當(dāng)于compile砂沛,但是在打包階段做了exclude的動(dòng)作烫扼。
例如, 如果我們?cè)陂_(kāi)發(fā)一個(gè)web 應(yīng)用碍庵,在編譯時(shí)我們需要依賴 servlet-api.jar映企,但是在運(yùn)行時(shí)我們不需要該 jar 包,因?yàn)檫@個(gè) jar 包已由應(yīng)用服務(wù)器提供静浴,此時(shí)我們需要使用 provided 進(jìn)行范圍修飾堰氓。import
: 該作用域只在dependencyManagement
元素中生效, 可以代替parent繼承苹享。parent繼承的方式存在的問(wèn)題在于双絮, 如果子module特別多, 需要將子module的依賴都在parent中聲明得问, 這樣子會(huì)造成parent中dependencyManagement
特別龐大囤攀, 無(wú)法進(jìn)行有效的分類。 這個(gè)時(shí)候采用import scope的方式就可以有效解決宫纬, 可以聲明多個(gè)不同類型的pom焚挠, 在子mudule的dependencyManagement
中按需引入即可。 import scope代替parent繼承的方式:
<groupId>org.exmaple</groupId>
<artifactId>parent</artifactId>
<version>1.0.0</version>
<packaging>pom</packaging>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.test</groupId>
<artifactId>test1</artifactId>
<version>1.0.0</version>
</dependency>
<dependency>
<groupId>org.junit</groupId>
<artifactId>junit</artifactId>
<version>0.0.1</version>
<scope>test</scope>
</dependency>
</dependencies>
</dependencyManagement>
這樣就可以在子module中引入了:
<groupId>org.exmaple</groupId>
<artifactId>mudule1</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.example</groupId>
<artifactId>parent</artifactId>
<version>1.0.0</version>
<type>pom</pom>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.test</groupId>
<artifactId>test1</artifactId>
</dependency>
<dependency>
<groupId>org.junit</groupId>
<artifactId>junit</artifactId>
</dependency>
</dependencies>
exclusions
表示要排除的依賴漓骚。
systemPath
只有在以來(lái)范圍是system
的時(shí)候才生效蝌衔,表示依賴在本地文件系統(tǒng)的位置榛泛。
optional
表示可選依賴, 默認(rèn)值為false, 依賴具備傳遞性胚委,比如A->B->C, 按照默認(rèn)值挟鸠, A也會(huì)依賴C, 如果B依賴C時(shí)聲明了optional
為true, 則A不會(huì)依賴C。如下:
// B項(xiàng)目POM聲明:
<dependency>
<groupId>org.example</groupId>
<artifactId>C</artifactId>
<version>1.0.0</version>
<optinal>true</optional>
</dependency>
classifier
表示依賴的分類器亩冬,classifier元素用來(lái)幫助定義構(gòu)件輸出的一些附屬構(gòu)件艘希。附屬構(gòu)件與主構(gòu)件對(duì)應(yīng),比如主構(gòu)件是 kimi-app-2.0.0.jar 該項(xiàng)目可能還會(huì)通過(guò)使用一些插件生成 如 kimi-app-2.0.0-javadoc.jar 硅急、 kimi-app-2.0.0-sources.jar 這樣兩個(gè)附屬構(gòu)件覆享。這時(shí)候,javadoc,sources就是這兩個(gè)附屬構(gòu)件的classifier,這樣附屬構(gòu)件也就擁有了自己唯一的坐標(biāo)营袜。
maven中一般使用groupId
撒顿、artifactId
、version
來(lái)唯一標(biāo)識(shí)一個(gè)組件荚板, 但是有一些特殊的組件凤壁,具備更細(xì)粒度, 需要增加classifier
來(lái)聲明依賴跪另, 否則會(huì)報(bào)錯(cuò)找不到j(luò)ar包拧抖, 比如 JSON-lib:
這個(gè)時(shí)候就必須使用classifier屬性指定了:
<dependency>
<groupId>net.sf.json-lib</groupId>
<artifactId>json-lib</artifactId>
<version>2.4</version>
<classifier>jdk15</classifier>
</dependency>
2. build標(biāo)簽
<build>
<finalName></finalName>
<directory></directory>
<sourceDirectory></sourceDirectory>
<scriptSourceDirectory></scriptSourceDirectory>
<outputDirectory></outputDirectory>
<resources></resources>
<testSourceDirectory></testSourceDirectory>
<testOutputDirectory></testOutputDirectory>
<testResources></testResources>
<filters></filters>
<defaultGoal></defaultGoal>
<plugins></plugins>
<extensions></extensions>
<pluginManagement></pluginManagement>
</build>
finalName
表示構(gòu)建目標(biāo)文件的名稱, 默認(rèn)在${basedir}/target目錄下免绿, 一般使用project.artifactId
唧席。
directory
表示構(gòu)建目標(biāo)文件的存放目錄,默認(rèn)是${basedir}/target嘲驾。
sourceDirectory
表示項(xiàng)目源代碼的目錄淌哟, 默認(rèn)是${basedir}/src/main/java。
scriptSourceDirectory
表示項(xiàng)目腳本的源代碼的目錄辽故。大多數(shù)情況下構(gòu)建時(shí)會(huì)被拷貝到目標(biāo)目錄下徒仓。
outputDirectory
表示構(gòu)建目標(biāo)中class文件的存放目錄, 默認(rèn)是${basedir}/target/classes誊垢。
testSourceDirectory
表示項(xiàng)目測(cè)試源代碼的目錄蓬衡, 默認(rèn)是${basedir}/src/test/java。
testOutputDirectory
表示構(gòu)建目標(biāo)中測(cè)試class文件的存放目錄彤枢, 默認(rèn)是${basedir}/target/test-classes。
resources
表示項(xiàng)目中資源文件的位置筒饰, 用于包含或排除某些資源文件缴啡。
<resources>
<resource>
<targetPath></targetPath>
<filtering></filtering>
<directory></directory>
<includes>
<include></include>
</includes>
<excludes>
<exclude></exclude>
</excludes>
</resource>
</resources>
resource
: 一個(gè)與項(xiàng)目關(guān)聯(lián)的資源文件的列表, 用來(lái)描述資源文件是什么和在哪里瓷们。targetPath
: 表示構(gòu)建完后resource文件存放的位置业栅,默認(rèn)是basedir秒咐, 通常打包在jar包中的資源文件的目標(biāo)目錄是META-INF。directory
: 表示resource文件所在的目錄碘裕, 通常是${basedir}/src/main/resources携取。filtering
: true/false, 表示構(gòu)建時(shí)是否用<properties>元素和<filters>元素中列出的屬性文件中定義的值替換掉資源文件中的同名的屬性。 比如:
<properties>
<username>Tom</username>
</properties>
<build>
<filtering>true</filtering>
<directory>/src/main/resources</directory>
<build>
假如/src/main/resources下有一個(gè)application.properties, 其中有一行:
username: ${username}
編譯完成后帮孔, 就會(huì)變成:
username: Tom
includes
: 表示包含哪些資源文件雷滋, 以*作為通配符。excludes
: 表示忽略哪些資源文件文兢。
testResources
: 表示項(xiàng)目中測(cè)試資源文件的位置晤斩, 用法和resources
一致。
defaultGoal
: 表示構(gòu)建時(shí)執(zhí)行的階段姆坚, 默認(rèn)是install, 即如果在命令行中執(zhí)行mvn, 相當(dāng)于執(zhí)行mvn install澳泵。
filters
: 定義.properties文件,包含一個(gè)properties列表兼呵,該列表會(huì)應(yīng)用到支持filter的resources中兔辅。也就是說(shuō),定義在filter的文件中的name=value鍵值對(duì)击喂,會(huì)在build時(shí)代替${name}值應(yīng)用到resources中维苔。* 它可以配合profile
標(biāo)簽進(jìn)行不同環(huán)境的隔離配置。
<filters>
<filter>/profiles/${profile.id}/*.properties</filter>
</filters>
plugins
: 表示構(gòu)建的插件茫负。
<plugins>
<plugin>
<groupId></groupId>
<artifactId></artifactId>
<version></version>
<executions>
<execution>
<id></id>
<phase></phase>
<goals></goals>
<inherited></inherited>
<configuration>
</configuration>
</execution>
</executions>
<extensions></extensions>
<dependencies>
</dependencies>
<goals></goals>
<inherited></inherited>
<configuration>
</configuration>
</plugin>
</plugins>
groupId
: 代表插件的全球唯一ID, 默認(rèn)org.apache.maven.plugins
artifactId
: 代表插件的IDversion
: 代表插件的版本號(hào)蕉鸳。-
executions
: 配置包含一組指示插件如何執(zhí)行的屬性:id : 執(zhí)行器命名
phase:標(biāo)識(shí)執(zhí)行的階段
goals:標(biāo)識(shí)執(zhí)行的目標(biāo)或功能
configuration:標(biāo)識(shí)執(zhí)行目標(biāo)所需的配置文件 extensions
: 標(biāo)示是否擴(kuò)展goals
: 標(biāo)示執(zhí)行的階段inherited
: 標(biāo)示是否繼承dependencies
: 插件的依賴configuration
: 插件的自定義配置信息
extensions
: 表示構(gòu)建需要用到的一系列擴(kuò)展, 具體目前不知道怎么用忍法, TODO潮尝。
pluginManagement
: 表示構(gòu)建時(shí)插件的聲明。 它與plugins
區(qū)別與dependencies
和dependencyManagement
的區(qū)別一致饿序。
3. profiles標(biāo)簽
profiles
標(biāo)簽表示不同環(huán)境的maven配置勉失, 比如倉(cāng)庫(kù)配置、依賴配置原探、插件配置乱凿、構(gòu)建配置, 基本上覆蓋了maven配置的重要幾個(gè)方面咽弦。在開(kāi)發(fā)過(guò)程中徒蟆, 我們的項(xiàng)目往往會(huì)存在多個(gè)環(huán)境, 比如:開(kāi)發(fā)環(huán)境型型、測(cè)試環(huán)境段审、預(yù)發(fā)環(huán)境、線上環(huán)境等闹蒜, 往往不同環(huán)境數(shù)據(jù)源配置寺枉、日志配置等等不一樣抑淫, 這樣我們每次部署到不同的環(huán)境, 都需要修改配置進(jìn)行構(gòu)建打包姥闪, 來(lái)回修改很容易出錯(cuò)始苇,并且浪費(fèi)時(shí)間人力。
profiles
標(biāo)簽就是為了解決以上問(wèn)題而存在的筐喳, 可以看到profiles
標(biāo)簽的定義如下:
<profiles>
<profile>
<id>prod</id>
<activation>true</activation>
<build></build>
<modules></modules>
<dependencies></dependencies>
<dependencyManagement></dependencyManagement>
<repositories></repositories>
<pluginRepositories></pluginRepositories>
<reports/>
<reporting></reporting>
<distributionManagement></distributionManagement>
<properties/>
</profile>
</profiles>
id
: 表示不同環(huán)境的Profile的唯一ID催式。
activation
: 表示Profile激活的方式, 可以根據(jù)jdk版本、操作系統(tǒng)版本疏唾、maven屬性蓄氧、文件存在或缺失等方式來(lái)激活。它的定義如下:
<activation>
<activeByDefault>true</activeByDefault>
<jdk>1.7</jdk>
<file>
<exists></exists>
<missing></missing>
</file>
<os>
<name></name>
<version></version>
<arch></arch>
<family></family>
</os>
<property>
<name></name>
<value></value>
</property>
</activation>
-
activeByDefault
: 表示默認(rèn)激活 -
jdk
: 表示根據(jù)jdk版本激活槐脏。 -
os
: 表示根據(jù)操作系統(tǒng)激活 -
property
: 表示根據(jù)maven屬性激活喉童。 -
file
: 表示根據(jù)文件存在不存在激活。
properties
: 表示Profile自定義的屬性顿天, 可以定義通過(guò)堂氯, 通常用來(lái)其他地方引用, 比如表示環(huán)境變量等牌废。
其他字段和POM文件中一級(jí)標(biāo)簽一致咽白, 詳見(jiàn)各個(gè)標(biāo)簽的使用方式。
激活方式:
- 根據(jù)環(huán)境自動(dòng)激活鸟缕, 如上所示根據(jù)jdk晶框、os等激活。
- 通過(guò)命令行參數(shù)激活懂从, 如:mvn command -Pprofile, 就會(huì)激活對(duì)應(yīng)profile授段。
- 配置默認(rèn)自動(dòng)激活, 通過(guò)activeByDefault來(lái)設(shè)置番甩。
使用方式:
比如侵贵,我們有2個(gè)環(huán)境:開(kāi)發(fā)環(huán)境(dev)和線上環(huán)境(prod), 它的配置如下:
<profiles>
<profile>
<id>dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<env>dev</env>
</properties>
</profile>
<profile>
<id>prod</id>
<properties>
<env>prod</env>
</properties>
</profile>
</profiles>
<build>
<filters>
<filter>/profiles/${env}/*.properties</filter>
</filters>
<resources>
<resource>
<directory>/src/main/resources</directory>
<filtering>true</filtering>
</resource>
</resources>
</build>
這樣子當(dāng)我們選擇不同的環(huán)境時(shí)缘薛, filters就會(huì)根據(jù)不同的環(huán)境加載不同的配置文件并且應(yīng)用到資源文件中窍育,替換同名的鍵值對(duì), 比如替換jdbc的配置等等宴胧。
除過(guò)使用不同的配置漱抓, Profile
還可以幫助在不同環(huán)境使用不同的maven倉(cāng)庫(kù)、發(fā)布倉(cāng)庫(kù)恕齐, 采用不同的構(gòu)建過(guò)程辽旋,構(gòu)建不同的包等等。
4. dependencyManagement標(biāo)簽
denpendencyManagement
用來(lái)統(tǒng)一管理項(xiàng)目的依賴版本號(hào), 確保各個(gè)子項(xiàng)目的依賴和版本一致补胚,不用每個(gè)項(xiàng)目都單獨(dú)聲明依賴的版本號(hào)。當(dāng)變更版本號(hào)時(shí)追迟,只需要在父項(xiàng)目的denpendencyManagement
中修改版本號(hào)溶其, 子項(xiàng)目不需要任何修改; 如果子項(xiàng)目依賴于一個(gè)特殊的版本號(hào)敦间, 只需要在自己的dependencies
中修改即可瓶逃。
<dependencyManagement>
<dependencies>
<dependency>
</dependency>
</dependencies>
</dependencyManagement>
-
dependencies
: 描述項(xiàng)目的依賴信息, 見(jiàn)dependencies
標(biāo)簽廓块。
它與dependencies
的區(qū)別:
denpendencies
相對(duì)于dependencyManagement
厢绝, 所有子項(xiàng)目dependencies
聲明的依賴如果沒(méi)有單獨(dú)聲明版本號(hào), 就會(huì)使用dependencyManagement
中聲明的版本號(hào)带猴。dependencyManagement
只是聲明依賴的版本號(hào)昔汉, 并不實(shí)際引入依賴, 因此子項(xiàng)目需要實(shí)際引入依賴拴清。 dependencyManagement里只是聲明依賴靶病,并不自動(dòng)實(shí)現(xiàn)引入,因此子項(xiàng)目需要顯示的聲明需要用的依賴口予。如果不在子項(xiàng)目中聲明依賴娄周,是不會(huì)從父項(xiàng)目中繼承下來(lái)的;只有在子項(xiàng)目中寫(xiě)了該依賴項(xiàng)沪停,并且沒(méi)有指定具體版本煤辨,才會(huì)從父項(xiàng)目中繼承該項(xiàng),并且version和scope都讀取自父pom;另外如果子項(xiàng)目中指定了版本號(hào)木张,那么會(huì)使用子項(xiàng)目中指定的jar版本口渔。