業務需求開發的時候,我們總是會遇到拉不到依賴包的情況。此時如果不清楚 Maven 拉取依賴包的原理,那麼很可能找不到問題所在。今天樹哥就帶大家瞭解下 Maven 拉包的原理,讓你在遇到問題的時候能快速解決!
三種倉庫
在 Maven 中,倉庫指的是存放代碼構建的一個位置。從分類上來說,Maven 倉庫有兩種類型,分別是:
- 本地倉庫(Local)
- 遠程倉庫(Remote)
本地倉庫,是存在於本地的一個倉庫,它用來緩存下載的依賴包。這樣就不用每次都通過網絡去拉取依賴包了,提高了依賴拉取速度,減輕了倉庫服務器的壓力。
遠程倉庫,如其名字所述,其實位於遠程服務器的一個倉庫。例如有些公司自己對外開放了一些 API,需要將這些 API 的依賴開放出去,這時候就可以將 API 的 Jar 包放到公司自己的遠程倉庫中。公司的客戶可以通過連接該倉庫下載 Jar 包。例如你們公司開發了自己的基礎工具類,並將其打成了一個 Jar 包。此時你可以將該 Jar 包部署到公司自己的遠程倉庫中,公司其他開發夥伴配置該遠程倉庫,從而可以拉取到該 Jar 包依賴。
在網上其他資料中,還會提到 Maven 倉庫有另一個類型 —— 中央倉庫(Central)。但在我看來,中央倉庫其實是一個特殊的遠程倉庫。 它的特殊之處在於,它是 Maven 官方提供的,其中包括了大量常用的庫,基本上大多數的依賴包都可以在這裏找到。另外一個特殊之處在於,中央倉庫的地址是內置在 Maven 源碼中的,即默認會向中央倉庫拉取依賴,這個在後續的依賴搜索順序中會講到。
而我們經常說的私服,其實也是一個特殊的遠程倉庫,其特殊之處在於:它只對公司內部開放,方便存放一些本團隊創建的開發庫。我們經常說的阿里雲 Maven 庫,其實就是一個遠程倉庫,只不過其是對所有人開放罷了。
依賴搜索順序
弄懂了倉庫的類型,我們繼續來了解下依賴的搜索順序。
我們在開發過程中找不到依賴包,有多種原因,例如:
- 依賴包確實沒有放到遠程倉庫
- 倉庫配置有問題
- 等等
爲了弄清楚到底是什麼原因導致依賴找不到,我們需要了解 Maven 是如何找一個依賴的。簡單來說,Maven 搜索依賴的算法如下:
- 首先,在本地倉庫搜索,如果找不到則繼續下一步。
- 接着,在中央倉庫搜索,如果找不到則繼續下一步。
- 最後,在遠程倉庫中搜索,如果找不到則拋出錯誤。如果沒有設置遠程倉庫,那麼拋出錯誤。如果找到了依賴,那麼就下載到本地倉庫緩存。
簡單地說,Maven 搜索遵循簡單的順序 —— 本地倉庫 -> 中央倉庫 -> 遠程倉庫
。弄明白了這個依賴搜索順序,可以幫助我們更好地排查問題。但這可能還不夠,我們還需要搞清楚 Maven setting.xml
中的一些配置信息,從而可以排查是否是配置出現了問題。例如:有時候我們配置了 mirror 鏡像,會把對某個倉庫的請求轉發到另一個倉庫,這時候你要是不懂 mirror 配置,你就找不到問題所在了。
配置信息
關於倉庫的一些常見的配置項有:
- repositories
- mirror
- server
- 等等
下面我們將一個個講解他們的作用。
repositories 標籤
repositories 標籤用於定義遠程倉庫,其配置範例如下所示:
<repositories>
<repository>
<!--公司鏡像的唯一標識,這個配置要注意,不能與mirrorOf配置的相同,不然會被攔截,重定向到外網的鏡像倉庫 -->
<id>nexus</id>
<!--倉庫描述,隨意寫 -->
<name>xxxx</name>
<!-- 公司私有倉庫地址,這個很重要不能錯-->
<url>http://xxx:8081/nexus/content/groups/public</url>
<!-- 是否開啓 releases 包的下載及更新策略 -->
<releases>
<enabled>true</enabled>
<updatePolicy>daily</updatePolicy>
</releases>
<!-- 是否開啓 snapshots 包的下載及更新策略 -->
<snapshots>
<enabled>false</enabled>
<checksumPolicy>warn</checksumPolicy>
</snapshots>
<layout>default</layout>
</repository>
</repositories>
repositories 標籤既可以在 setting.xml
文件配置,也可以在 pom.xml
文件中配置。Maven 在拉取依賴的時候,是按照聲明的順序從上到下去對應的遠程倉庫拉取依賴的。
mirror 標籤
mirror 標籤用於定義倉庫鏡像,其相當於一個攔截器。當 mirror 的 mirrorOf
值與 repository 的 id
相同時,repository 定義的倉庫會被攔截,轉而使用 mirror 中定義的倉庫地址。配置範例如下:
<!--使用xx公司私有倉庫替換Maven默認的中央倉庫 -->
<mirrors>
<mirror>
<!--自己公司的鏡像的唯一標識,在mirror標籤中,其實沒啥用:如xiaoyaziyun -->
<id>xiaoyaziyun</id>
<!--倉庫描述,隨意寫 -->
<name>xx公司私有倉庫地址</name>
<!--xx公司私有倉庫地址,這個很重要不能錯-->
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
<!--`central`爲Maven中央倉庫的標識,替換Maven源碼內默認的是中央倉庫地址-->
<mirrorOf>central</mirrorOf>
</mirror>
</mirrors>
如上圖配置所示,Maven 會用 http://maven.aliyun.com/nexus/content/groups/public/
這個倉庫鏡像替換 Maven 中央倉庫,其中 central
是 Maven 中央倉庫的 ID 標識。我們經常說用阿里雲的 Maven 倉庫可以提速,其實就是使用這種方法實現的。
server 標籤
大部分遠程倉庫無須認證就可以訪問,但我們自己搭建的 Maven 倉庫,處於安全方面的考慮,我們會設置訪問權限。此時,我們需要在 setting.xml
文件中配置 server標籤。配置示例如下代碼所示:
<settings>
<!--配置遠程倉庫認證信息-->
<servers>
<server>
<id>shuyi-tech-repo</id>
<username>admin</username>
<password>admin123</password>
</server>
</servers>
</settings>
上面的配置爲 repository id 爲 shuyi-tech-repo
的遠程倉庫配置了用戶名和密碼,其中用戶名爲 admin
,密碼爲 admin123
。這裏通過 server.id
與 reposiroty.id
標籤將認證信息與倉庫綁定在一起,因此在配置的時候需要保持這兩個信息一致,否則可能導致訪問失敗。
其他標籤
proxy
標籤:服務器不能直接訪問外網時需要設置的代理服務,不常用。
profiles
標籤:上面提到mirror
,配置多個只會一個有效,如果需要多倉庫配置,可以在profiles節點下配置多個profile,但是配置需要激活,特別麻煩,也不常用。
配置文件優先級
對於 Maven 來說,我們會看到有多個配置文件:
- 項目 pom.xml 文件
.m2/settings.xml
文件- Maven 安裝目錄
/conf/settings.xml
文件
如果一個配置同時存在於多個位置,那麼到底以哪個爲準呢?簡單地說,這幾個配置文件的優先級是怎樣的呢?如果沒搞懂這個問題,那麼我們排查問題的時候可能會一團糟。
其實三者的優先級是 pom.xml
>/用戶/.m2/settings.xml
>/maven安裝目錄/conf/settings.xml
。如果要設置全局 Maven 倉庫配置,需要在 Maven 安裝目錄 /conf
下找到 settings.xml
來修改。