Maven 是什么?
回答這個問題,我們先來了解下沒有Maven,我們是怎么使用開發者工具IDE去開發Java程序的。我之前開發Java程序不多,但是我還是記得,我是從網上下載或從合作方拷貝 jar 包,從 Library 中添加到項目依賴,就這樣構件一堆外部依賴來執行本地程序。
從事 ASP.NET 開發(C#)的朋友,更能清晰地表達出這個意思,DLL 文件漫天飛,只要拷貝過來就能用啦。
這將帶來什么問題呢,比如同學A 和同學B 是一個項目的兩個功能一個是CMS系統,一個是做問答系統,兩個都是獨立開發,使用了相同的 Json 庫,但是版本不同,當他們合並項目的時候,問題來了,他們的第三方庫管理混亂就出現了不少麻煩。相互兼容成了最大的問題。
當嵌套依賴出現的,內心幾乎是奔潰的,見下圖:
當項目 A引用了 組件B ,項目C 引用了組件 D,組件B,D都引用了 組件 E,但是B 引用了版本E1,D引用了版本E2,B 和D都是第三方組件,是不是很麻煩。這些大部分是因為第三方組件管理混亂。
有沒有什么好的方法,使得開發者不在關系第三方組件管理,而是專心於業務的開發,Maven就是這樣的管理工具,
Apache Maven是一個軟件項目管理和理解工具。基於項目對象模型思想,Maven可以管理一個項目的構建、報告和信息中心文檔
Maven為開發者提供了一套完整的構建生命周期框架。開發團隊幾乎不用花多少時間就能夠自動完成工程的基礎構建配置,因為Maven使用了一個標准的目錄結構和一個默認的構建生命周期。
Maven 具體完成什么工作呢
- 構建
- 文檔生成
- 報告
- 依賴
- SCMs
- 發布
- 分發
- 郵件列表
總的來說,Maven簡化了工程的構建過程,並對其標准化。它無縫銜接了編譯、發布、文檔生成、團隊合作和其他任務。Maven提高了重用性,負責了大部分構建相關任務。
什么是Maven倉庫
Maven倉庫用來存放Maven管理的所有Jar包。分為:本地倉庫 和 中央倉庫。
-
本地倉庫:Maven本地的Jar包倉庫。
-
中央倉庫: Maven官方提供的遠程倉庫。
當項目編譯時,Maven首先從本地倉庫中尋找項目所需的Jar包,若本地倉庫沒有,再到Maven的中央倉庫下載所需Jar包。
Maven特點 約定優於配置
Maven 使用約定而不是配置,意味着開發者不需要再自己創建構建過程。
開發者不需要再關心每一個配置細節。Maven為工程提供了合理的默認行為。當創建Maven工程時,Maven會創建默認的工程結構。開發者只需要合理的放置文件,而在 pom.xml 中不再需要定義任何配置。
下表展示了工程源碼文件、資源文件的默認配置,和其他一些配置。假定${basedir}表示工程目錄:
配置項 | 默認值 |
---|---|
source code | ${basedir}/src/main/java |
resources | ${basedir}/src/main/resources |
Tests | ${basedir}/src/test |
Complied byte code | ${basedir}/target |
distributable JAR | ${basedir}/target/classes |
為了構建工程,Maven 為開發者提供了選項來配置生命周期目標和工程依賴(依賴於 Maven 的插件擴展功能和默認的約定)。大部分的工程管理和構建相關的任務是由 Maven 插件完成的。
Maven 的安裝 window mac
在安裝 IDEA 開發工具的時候,默認包含了 Maven 的安裝,當前版本一般安裝了 Maven2 和 Maven3。當然我們也是可以獨立安裝最新版本的 Maven。
window 下的 Maven 安裝
- 從官方網站下載(http://maven.apache.org/download.cgi)
- 解壓,如果解壓到 C:\maven3.6,注意確保您安裝了 Java JDK。
- 設置環境變量
M2_HOME = C:\maven3.6
Path 添加 %M2_HOME%/bin
測試一下 使用 Ctrl+R 打開 cmd 窗口,輸入
mvn -version
mac 下的 Maven 安裝
- 從官方網站下載(http://maven.apache.org/download.cgi)
- 解壓,如果解壓到 \home\maven3.6,注意確保您安裝了 Java JDK。
- 設置環境變量
export MAVEN_HOME=/Users/zhang/Documents/apache-maven-3.6
export PATH=${MAVEN_HOME}/bin:$PATH
輸入 source source /etc/profile 使得程序生效
測試一下 打開終端窗口
mvn -v
Maven 的 Pom.xml
什么是“坐標”?
在Maven中,坐標是Jar包的唯一標識,Maven通過坐標在倉庫中找到項目所需的Jar包。
groupId
和 artifactId
構成了一個Jar包的坐標
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>3.9</version>
</dependency>
- groupId:所需Jar包的項目名
- artifactId:所需Jar包的模塊名
- version:所需Jar包的版本號
傳遞依賴 與 排除依賴
- 傳遞依賴:如果我們的項目引用了一個Jar包,而該Jar包又引用了其他Jar包,那么在默認情況下項目編譯時,Maven會把直接引用和簡潔引用的Jar包都下載到本地。
- 排除依賴:如果我們只想下載直接引用的Jar包,那么需要在pom.xml中做如下配置:(將需要排除的Jar包的坐標寫在中)
依賴范圍 scope
在項目發布過程中,幫助決定哪些構件被包括進來。欲知詳情請參考依賴機制。
- compile :默認范圍,用於編譯
- provided:類似於編譯,但支持你期待jdk或者容器提供,類似於classpath
- runtime: 在執行時需要使用
- test: 用於test任務時使用
- system: 需要外在提供相應的元素。通過systemPath來取得
- systemPath: 僅用於范圍為system。提供相應的路徑
- optional: 當項目自身被依賴時,標注依賴是否傳遞。用於連續依賴時使用
依賴沖突
若項目中多個Jar同時引用了相同的Jar時,會產生依賴沖突,但Maven采用了兩種避免沖突的策略,因此在Maven中是不存在依賴沖突的。
- 短路優先
例如下面的引用關系如下:
本項目——>A.jar——>B.jar——>X.jar
本項目——>C.jar——>X.jar
本項目——>A.jar——>B.jar——>X.jar
那么下面中引用的是 C.jar 中的 X.jar
在此時,Maven只會引用引用路徑最短的Jar。
- 聲明優先
若引用路徑長度相同時,在pom.xml中誰先被聲明,就使用誰。而不是后聲明的覆蓋前面的。
聚合
- 什么是聚合?
將多個項目同時運行就稱為聚合。
- 如何實現聚合?
只需在 pom 中作如下配置即可實現聚合:
<modules>
<module>web-connection-pool</module>
<module>web-java-crawler</module>
</modules>
繼承
- 什么是繼承?
在聚合多個項目時,如果這些被聚合的項目中需要引入相同的Jar,那么可以將這些Jar寫入父pom中,各個子項目繼承該pom即可。
- 如何實現繼承?
-父 pom 配置如下
<dependencyManagement>
<dependencies>
<dependency>
<groupId>cn.missbe.web.search</groupId>
<artifactId>resource-search</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>
</dependencyManagement>
- 子項目 pom 配置
<parent>
<groupId>父pom所在項目的groupId</groupId>
<artifactId>父pom所在項目的artifactId</artifactId>
<version>父pom所在項目的版本號</version>
</parent>
<parent>
<artifactId>resource-search</artifactId>
<groupId>cn.missbe.web.search</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
Maven 命令
- -v:查詢Maven版本
本命令用於檢查maven是否安裝成功。
Maven安裝完成之后,在命令行輸入mvn -v,若出現maven信息,則說明安裝成功。
- compile:編譯
將java源文件編譯成class文件
- test:測試項目
執行test目錄下的測試用例
- package:打包
將項目打成jar包
-
clean:刪除target文件夾
-
install:安裝
將當前項目放到Maven的本地倉庫中。供其他項目使用
我們可以使用 mvn clean install 來發布我們的基於 maven 的 spring boot 項目
使用Maven構建Web項目
通常我們使用 IDEA 構件 Maven項目
pom.xml 節點注解說明
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0http://maven.apache.org/maven-v4_0_0.xsd">
<!--父項目的坐標。如果項目中沒有規定某個元素的值,
那么父項目中的對應值即為項目的默認值。
坐標包括group ID,artifact ID和 version。-->
<parent>
<!--被繼承的父項目的構件標識符-->
<artifactId/>
<!--被繼承的父項目的全球唯一標識符-->
<groupId/>
<!--被繼承的父項目的版本-->
<version/>
</parent>
<!--聲明項目描述符遵循哪一個POM模型版本。模型本身的版本很少改變,雖然如此,
但它仍然是必不可少的,這是為了當Maven引入了新的特性或者其他模型變更的時候,
確保穩定性。-->
<modelVersion>4.0.0</modelVersion>
<!--項目的全球唯一標識符,通常使用全限定的包名區分該項目和其他項目。
並且構建時生成的路徑也是由此生成, 如com.mycompany.app生成的相對路徑為:
/com/mycompany/app-->
<groupId>cn.missbe.web</groupId>
<!-- 構件的標識符,它和group ID一起唯一標識一個構件。換句話說,
你不能有兩個不同的項目擁有同樣的artifact ID和groupID;在某個
特定的group ID下,artifact ID也必須是唯一的。構件是項目產生的或使用的一個東西,
Maven為項目產生的構件包括:JARs,源碼,二進制發布和WARs等。-->
<artifactId>search-resources</artifactId>
<!--項目產生的構件類型,例如jar、war、ear、pom。插件可以創建
他們自己的構件類型,所以前面列的不是全部構件類型-->
<packaging>war</packaging>
<!--項目當前版本,格式為:主版本.次版本.增量版本-限定版本號-->
<version>1.0-SNAPSHOT</version>
<!--項目的名稱, Maven產生的文檔用-->
<name>search-resources</name>
<!--項目主頁的URL, Maven產生的文檔用-->
<url>http://www.missbe.cn</url>
<!-- 項目的詳細描述, Maven 產生的文檔用。 當這個元素能夠用HTML格式描述時
(例如,CDATA中的文本會被解析器忽略,就可以包含HTML標 簽),
不鼓勵使用純文本描述。如果你需要修改產生的web站點的索引頁面,
你應該修改你自己的索引頁文件,而不是調整這里的文檔。-->
<description>A maven project to study maven.</description>
<!--描述了這個項目構建環境中的前提條件。-->
<prerequisites>
<!--構建該項目或使用該插件所需要的Maven的最低版本-->
<maven/>
</prerequisites>
<!--構建項目需要的信息-->
<build>
<!--該元素設置了項目源碼目錄,當構建項目的時候,
構建系統會編譯目錄里的源碼。該路徑是相對於pom.xml的相對路徑。-->
<sourceDirectory/>
<!--該元素設置了項目腳本源碼目錄,該目錄和源碼目錄不同:
絕大多數情況下,該目錄下的內容 會被拷貝到輸出目錄(因為腳本是被解釋的,而不是被編譯的)。-->
<scriptSourceDirectory/>
<!--該元素設置了項目單元測試使用的源碼目錄,當測試項目的時候,
構建系統會編譯目錄里的源碼。該路徑是相對於pom.xml的相對路徑。-->
<testSourceDirectory/>
<!--被編譯過的應用程序class文件存放的目錄。-->
<outputDirectory/>
<!--被編譯過的測試class文件存放的目錄。-->
<testOutputDirectory/>
<!--使用來自該項目的一系列構建擴展-->
<extensions>
<!--描述使用到的構建擴展。-->
<extension>
<!--構建擴展的groupId-->
<groupId/>
<!--構建擴展的artifactId-->
<artifactId/>
<!--構建擴展的版本-->
<version/>
</extension>
</extensions>
<!--這個元素描述了項目相關的所有資源路徑列表,例如和項目相關的屬性文件,
這些資源被包含在最終的打包文件里。-->
<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>
<!--模塊(有時稱作子項目) 被構建成項目的一部分。
列出的每個模塊元素是指向該模塊的目錄的相對路徑-->
<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>
<!-- 繼承自該項目的所有子項目的默認依賴信息。這部分的依賴信息不會被立即解析,
而是當子項目聲明一個依賴(必須描述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/>
<!-- 給出該構件在遠程倉庫的狀態。不得在本地項目中設置該元素,
因為這是工具自動更新的。有效的值有:none(默認),
converted(倉庫管理員從 Maven 1 POM轉換過來),partner(直接從伙伴Maven 2倉庫同步過來),deployed(從Maven 2實例部 署),verified(被核實時正確的和最終的)。-->
<status/>
</distributionManagement>
<!--以值替代名稱,Properties可以在整個POM中使用,也可以作為觸發條件(見settings.xml配置文件里activation元素的說明)。格式是<name>value</name>。-->
<properties/>
</project>