maven(二)pom文件详解
生活随笔
收集整理的這篇文章主要介紹了
maven(二)pom文件详解
小編覺得挺不錯的,現(xiàn)在分享給大家,幫大家做個參考.
文章目錄
- 1. 什么是pom 文件?
- 2. pom文件各常用屬性含義
- 2.1 項(xiàng)目基本信息
- 2.2 build項(xiàng)目構(gòu)建屬性介紹
- 2.2.1 resources資源路徑列表
- 2.2.2 plugins 插件列表
- 2.2.3 其他
- 2.3 profile介紹
- 2.4 repositories
- 2.5 dependencies依賴
- 2.6 distributionManagement發(fā)布
1. 什么是pom 文件?
POM( Project Object Model,項(xiàng)目對象模型 ) 是 Maven 工程的基本工作單元,是一個XML文件,包含了項(xiàng)目的基本信息,用于描述項(xiàng)目如何構(gòu)建,聲明項(xiàng)目依賴,等等。執(zhí)行任務(wù)或目標(biāo)時,Maven 會在當(dāng)前目錄中查找 POM。它讀取 POM,獲取所需的配置信息,然后執(zhí)行目標(biāo)。
POM 中可以指定以下配置:
- 項(xiàng)目依賴
- 插件
- 執(zhí)行目標(biāo)
- 項(xiàng)目構(gòu)建 profile
- 項(xiàng)目版本
- 項(xiàng)目開發(fā)者列表
- 相關(guān)郵件列表信息
2. pom文件各常用屬性含義
2.1 項(xiàng)目基本信息
<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/xsd/maven-4.0.0.xsd"><!--聲明項(xiàng)目描述符遵循哪一個POM模型版本。模型本身的版本很少改變,雖然如此,但它仍然是必不可少的,這是為了當(dāng)Maven引入了新的特性或者其他模型變更的時候,確保穩(wěn)定性。 --><modelVersion>4.0.0</modelVersion><groupId>com.jun.cloud</groupId><artifactId>cloud-parent</artifactId><version>0.0.1-SNAPSHOT</version><!--項(xiàng)目產(chǎn)生的構(gòu)件類型,例如jar、war、ear、pom。插件可以創(chuàng)建他們自己的構(gòu)件類型,所以前面列的不是全部構(gòu)件類型 --><packaging>pom</packaging><!--項(xiàng)目的名稱和詳細(xì)描述, Maven產(chǎn)生的文檔用,所以基本可以省略 --><name>cloud-parent</name><description>start project for Spring Boot</description><!--父項(xiàng)目的坐標(biāo),父 POM 包含了一些可以被繼承的默認(rèn)設(shè)置--><parent><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-parent</artifactId><version>Dalston.RELEASE</version><!-- 父項(xiàng)目的pom.xml文件的相對路徑。相對路徑允許你選擇一個不同的路徑。默認(rèn)值是../pom.xml。Maven首先在構(gòu)建當(dāng)前項(xiàng)目的地方尋找父項(xiàng)目的pom,其次在文件系統(tǒng)的這個位置(relativePath位置),然后在本地倉庫,最后在遠(yuǎn)程倉庫尋找父項(xiàng)目的pom。 --><relativePath/> <!-- lookup parent from repository --></parent><!--包含的子模塊--><modules><module>cloud-api</module><module>cloud-common</module></modules> </project>2.2 build項(xiàng)目構(gòu)建屬性介紹
2.2.1 resources資源路徑列表
<build><!--這個元素描述了項(xiàng)目相關(guān)的所有資源路徑列表,例如和項(xiàng)目相關(guān)的屬性文件,這些資源被包含在最終的打包文件里。 --><resources><!--這個元素描述了項(xiàng)目相關(guān)或測試相關(guān)的所有資源路徑,可以有多個 --><resource><!-- 描述了資源的目標(biāo)路徑。該路徑相對target/classes目錄(例如${project.build.outputDirectory})。舉個例子,如果你想資源在特定的包里(org.apache.maven.messages),你就必須該元素設(shè)置為org/apache/maven /messages。然而,如果你只是想把資源放到源碼目錄結(jié)構(gòu)里,就不需要該配置。 --><!--<targetPath />--><!--是否使用參數(shù)值代替參數(shù)名。參數(shù)值取自properties元素或者文件里配置的屬性,文件在filters元素里列出。 --><filtering /><!--描述存放資源的目錄,該路徑相對POM路徑 --><directory>src/main/resources/</directory><!--排除的模式列表,例如**/*.xml --><excludes><exclude>dev/*</exclude><exclude>prod/*</exclude><exclude>test/*</exclude></excludes><!--包含的模式列表,例如**/*.xml. --><includes><!--如果有其他定義通用文件,需要包含進(jìn)來--><!--<include>messages/*</include>--></includes></resource><resource><!--這里是關(guān)鍵! 根據(jù)不同的環(huán)境,把對應(yīng)文件夾里的配置文件打包--><directory>src/main/resources/${profiles.active}</directory></resource></resources><!--這個元素描述了單元測試相關(guān)的所有資源路徑,例如和單元測試相關(guān)的屬性文件。 --><testResources><!--這個元素描述了測試相關(guān)的所有資源路徑,參見上方build/resources/resource元素的說明 --><testResource><targetPath /><filtering /><directory /><includes /><excludes /></testResource></testResources></build>2.2.2 plugins 插件列表
<build><!--子項(xiàng)目可以引用的默認(rèn)插件信息。該插件配置項(xiàng)直到被引用時才會被解析或綁定到生命周期。給定插件的任何本地配置都會覆蓋這里的配置 --><pluginManagement><plugins><!--同下方的插件描述--><plugin></plugin></plugins></pluginManagement><!--使用的插件列表 。 --><plugins><!--plugin元素包含描述插件所需要的信息。 --><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version /><!--是否從該插件下載Maven擴(kuò)展(例如打包和類型處理器),由于性能原因,只有在真需要下載時,該元素才被設(shè)置成enabled。 --><extensions /><!--在構(gòu)建生命周期中 執(zhí)行 一組目標(biāo)的配置。每個目標(biāo)可能有不同的配置。 --><executions><!--execution元素包含了插件執(zhí)行需要的信息 --><execution><!--執(zhí)行目標(biāo)的標(biāo)識符,用于標(biāo)識構(gòu)建過程中的目標(biāo),或者匹配繼承過程中需要合并的執(zhí)行目標(biāo) --><!--<id />--><!--綁定了目標(biāo)的構(gòu)建生命周期階段,如果省略,目標(biāo)會被綁定到源數(shù)據(jù)里配置的默認(rèn)階段 --><phase /><!--配置的執(zhí)行目標(biāo) --><goals><goal>repackage</goal></goals><!--配置是否被傳播到子POM --><inherited>false</inherited><!--作為DOM對象的配置 --><configuration /></execution></executions><!--項(xiàng)目引入插件所需要的額外依賴 --><dependencies><!--參見dependencies/dependency元素 --><!--<dependency>--><!--</dependency>--></dependencies><!--任何配置是否被傳播到子項(xiàng)目 --><inherited /><!--作為DOM對象的配置 --><configuration /></plugin></plugins></build>2.2.3 其他
<!--構(gòu)建項(xiàng)目需要的信息 --><build><!--該元素設(shè)置了項(xiàng)目源碼目錄,當(dāng)構(gòu)建項(xiàng)目的時候,構(gòu)建系統(tǒng)會編譯目錄里的源碼。該路徑是相對于pom.xml的相對路徑。 --><sourceDirectory /><!--該元素設(shè)置了項(xiàng)目腳本源碼目錄,該目錄和源碼目錄不同:絕大多數(shù)情況下,該目錄下的內(nèi)容 會被拷貝到輸出目錄(因?yàn)槟_本是被解釋的,而不是被編譯的)。 --><scriptSourceDirectory /><!--該元素設(shè)置了項(xiàng)目單元測試使用的源碼目錄,當(dāng)測試項(xiàng)目的時候,構(gòu)建系統(tǒng)會編譯目錄里的源碼。該路徑是相對于pom.xml的相對路徑。 --><testSourceDirectory /><!--被編譯過的應(yīng)用程序class文件和配置文件存放的目錄。 --><outputDirectory /><!--被編譯過的測試class文件存放的目錄。 --><testOutputDirectory /><!--構(gòu)建產(chǎn)生的所有文件(即類似target下的所有文件)存放的目錄 --><directory /><!--產(chǎn)生的構(gòu)件的文件名(即jar包的名稱),默認(rèn)值是${artifactId}-${version},如test-profiles-0.0.1-SNAPSHOT.jar。 --><finalName /><!--使用來自該項(xiàng)目的一系列構(gòu)建擴(kuò)展 --><extensions><!--描述使用到的構(gòu)建擴(kuò)展。 --><extension><!--構(gòu)建擴(kuò)展的groupId --><groupId /><!--構(gòu)建擴(kuò)展的artifactId --><artifactId /><!--構(gòu)建擴(kuò)展的版本 --><version /></extension></extensions><!--當(dāng)項(xiàng)目沒有規(guī)定目標(biāo)(Maven2 叫做階段)時的默認(rèn)值 --><defaultGoal /><!--當(dāng)filtering開關(guān)打開時,使用到的過濾器屬性文件列表 --><filters /></build>2.3 profile介紹
參看maven的profile使用
2.4 repositories
<!--發(fā)現(xiàn)依賴和擴(kuò)展的遠(yuǎn)程倉庫列表。 --><repositories><!--包含需要連接到遠(yuǎn)程倉庫的信息 --><repository><!--遠(yuǎn)程倉庫唯一標(biāo)識符。可以用來匹配在settings.xml文件里配置的遠(yuǎn)程倉庫 --><id>banseon-repository-proxy</id><!--遠(yuǎn)程倉庫名稱 --><name>banseon-repository-proxy</name><!--遠(yuǎn)程倉庫URL,按protocol://hostname/path形式 --><url>http://192.168.1.169:9999/repository/</url><!--如何處理遠(yuǎn)程倉庫里發(fā)布版本的下載 --><releases><!--true或者false表示該倉庫是否為下載某種類型構(gòu)件(發(fā)布版,快照版)開啟。 --><enabled /><!--該元素指定更新發(fā)生的頻率。Maven會比較本地POM和遠(yuǎn)程POM的時間戳。這里的選項(xiàng)是:always(一直),daily(默認(rèn),每日),interval:X(這里X是以分鐘為單位的時間間隔),或者never(從不)。 --><updatePolicy /><!--當(dāng)Maven驗(yàn)證構(gòu)件校驗(yàn)文件失敗時該怎么做:ignore(忽略),fail(失敗),或者warn(警告)。 --><checksumPolicy /></releases><!-- 如何處理遠(yuǎn)程倉庫里快照版本的下載。有了releases和snapshots這兩組配置,POM就可以在每個單獨(dú)的倉庫中,為每種類型的構(gòu)件采取不同的 策略。例如,可能有人會決定只為開發(fā)目的開啟對快照版本下載的支持。參見repositories/repository/releases元素 --><snapshots><enabled /><updatePolicy /><checksumPolicy /></snapshots><!-- 用于定位和排序構(gòu)件的倉庫布局類型-可以是default(默認(rèn))或者legacy(遺留)。Maven 2為其倉庫提供了一個默認(rèn)的布局;然 而,Maven 1.x有一種不同的布局。我們可以使用該元素指定布局是default(默認(rèn))還是legacy(遺留)。 --><layout>default</layout></repository></repositories>示例如:
<repositories><repository><id>spring-snapshots</id><name>Spring Snapshots</name><url>https://repo.spring.io/snapshot</url><snapshots><enabled>true</enabled></snapshots></repository><repository><id>spring-milestones</id><name>Spring Milestones</name><url>https://repo.spring.io/milestone</url><snapshots><enabled>false</enabled></snapshots></repository></repositories>2.5 dependencies依賴
<!--該元素描述了項(xiàng)目相關(guān)的所有依賴。 這些依賴組成了項(xiàng)目構(gòu)建過程中的一個個環(huán)節(jié)。它們自動從項(xiàng)目定義的倉庫中下載。 --><dependencies><dependency><groupId>org.apache.maven</groupId><artifactId>maven-artifact</artifactId><!--依賴的版本號。 在Maven 2里, 也可以配置成版本號的范圍。 --><version>3.8.1</version><!--依賴范圍。在項(xiàng)目發(fā)布過程中,幫助決定哪些構(gòu)件被包括進(jìn)來。欲知詳情請參考依賴機(jī)制。- compile :默認(rèn)范圍,用于編譯- provided:類似于編譯,但支持你期待jdk或者容器提供,類似于classpath- runtime: 在執(zhí)行時需要使用- test: 用于test任務(wù)時使用- optional: 當(dāng)項(xiàng)目自身被依賴時,標(biāo)注依賴是否傳遞。用于連續(xù)依賴時使用 --><scope>test</scope><!--當(dāng)計(jì)算傳遞依賴時, 從依賴構(gòu)件列表里,列出被排除的依賴構(gòu)件集。即告訴maven你只依賴指定的項(xiàng)目,不依賴項(xiàng)目的依賴。此元素主要用于解決版本沖突問題 --><exclusions><exclusion><artifactId>spring-core</artifactId><groupId>org.springframework</groupId></exclusion></exclusions><!--可選依賴,如果你在項(xiàng)目B中把C依賴聲明為可選,你就需要在依賴于B的項(xiàng)目(例如項(xiàng)目A)中顯式的引用對C的依賴。可選依賴阻斷依賴的傳遞性。 --><optional>true</optional></dependency></dependencies><!-- 繼承自該項(xiàng)目的所有子項(xiàng)目的默認(rèn)依賴信息。這部分的依賴信息不會被立即解析,而是當(dāng)子項(xiàng)目聲明一個依賴(必須描述group ID和 artifact ID信息),如果group ID和artifact ID以外的一些信息沒有描述,則通過group ID和artifact ID 匹配到這里的依賴,并使用這里的依賴信息。 --><dependencyManagement><dependencies><!--參見dependencies/dependency元素 --><dependency>......</dependency></dependencies></dependencyManagement>2.6 distributionManagement發(fā)布
<!--項(xiàng)目分發(fā)信息,在執(zhí)行mvn deploy后表示要發(fā)布的位置。有了這些信息就可以把網(wǎng)站部署到遠(yuǎn)程服務(wù)器或者把構(gòu)件部署到遠(yuǎn)程倉庫。 --><distributionManagement><repository><id>nexus-releases</id><url>http://192.168.0.237:8081/nexus/content/repositories/releases</url></repository><!--構(gòu)件的快照部署到哪里?如果沒有配置該元素,默認(rèn)部署到repository元素配置的倉庫 --><snapshotRepository><id>nexus-snapshots</id><url>http://192.168.0.237:8081/nexus/content/repositories/snapshots</url></snapshotRepository></distributionManagement>總結(jié)
以上是生活随笔為你收集整理的maven(二)pom文件详解的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: maven(三)最详细的profile的
- 下一篇: maven(一) 基础知识