關(guān)于maven:pom文件的使用解析
一、maven項目的目錄結(jié)構(gòu)
pom文件定于了一個maven項目的maven配置,一般pom文件的放在項目或者模塊的根目錄下。
maven的遵循約定大于配置,約定了如下的目錄結(jié)構(gòu):
目錄 | 目的 |
---|---|
${basedir} | 存放pom.xml和所有的子目錄 |
${basedir}/src/main/java | 項目的java源代碼 |
${basedir}/src/main/resources | 項目的資源,比如說property文件,springmvc.xml |
${basedir}/src/test/java | 項目的測試類,比如說Junit代碼 |
${basedir}/src/test/resources | 測試用的資源 |
${basedir}/src/main/scripts | 項目腳本源碼的目錄 |
${basedir}/src/main/webapp/WEB-INF | web應(yīng)用文件目錄,web項目的信息,比如存放web.xml、本地圖片、jsp視圖頁面 |
${basedir}/target | 打包輸出目錄 |
${basedir}/target/classes | 編譯輸出目錄 |
${basedir}/target/site | 生成文檔的目錄,可以通過index.html查看項目的文檔 |
${basedir}/target/test-classes | 測試編譯輸出目錄 |
Test.java | Maven只會自動運行符合該命名規(guī)則的測試類 |
~/.m2/repository | Maven默認的本地倉庫目錄位置 |
二、根元素和必要配置
<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"> <!-- 模型版本 --> <modelVersion>4.0.0</modelVersion> <!-- 公司或者組織的唯一標(biāo)志,也是打包成jar包路徑的依據(jù) --> <!-- 例如com.companyname.project-group,maven打包jar包的路徑:/com/companyname/project-group --> <groupId>com.companyname.project-group</groupId> <!-- 項目的唯一ID,一個groupId下面可能多個項目,就是靠artifactId來區(qū)分的 --> <artifactId>project</artifactId> <!-- 項目當(dāng)前版本,格式為:主版本.次版本.增量版本-限定版本號 --> <version>1.0</version> <!--項目產(chǎn)生的構(gòu)件類型,包括jar、war、ear、pom等 --> <packaging>jar</packaging> </project>
project是pom文件的根元素,project下有modelVersion、groupId、artifactId、version、packaging等重要的元素。其中,groupId、artifactId、version三個元素用來定義一個項目的坐標(biāo),也就是說,一個maven倉庫中,完全相同的一組groupId、artifactId、version,只能有一個項目。
project
:整個pom配置文件的根元素,所有的配置都是寫在project元素里面的;modelVersion
:指定了當(dāng)前POM模型的版本,對于Maven2及Maven 3來說,它只能是4.0.0;groupId
:這是項目組的標(biāo)識。它在一個組織或者項目中通常是唯一的。artifactId
:這是項目的標(biāo)識,通常是工程的名稱。它在一個項目組(group)下是唯一的。version
:這是項目的版本號,用來區(qū)分同一個artifact的不同版本。packaging
:這是項目產(chǎn)生的構(gòu)件類型,即項目通過maven打包的輸出文件的后綴名,包括jar、war、ear、pom等。
三、父項目和parent元素
<!--父項目的坐標(biāo),坐標(biāo)包括group ID,artifact ID和version。 --> <!--如果項目中沒有規(guī)定某個元素的值,那么父項目中的對應(yīng)值即為項目的默認值 --> <parent> <!--被繼承的父項目的構(gòu)件標(biāo)識符 --> <artifactId>com.companyname.project-group</artifactId> <!--被繼承的父項目的全球唯一標(biāo)識符 --> <groupId>base-project</groupId> <!--被繼承的父項目的版本 --> <version>1.0.1-RELEASE</version> <!-- 父項目的pom.xml文件的相對路徑,默認值是../pom.xml。 --> <!-- 尋找父項目的pom:構(gòu)建當(dāng)前項目的地方--)relativePath指定的位置--)本地倉庫--)遠程倉庫 --> <relativePath>../pom.xml</relativePath> </parent>
所有的pom都繼承自一個父pom(Super POM)。父pom包含了一些可以被繼承的默認設(shè)置,如果項目的pom中沒有設(shè)置這些元素,就會使用父pom中設(shè)置。例如,Super POM中配置了默認倉庫http://repo1.maven.org/maven2,這樣哪怕項目的pom中沒有配置倉庫,也可以去這個默認倉庫中去下載依賴。實際上,maven pom文件約定大于配置的原則,就是通過在Super POM中預(yù)定義了一些配置信息來實現(xiàn)的。
Maven使用effective pom(Super pom加上工程自己的配置)來執(zhí)行相關(guān)的目標(biāo),它幫助開發(fā)者在pom.xml中做盡可能少的配置。當(dāng)然,這些配置也可以被重寫。
parent元素可以指定父pom。用戶可以通過增加parent元素來自定義一個父pom,從而繼承該pom的配置。parent元素中包含一些子元素,用來定位父項目和父項目的pom文件位置。
parent
:用于指定父項目;groupId
:parent的子元素,父項目的groupId,用于定位父項目;artifactId
:parent的子元素,父項目的artifactId,用于定位父項目;version
:parent的子元素,父項目的version,用于定位父項目;relativePath
:parent的子元素,用于定位父項目pom文件的位置。
四、項目構(gòu)建需要的信息
<!--構(gòu)建項目需要的信息 --> <build> <!--------------------- 路徑管理(在遵循約定大于配置原則下,不需要配置) ---------------------> <!--項目源碼目錄,當(dāng)構(gòu)建項目的時候,構(gòu)建系統(tǒng)會編譯目錄里的源碼。該路徑是相對于pom.xml的相對路徑。 --> <sourceDirectory /> <!--該元素設(shè)置了項目單元測試使用的源碼目錄。該路徑是相對于pom.xml的相對路徑 --> <testSourceDirectory /> <!--被編譯過的應(yīng)用程序class文件存放的目錄。 --> <outputDirectory /> <!--被編譯過的測試class文件存放的目錄。 --> <testOutputDirectory /> <!--項目腳本源碼目錄,該目錄下的內(nèi)容,會直接被拷貝到輸出目錄,因為腳本是被解釋的,而不是被編譯的 --> <scriptSourceDirectory /> <!--------------------- 資源管理 ---------------------> <!--這個元素描述了項目相關(guān)的所有資源路徑列表,例如和項目相關(guān)的屬性文件,這些資源被包含在最終的打包文件里。 --> <resources> <!--這個元素描述了項目相關(guān)或測試相關(guān)的所有資源路徑 --> <resource> <!-- 描述了資源的目標(biāo)輸出路徑。該路徑是相對于target/classes的路徑 --> <!-- 如果是想要把資源直接放在target/classes下,不需要配置該元素 --> <targetPath /> <!--是否使用參數(shù)值代替參數(shù)名。參數(shù)值取自文件里配置的屬性,文件在filters元素里列出。 --> <filtering /> <!--描述存放資源的目錄,該路徑相對POM路徑 --> <directory /> <!--包含的模式列表,例如**/*.xml,只有符合條件的資源文件才會在打包的時候被放入到輸出路徑中 --> <includes /> <!--排除的模式列表,例如**/*.xml,符合的資源文件不會在打包的時候會被過濾掉 --> <excludes /> </resource> </resources> <!--這個元素描述了單元測試相關(guān)的所有資源路徑,例如和單元測試相關(guān)的屬性文件。 --> <testResources> <!--這個元素描述了測試相關(guān)的所有資源路徑,子元素說明參考build/resources/resource元素的說明 --> <testResource> <targetPath /> <filtering /> <directory /> <includes /> <excludes /> </testResource> </testResources> <!--------------------- 插件管理 ---------------------> <!-- 子項目可以引用的默認插件信息。pluginManagement中的插件直到被引用時才會被解析或綁定到生命周期 --> <!-- 這里只是做了聲明,并沒有真正的引入。給定插件的任何本地配置都會覆蓋這里的配置--> <pluginManagement> <!-- 可使用的插件列表 --> <plugins> <!--plugin元素包含描述插件所需要的信息。 --> <plugin> <!--插件在倉庫里的group ID --> <groupId /> <!--插件在倉庫里的artifact ID --> <artifactId /> <!--被使用的插件的版本(或版本范圍) --> <version /> <!-- 是否從該插件下載Maven擴展(例如打包和類型處理器) --> <!-- 由于性能原因,只有在真需要下載時,該元素才被設(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ù)里配置的默認階段 --> <phase /> <!--配置的執(zhí)行目標(biāo) --> <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> <!--------------------- 構(gòu)建擴展 ---------------------> <!--使用來自其他項目的一系列構(gòu)建擴展 --> <extensions> <!--每個extension描述一個會使用到其構(gòu)建擴展的一個項目,extension的子元素是項目的坐標(biāo) --> <extension> <!--項目坐標(biāo)三元素:groupId + artifactId + version --> <groupId /> <artifactId /> <version /> </extension> </extensions> <!--------------------- 其他配置 ---------------------> <!--當(dāng)項目沒有規(guī)定目標(biāo)(Maven2 叫做階段)時的默認值 --> <defaultGoal /> <!--構(gòu)建產(chǎn)生的所有文件存放的目錄 --> <directory /> <!--產(chǎn)生的構(gòu)件的文件名,默認值是${artifactId}-${version}。 --> <finalName /> <!--當(dāng)filtering開關(guān)打開時,使用到的過濾器屬性文件列表 --> <filters /> </build>
build標(biāo)簽定義了構(gòu)建項目需要的信息,這部分信息對于定制化項目構(gòu)建是非常重要的。這里會根據(jù)build的子元素的特點,簡單地分類講解。
1、路徑管理
<!--------------------- 路徑管理(在遵循約定大于配置原則下,不需要配置) ---------------------> <!--項目源碼目錄,當(dāng)構(gòu)建項目的時候,構(gòu)建系統(tǒng)會編譯目錄里的源碼。該路徑是相對于pom.xml的相對路徑。 --> <sourceDirectory /> <!--該元素設(shè)置了項目單元測試使用的源碼目錄。該路徑是相對于pom.xml的相對路徑 --> <testSourceDirectory /> <!--被編譯過的應(yīng)用程序class文件存放的目錄。 --> <outputDirectory /> <!--被編譯過的測試class文件存放的目錄。 --> <testOutputDirectory /> <!--項目腳本源碼目錄,該目錄下的內(nèi)容,會直接被拷貝到輸出目錄,因為腳本是被解釋的,而不是被編譯的 --> <scriptSourceDirectory />
路徑管理定義了各種源碼和編譯結(jié)果的輸出路徑。如果遵循maven默認的路徑約定,這里的幾個元素是不需要配置的。這些元素包括:
sourceDirectory
:項目源碼目錄,定義的是相對于pom文件的相對路徑;testSourceDirectory
:項目單元測試源碼目錄,定義的也是是相對于pom文件的相對路徑;outputDirectory
:被編譯過的應(yīng)用程序class文件存放的目錄,也是是相對于pom文件的相對路徑;testOutoutDIrectory
:被編譯過的測試class文件存放的目錄,也是是相對于pom文件的相對路徑;scriptSourceDirectory
:項目腳本源碼目錄,也是是相對于pom文件的相對路徑。由于腳本是解釋性的語言,所以該目錄下的內(nèi)容,會直接被拷貝到輸出目錄,而不需要編譯。
2、資源管理
<!--------------------- 資源管理 ---------------------> <!--這個元素描述了項目相關(guān)的所有資源路徑列表,例如和項目相關(guān)的屬性文件,這些資源被包含在最終的打包文件里。 --> <resources> <!--這個元素描述了項目相關(guān)或測試相關(guān)的所有資源路徑 --> <resource> <!-- 描述了資源的目標(biāo)輸出路徑。該路徑是相對于target/classes的路徑 --> <!-- 如果是想要把資源直接放在target/classes下,不需要配置該元素 --> <targetPath /> <!--是否使用參數(shù)值代替參數(shù)名。參數(shù)值取自文件里配置的屬性,文件在filters元素里列出 --> <filtering /> <!--描述打包前的資源存放的目錄,該路徑相對POM路徑 --> <directory /> <!--包含的模式列表,例如**/*.xml,只有符合條件的資源文件才會在打包的時候被放入到輸出路徑中 --> <includes /> <!--排除的模式列表,例如**/*.xml,符合的資源文件不會在打包的時候會被過濾掉 --> <excludes /> </resource> </resources> <!--這個元素描述了單元測試相關(guān)的所有資源路徑,例如和單元測試相關(guān)的屬性文件。 --> <testResources> <!--這個元素描述了測試相關(guān)的所有資源路徑,子元素說明參考build/resources/resource元素的說明 --> <testResource> <targetPath /> <filtering /> <directory /> <includes /> <excludes /> </testResource> </testResources>
這里的元素主要是對應(yīng)用程序resource資源和單元測試部分resource資源的管理,分別通過resource標(biāo)簽和testResource標(biāo)簽管理兩種資源。兩個標(biāo)簽元素可選的子元素都是一樣的。子元素包括:
targetPath
:描述了資源的目標(biāo)輸出路徑,該路徑是相對于target/classes的路徑;filtering
:對文件中的參數(shù)值進行過濾,需要被過濾的文件在filter中指定;directory
:描述打包前的資源的存放路徑,這個路徑是相對于pom文件所在目錄的相對路徑;includes
:包含的模式列表,例如**/*.xml。只有符合條件的資源文件才會在打包的時候被放入到輸出路徑中;excludes
:排除的模式列表,例如**/*.xml,符合的資源文件不會在打包的時候會被過濾掉。
3、插件管理
插件管理相關(guān)的元素有兩個,包括pluginManagement和plugins。pluginManagement中有子元素plugins,它和project下的直接子元素plugins的區(qū)別是,pluginManagement主要是用來聲明子項目可以引用的默認插件信息,這些插件如果只寫在pluginManagement中是不會被引入的。project下的直接子元素plugins中定義的才是這個項目中真正需要被引入的插件。
<!--------------------- 插件管理 ---------------------> <!-- 子項目可以引用的默認插件信息。pluginManagement中的插件直到被引用時才會被解析或綁定到生命周期 --> <!-- 這里只是做了聲明,并沒有真正的引入。給定插件的任何本地配置都會覆蓋這里的配置--> <pluginManagement> <!-- 可使用的插件列表 --> <plugins> <!--plugin元素包含描述插件所需要的信息。 --> <plugin> <!--插件定位坐標(biāo)三元素:groupId + artifactId + version --> <groupId /> <artifactId /> <version /> <!-- 是否使用這個插件的Maven擴展(extensions),默認為false --> <!-- 由于性能原因,只有在真需要下載時,該元素才被設(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ù)里配置的默認階段 --> <phase /> <!--配置的執(zhí)行目標(biāo) --> <goals /> <!--配置是否被傳播到子POM --> <inherited /> <!--作為DOM對象的配置 --> <configuration /> </execution> </executions> <!--項目引入插件所需要的額外依賴,參見dependencies元素 --> <dependencies> ...... </dependencies> <!--任何配置是否被傳播到子項目 --> <inherited /> <!--作為DOM對象的配置 --> <configuration /> </plugin> </plugins> </pluginManagement> <!--使用的插件列表,這里是真正的引入插件。參見build/pluginManagement/plugins元素 --> <plugins> ...... </plugins>
4、構(gòu)建擴展
extensions是在此構(gòu)建中使用的項目的列表,它們將被包含在運行構(gòu)建的classpath中。這些項目可以啟用對構(gòu)建過程的擴展,并使活動的插件能夠?qū)?gòu)建生命周期進行更改。簡而言之,擴展是在構(gòu)建期間激活的artifacts。擴展不需要實際執(zhí)行任何操作,也不包含 Mojo。因此,擴展對于指定普通插件接口的多個實現(xiàn)中的一個是非常好的。
<!--------------------- 構(gòu)建擴展 ---------------------> <!--使用來自其他項目的一系列構(gòu)建擴展 --> <extensions> <!--每個extension描述一個會使用到其構(gòu)建擴展的一個項目,extension的子元素是項目的坐標(biāo) --> <extension> <!--項目坐標(biāo)三元素:groupId + artifactId + version --> <groupId /> <artifactId /> <version /> </extension> </extensions>
5、其他配置
build中還有一些配置,如下:
<!--------------------- 其他配置 ---------------------> <!--當(dāng)項目沒有規(guī)定目標(biāo)(Maven2 叫做階段)時的默認值 --> <defaultGoal /> <!--構(gòu)建產(chǎn)生的所有文件存放的目錄 --> <directory /> <!--產(chǎn)生的構(gòu)件的文件名,默認值是${artifactId}-${version}。 --> <finalName /> <!--當(dāng)filtering開關(guān)打開時,使用到的過濾器屬性文件列表 --> <filters />
五、項目依賴相關(guān)信息
pom文件中通過dependencyManagement來聲明依賴,通過dependencies元素來管理依賴。dependencyManagement下的子元素只有一個直接的子元素dependencice,其配置和dependencies子元素是完全一致的;而dependencies下只有一類直接的子元素:dependency。一個dependency子元素表示一個依賴項目。
<!--該元素描述了項目相關(guān)的所有依賴。 這些依賴自動從項目定義的倉庫中下載 --> <dependencies> <dependency> <!------------------- 依賴坐標(biāo) -------------------> <!--依賴項目的坐標(biāo)三元素:groupId + artifactId + version --> <groupId>org.apache.maven</groupId> <artifactId>maven-artifact</artifactId> <version>3.8.1</version> <!------------------- 依賴類型 -------------------> <!-- 依賴類型,默認是jar。通常表示依賴文件的擴展名,但有例外。一個類型可以被映射成另外一個擴展名或分類器 --> <!-- 類型經(jīng)常和使用的打包方式對應(yīng),盡管這也有例外,一些類型的例子:jar,war,ejb-client和test-jar --> <!-- 如果設(shè)置extensions為true,就可以在plugin里定義新的類型 --> <type>jar</type> <!-- 依賴的分類器。分類器可以區(qū)分屬于同一個POM,但不同構(gòu)建方式的構(gòu)件。分類器名被附加到文件名的版本號后面 --> <!-- 如果想將項目構(gòu)建成兩個單獨的JAR,分別使用Java 4和6編譯器,就可以使用分類器來生成兩個單獨的JAR構(gòu)件 --> <classifier></classifier> <!------------------- 依賴傳遞 -------------------> <!--依賴排除,即告訴maven只依賴指定的項目,不依賴該項目的這些依賴。此元素主要用于解決版本沖突問題 --> <exclusions> <exclusion> <artifactId>spring-core</artifactId> <groupId>org.springframework</groupId> </exclusion> </exclusions> <!-- 可選依賴,用于阻斷依賴的傳遞性。如果在項目B中把C依賴聲明為可選,那么依賴B的項目中無法使用C依賴 --> <optional>true</optional> <!------------------- 依賴范圍 -------------------> <!--依賴范圍。在項目發(fā)布過程中,幫助決定哪些構(gòu)件被包括進來 - compile:默認范圍,用于編譯; - provided:類似于編譯,但支持jdk或者容器提供,類似于classpath - runtime: 在執(zhí)行時需要使用; - systemPath: 僅用于范圍為system。提供相應(yīng)的路徑 - test: 用于test任務(wù)時使用; - system: 需要外在提供相應(yīng)的元素。通過systemPath來取得 - optional: 當(dāng)項目自身被依賴時,標(biāo)注依賴是否傳遞。用于連續(xù)依賴時使用 --> <scope>test</scope> <!-- 該元素為依賴規(guī)定了文件系統(tǒng)上的路徑。僅供scope設(shè)置system時使用。但是不推薦使用這個元素 --> <!-- 不推薦使用絕對路徑,如果必須要用,推薦使用屬性匹配絕對路徑,例如${java.home} --> <systemPath></systemPath> </dependency> </dependencies> <!-- 繼承自該項目的所有子項目的默認依賴信息,這部分的依賴信息不會被立即解析。 --> <!-- 當(dāng)子項目聲明一個依賴,如果group ID和artifact ID以外的一些信息沒有描述,則使用這里的依賴信息 --> <dependencyManagement> <dependencies> <!--參見dependencies/dependency元素 --> <dependency> ...... </dependency> </dependencies> </dependencyManagement>
這里也是根據(jù)元素的作用,簡單的對dependency的子元素做了一下分類。下面按分類來看一下dependency的子元素:
1、依賴坐標(biāo)
依然是通過groupId + artifactId + version來在倉庫中定位一個項目:
groupId
:parent的子元素,父項目的groupId,用于定位父項目;artifactId
:parent的子元素,父項目的artifactId,用于定位父項目;version
:parent的子元素,父項目的version,用于定位父項目;
2、依賴類型
這個分類主要包括兩個元素,分別是依賴類型和依賴的分類器。同一個項目,即使打包成同一種類型,也可以有多個文件同時存在,因為它們的分類器可能是不同的。
type
:依賴類型,默認是jar。通常表示依賴文件的擴展名,但也有例外。一個類型可以被映射成另外一個擴展名或分類器。類型經(jīng)常和使用的打包方式對應(yīng),盡管這也有例外,一些類型的例子:jar,war,ejb-client和test-jar。如果設(shè)置extensions為true,就可以在plugin里定義新的類型。classifier
:依賴的分類器。分類器可以區(qū)分屬于同一個POM,但不同構(gòu)建方式的構(gòu)件。分類器名被附加到文件名的版本號后面,如果想將項目構(gòu)建成兩個單獨的JAR,分別使用Java 4和6編譯器,就可以使用分類器來生成兩個單獨的JAR構(gòu)件
3、依賴傳遞
依賴傳遞相關(guān)的子元素主要有兩個,用于依賴排除的exclusions和設(shè)置依賴是否可選的optional。
exclusions
:排除該項目中的一些依賴,即本項目A依賴該dependency指示的項目B,但是不依賴項目B中依賴的這些依賴;optional
:可選依賴,用于阻斷依賴的傳遞性,即本項目不會依賴父項目中optional設(shè)置為true的依賴。
4、依賴范圍
還有一些其他元素:
scope
:依賴范圍。在項目發(fā)布過程中,幫助決定哪些構(gòu)件被包括進來
- compile
:默認范圍,用于編譯; - provided:類似于編譯,但支持jdk或者容器提供,類似于classpath
- runtime
: 在執(zhí)行時需要使用; - systemPath: 僅用于范圍為system,提供相應(yīng)的路徑
- test
: 用于test任務(wù)時使用; - system: 需要外在提供相應(yīng)的元素,通過systemPath來取得
- optional
: 當(dāng)項目自身被依賴時,標(biāo)注依賴是否傳遞。用于連續(xù)依賴時使用
systemPath
:該元素為依賴規(guī)定了文件系統(tǒng)上的絕對路徑。僅在scope設(shè)置成system時才會使用。不推薦使用這個元素。不推薦使用絕對路徑,如果必須要用,推薦使用屬性匹配絕對路徑,例如${java.home}
六、生成文檔相關(guān)的元素
<!--項目的名稱, Maven生成文檔使用 --> <name>project-maven</name> <!--項目主頁的URL, Maven生成文檔使用 --> <url>http://123.a.b/nsnxs</url> <!-- 項目的詳細描述, Maven生成文檔使用。當(dāng)這個元素能夠用HTML格式描述時,不鼓勵使用純文本描述 --> <!--如果你需要修改生成的web站點的索引頁面,你應(yīng)該修改你自己的索引頁文件,而不是調(diào)整這里的文檔 --> <description>Description of this maven project</description>
備注:maven可以通過mvn site命令生成項目的相關(guān)文檔。
和生成文檔相關(guān)的元素,包括name,url,和description。
name
:項目名稱,maven生成文檔會使用項目名;url
:項目主頁的地址,maven生成文檔的時候使用。description
:項目描述。如果可以使用HTML格式進行描述的時候,不推薦使用純文本的描述。
七、遠程倉庫列表
遠程倉庫列表的配置,包括依賴和擴展的遠程倉庫配置,以及插件的遠程倉庫配置。在本地倉庫找不到的情況下,maven下載依賴、擴展和插件就是從這里配置的遠程倉庫中進行下載。
需要注意的是release和snapshot兩者的區(qū)別。release是穩(wěn)定版本,一經(jīng)發(fā)布不再修改,想發(fā)布修改后的項目,只能升級項目版本再進行發(fā)布;snapshot是不穩(wěn)定的,一個snapshot的版本可以不斷改變。項目在開發(fā)期間一般會使用snapshot,更方便進行頻繁的代碼更新;一旦發(fā)布到外部,或者開發(fā)基本完成,代碼迭代不再頻繁,則推薦使用release。
<!--發(fā)現(xiàn)依賴和擴展的遠程倉庫列表。 --> <repositories> <!--包含需要連接到遠程倉庫的信息 --> <repository> <!--如何處理遠程倉庫里發(fā)布版本的下載 --> <releases> <!--值為true或者false,表示該倉庫是否為下載某種類型構(gòu)件(發(fā)布版,快照版)開啟。 --> <enabled /> <!--該元素指定更新發(fā)生的頻率。Maven會比較本地POM和遠程POM的時間戳 --> <!--選項:always,daily(默認),interval:X(X單位為分鐘),或者never。 --> <updatePolicy /> <!--當(dāng)Maven驗證構(gòu)件校驗文件失敗時該怎么做。選項:ignore,fail,或者warn --> <checksumPolicy /> </releases> <!-- 如何處理遠程倉庫里快照版本的下載 --> <!-- 有了releases和snapshots這兩組配置,就可以在每個單獨的倉庫中,為每種類型的構(gòu)件采取不同的策略 --> <snapshots> <enabled /> <updatePolicy /> <checksumPolicy /> </snapshots> <!--遠程倉庫唯一標(biāo)識符??梢杂脕砥ヅ湓趕ettings.xml文件里配置的遠程倉庫 --> <id>nanxs-repository-proxy</id> <!--遠程倉庫名稱 --> <name>nanxs-repository-proxy</name> <!--遠程倉庫URL,按protocol://hostname/path形式 --> <url>http://192.168.1.169:9999/repository/</url> <!-- 用于定位和排序構(gòu)件的倉庫布局類型??梢允莇efault或者legacy --> <layout>default</layout> </repository> </repositories> <!--發(fā)現(xiàn)插件的遠程倉庫列表,這些插件用于構(gòu)建和報表 --> <pluginRepositories> <!--包含需要連接到遠程插件倉庫的信息。參見repositories/repository元素 --> <pluginRepository> ...... </pluginRepository> </pluginRepositories>
八、項目分發(fā)信息相關(guān)元素
<!--項目分發(fā)信息,在執(zhí)行mvn deploy后表示要發(fā)布的位置。用于把網(wǎng)站部署到遠程服務(wù)器或者把構(gòu)件部署到遠程倉庫 --> <distributionManagement> <!--部署項目產(chǎn)生的構(gòu)件到遠程倉庫需要的信息 --> <repository> <!-- 是分配給快照一個唯一的版本號 --> <uniqueVersion /> <!-- 其他配置參見repositories/repository元素 --> <id>nanxs-maven2</id> <name>nanxsmaven2</name> <url>file://${basedir}/target/deploy</url> <layout /> </repository> <!--構(gòu)件的快照部署的倉庫。默認部署到distributionManagement/repository元素配置的倉庫 --> <snapshotRepository> <uniqueVersion /> <id>nanxs-maven2</id> <name>Nanxs-maven2 Snapshot Repository</name> <url>scp://svn.baidu.com/nanxs:/usr/local/maven-snapshot</url> <layout /> </snapshotRepository> <!--部署項目的網(wǎng)站需要的信息 --> <site> <!--部署位置的唯一標(biāo)識符,用來匹配站點和settings.xml文件里的配置 --> <id>nanxs-site</id> <!--部署位置的名稱 --> <name>business api website</name> <!--部署位置的URL,按protocol://hostname/path形式 --> <url>scp://svn.baidu.com/nanxs:/var/www/localhost/nanxs-web</url> </site> <!--項目下載頁面的URL。如果沒有該元素,用戶應(yīng)該參考主頁 --> <!--本元素是為了幫助定位那些不在倉庫里的構(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)件新的版本號 --> <version /> <!--顯示給用戶的,關(guān)于移動的額外信息,例如原因 --> <message /> </relocation> <!-- 給出該構(gòu)件在遠程倉庫的狀態(tài)。本地項目中不能設(shè)置該元素,因為這是工具自動更新的 --> <!-- 有效的值有:none(默認),converted(倉庫管理員從 Maven 1 POM轉(zhuǎn)換過來), partner(直接從伙伴Maven 2倉庫同步過來),deployed(從Maven 2實例部署), verified(被核實時正確的和最終的) --> <status /> </distributionManagement>
項目分發(fā)信息的相關(guān)配置,在distributionManagement中設(shè)置。設(shè)置的內(nèi)容包括:
repository
和snapshotRepository
:項目產(chǎn)生的構(gòu)建/快照構(gòu)建部署的遠程倉庫。如果不配置snapshotRepository,快照也會部署到repository中;site
:部署項目的網(wǎng)站需要的信息;downloadUrl
:項目下載頁面的URL,這是為不在倉庫中的構(gòu)建提供的;relocation
:如果構(gòu)件有了新的group ID和artifact ID(移到了新的位置),這里列出構(gòu)件的新的信息;status
:給出該構(gòu)件在遠程倉庫的狀態(tài),本地項目中不能設(shè)置該元素,這是工具自動更新的。
九、報表規(guī)范
報表規(guī)范描述的是使用mvn site命令時使用的一些配置。
<!-- 該元素描述使用報表插件產(chǎn)生報表的規(guī)范 --> <!-- 當(dāng)用戶執(zhí)行"mvn site",這些報表就會運行,在頁面導(dǎo)航欄能看到所有報表的鏈接 --> <reporting> <!--網(wǎng)站是否排除默認的報表。這包括"項目信息"菜單中的報表。 --> <excludeDefaults /> <!--所有產(chǎn)生的報表存放到哪里。默認值是${project.build.directory}/site。 --> <outputDirectory /> <!--使用的報表插件和他們的配置。 --> <plugins> <!--plugin元素包含描述報表插件需要的信息 --> <plugin> <!--報表插件定位:groupId + artifactId + version --> <groupId /> <artifactId /> <version /> <!--任何配置是否被傳播到子項目 --> <inherited /> <!--報表插件的配置 --> <configuration /> <!-- 一組報表的多重規(guī)范,每個規(guī)范可能有不同的配置。一個規(guī)范(報表集)對應(yīng)一個執(zhí)行目標(biāo) --> <!-- 例如,有1~9這9個報表。1,2構(gòu)成A報表集,對應(yīng)一個執(zhí)行目標(biāo);2,5構(gòu)成B報表集,對應(yīng)另一個執(zhí)行目標(biāo) --> <reportSets> <!--表示報表的一個集合,以及產(chǎn)生該集合的配置 --> <reportSet> <!--報表集合的唯一標(biāo)識符,POM繼承時用到 --> <id /> <!--產(chǎn)生報表集合時,被使用的報表的配置 --> <configuration /> <!--配置是否被繼承到子POMs --> <inherited /> <!--這個集合里使用到哪些報表 --> <reports /> </reportSet> </reportSets> </plugin> </plugins> </reporting>
十、profile配置
<!--在列的項目構(gòu)建profile,如果被激活,會修改構(gòu)建處理 --> <profiles> <!--根據(jù)環(huán)境參數(shù)或命令行參數(shù)激活某個構(gòu)建處理 --> <profile> <!--構(gòu)建配置的唯一標(biāo)識符。即用于命令行激活,也用于在繼承時合并具有相同標(biāo)識符的profile。 --> <id /> <!--自動觸發(fā)profile的條件邏輯。Activation是profile的開啟鑰匙,profile的力量來自于它 --> <!-- 能夠在某些特定的環(huán)境中自動使用某些特定的值;這些環(huán)境通過activation元素指定。activation元素并不是激活profile的唯一方式 --> <activation> <!--profile默認是否激活的標(biāo)志 --> <activeByDefault /> <!--當(dāng)匹配的jdk被檢測到,profile被激活。例如,1.4激活JDK1.4,1.4.0_2,而!1.4激活所有版本不是以1.4開頭的JDK --> <jdk /> <!--當(dāng)匹配的操作系統(tǒng)屬性被檢測到,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檢測到某一個屬性(其值可以在POM中通過${名稱}引用),其擁有對應(yīng)的名稱和值,Profile就會被激活 --> <!--如果值字段是空的,那么存在屬性名稱字段就會激活profile,否則按區(qū)分大小寫方式匹配屬性值字段 --> <property> <!--激活profile的屬性的名稱 --> <name>mavenVersion</name> <!--激活profile的屬性的值 --> <value>2.0.3</value> </property> <!--提供一個文件名,通過檢測該文件的存在或不存在來激活profile。missing檢查文件是否存在,如果不存在則激活profile --> <!--另一方面,exists則會檢查文件是否存在,如果存在則激活profile --> <file> <!--如果指定的文件存在,則激活profile。 --> <exists>/usr/local/abcd/abcd-home/jobs/maven-guide-zh-to-production/workspace/ </exists> <!--如果指定的文件不存在,則激活profile。 --> <missing>/usr/local/abcd/abcd-home/jobs/maven-guide-zh-to-production/workspace/ </missing> </file> </activation> <!--構(gòu)建項目所需要的信息。參見build元素 --> <build /> <!--發(fā)現(xiàn)依賴和擴展的遠程倉庫列表。詳情參見repositories元素 --> <repositories /> <!--發(fā)現(xiàn)插件的遠程倉庫列表,這些插件用于構(gòu)建和報表。詳情參見pluginRepositories元素 --> <pluginRepositories /> <!--該元素描述了項目相關(guān)的所有依賴。 詳細配置參見dependencies --> <dependencies /> <!--該元素包括使用報表插件產(chǎn)生報表的規(guī)范。當(dāng)用戶執(zhí)行"mvn site",這些報表就會運行。在頁面導(dǎo)航欄能看到所有報表的鏈接。參見reporting元素 --> <reporting /> <!--參見dependencyManagement元素 --> <dependencyManagement /> <!--參見distributionManagement元素 --> <distributionManagement /> <!--不贊成使用. 現(xiàn)在Maven忽略該元素. --> <reports /> <!--模塊(有時稱作子項目) 被構(gòu)建成項目的一部分。列出的每個模塊元素是指向該模塊的目錄的相對路徑 --> <modules /> <!--參見properties元素 --> <properties /> </profile> </profiles>
十一、郵件列表和持續(xù)集成配置
<!--項目持續(xù)集成信息 --> <ciManagement> <!--持續(xù)集成系統(tǒng)的名字,例如continuum --> <system /> <!--該項目使用的持續(xù)集成系統(tǒng)的URL(如果持續(xù)集成系統(tǒng)有web接口的話)。 --> <url /> <!--構(gòu)建完成時,需要通知的開發(fā)者/用戶的配置項。包括被通知者信息和通知條件(錯誤,失敗,成功,警告) --> <notifiers> <!--配置一種方式,當(dāng)構(gòu)建中斷時,以該方式通知用戶/開發(fā)者 --> <notifier> <!--傳送通知的途徑 --> <type /> <!--發(fā)生錯誤時是否通知 --> <sendOnError /> <!--構(gòu)建失敗時是否通知 --> <sendOnFailure /> <!--構(gòu)建成功時是否通知 --> <sendOnSuccess /> <!--發(fā)生警告時是否通知 --> <sendOnWarning /> <!--不贊成使用。通知發(fā)送到哪里 --> <address /> <!--擴展配置項 --> <configuration /> </notifier> </notifiers> </ciManagement> <!--項目相關(guān)郵件列表信息 --> <mailingLists> <!--該元素描述了項目相關(guān)的所有郵件列表。自動產(chǎn)生的網(wǎng)站引用這些信息。 --> <mailingList> <!--郵件的名稱 --> <name>Demo</name> <!--發(fā)送郵件的地址或鏈接,如果是郵件地址,創(chuàng)建文檔時,mailto: 鏈接會被自動創(chuàng)建 --> <post>nanxs@123.com</post> <!--訂閱郵件的地址或鏈接,如果是郵件地址,創(chuàng)建文檔時,mailto: 鏈接會被自動創(chuàng)建 --> <subscribe>nanxs@123.com</subscribe> <!--取消訂閱郵件的地址或鏈接,如果是郵件地址,創(chuàng)建文檔時,mailto: 鏈接會被自動創(chuàng)建 --> <unsubscribe>nanxs@123.com</unsubscribe> <!--你可以瀏覽郵件信息的URL --> <archive>http:/a.b.c/nanxs/demo/dev/</archive> </mailingList> </mailingLists>
十二、項目的描述性信息
<!--項目的問題管理系統(tǒng)(Bugzilla, Jira, Scarab,或任何你喜歡的問題管理系統(tǒng))的名稱和URL --> <issueManagement> <!--問題管理系統(tǒng)(例如jira)的名字, --> <system>jira</system> <!--該項目使用的問題管理系統(tǒng)的URL --> <url>http://jira.baidu.com/nanxs</url> </issueManagement> <!--項目創(chuàng)建年份,4位數(shù)字。當(dāng)產(chǎn)生版權(quán)信息時需要使用這個值。 --> <inceptionYear /> <!--項目開發(fā)者列表 --> <developers> <!--某個項目開發(fā)者的信息 --> <developer> <!--SCM里項目開發(fā)者的唯一標(biāo)識符 --> <id>HELLO WORLD</id> <!--項目開發(fā)者的全名 --> <name>nanxs</name> <!--項目開發(fā)者的email --> <email>123@abc.com</email> <!--項目開發(fā)者的主頁的URL --> <url /> <!--項目開發(fā)者在項目中扮演的角色,角色元素描述了各種角色 --> <roles> <role>Project Manager</role> <role>Architect</role> </roles> <!--項目開發(fā)者所屬組織 --> <organization>demo</organization> <!--項目開發(fā)者所屬組織的URL --> <organizationUrl>http://a.b.com/nanxs</organizationUrl> <!--項目開發(fā)者屬性,如即時消息如何處理等 --> <properties> <dept>No</dept> </properties> <!--項目開發(fā)者所在時區(qū), -11到12范圍內(nèi)的整數(shù)。 --> <timezone>-5</timezone> </developer> </developers> <!--項目的其他貢獻者列表 --> <contributors> <!--項目的其他貢獻者。參見developers/developer元素 --> <contributor> <name /> <email /> <url /> <organization /> <organizationUrl /> <roles /> <timezone /> <properties /> </contributor> </contributors> <!--該元素描述了項目所有License列表。 應(yīng)該只列出該項目的license列表,不要列出依賴項目的license列表 --> <!--如果列出多個license,用戶可以選擇它們中的一個而不是接受所有l(wèi)icense --> <licenses> <!--描述了項目的license,用于生成項目的web站點的license頁面,其他一些報表和validation也會用到該元素。 --> <license> <!--license用于法律上的名稱 --> <name>Apache 2</name> <!--官方的license正文頁面的URL --> <url>http://a.b.com/nanxs/LICENSE-1.0.txt</url> <!--項目分發(fā)的主要方式: repo,可以從Maven庫下載 manual, 用戶必須手動下載和安裝依賴 --> <distribution>repo</distribution> <!--關(guān)于license的補充信息 --> <comments>A business-friendly OSS license</comments> </license> </licenses> <!--SCM(Source Control Management)標(biāo)簽允許你配置你的代碼庫,供Maven web站點和其它插件使用。 --> <scm> <!--SCM的URL,該URL描述了版本庫和如何連接到版本庫。該連接只讀 --> <connection>scm:svn:http://a.b.com/nanxs</connection> <!--給開發(fā)者使用的,類似connection元素。即該連接不僅僅只讀 --> <developerConnection>scm:svn:http://a.b.com/nanxs</developerConnection> <!--當(dāng)前代碼的標(biāo)簽,在開發(fā)階段默認為HEAD --> <tag /> <!--指向項目的可瀏覽SCM庫(例如ViewVC或者Fisheye)的URL。 --> <url>http://a.b.com/nanxs</url> </scm> <!--描述項目所屬組織的各種屬性。Maven產(chǎn)生的文檔用 --> <organization> <!--組織的全名 --> <name>demo</name> <!--組織主頁的URL --> <url>http://a.b.com/nanxs</url> </organization>
十三、其他配置
<!--描述了這個項目構(gòu)建環(huán)境中的前提條件。 --> <prerequisites> <!--構(gòu)建該項目或使用該插件所需要的Maven的最低版本 --> <maven /> </prerequisites> <!--模塊(有時稱作子項目) 被構(gòu)建成項目的一部分。列出的每個模塊元素是指向該模塊的目錄的相對路徑 --> <modules /> <!--以值替代名稱,Properties可以在整個POM中使用,也可以作為觸發(fā)條件(見settings.xml中activation元素的說明) --> <!-格式是<name>value</name>。 --> <properties /> <!--不推薦使用,現(xiàn)在Maven忽略該元素. --> <reports></reports>
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
Spring Cloud Gateway 使用JWT工具類做用戶登錄校驗功能
這篇文章主要介紹了Spring Cloud Gateway 使用JWT工具類做用戶登錄校驗的示例代碼,本文給大家介紹的非常詳細,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-01-01一行命令同時修改maven項目中多個module的版本號的方法
這篇文章主要介紹了一行命令同時修改maven項目中多個module的版本號的方法,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2019-06-06Java8中 LocalDate和java.sql.Date的相互轉(zhuǎn)換操作
這篇文章主要介紹了Java8中 LocalDate和java.sql.Date的相互轉(zhuǎn)換操作,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12SpringMVC中的DispatcherServlet詳細解析
這篇文章主要介紹了SpringMVC中的DispatcherServlet詳細解析,DispatcherServlet也是一個Servlet,它也能通過Servlet的API來響應(yīng)請求,從而成為一個前端控制器,Web容器會調(diào)用Servlet的doGet()以及doPost()等方法,需要的朋友可以參考下2023-12-12Java優(yōu)化if-else代碼的實戰(zhàn)記錄
開發(fā)中經(jīng)常會根據(jù)不同的參數(shù)判斷走不同的邏輯業(yè)務(wù),我們常用的方法就是if/else嵌套使用,導(dǎo)致每增加一個需求就加一個if,慢慢的就會發(fā)現(xiàn)自己寫的代碼中出現(xiàn)了大量的if/else,這篇文章主要給大家介紹了關(guān)于Java優(yōu)化if-else代碼的相關(guān)資料,需要的朋友可以參考下2021-09-09