掌握 Maven 私服
前言
在 Java EE 開發中,我們使用 Maven 構建工具主要來管理專案的第三方庫的依賴,以及公司內部其他專案服務的依賴。因此 Maven 私服就是必不可少的一環,本文主要對 Maven 私服的三大方面進行介紹:
- 什麼是 Maven 私服
- 如何搭建 Maven 私服
- 如何使用 Maven 私服
本文面對的讀者應有 Maven 使用經驗,瞭解 Maven 的一些基本概念,如果不太熟悉可以參見文末的參考資料學習。
什麼是 Maven 私服
在介紹 Maven 私服之前,我們首先清楚下什麼是 Maven 倉庫。
Maven 倉庫:Maven 統一儲存所有Maven專案依賴,外掛,以及所上傳專案的地方。
並且 Maven 倉庫還分成兩類:本地倉庫和遠端倉庫。
- 本地倉庫,就是我們本地電腦安裝Maven後,在 配置檔案 setting.xml 裡
localRepository
所需要指定目錄的那個資料夾。 - 遠端倉庫,就是在外部網路裡(包括區域網)指定 URL 的專門存放 Java 庫,Maven外掛等的伺服器,,例如中央倉庫,就是一個典型的遠端倉庫,它包含了世界上絕大多數開源的 Java 庫,類似的還有許多其他的公開庫
而本文提到的私服,就是另一種特殊的遠端倉庫,它通常架設在區域網內的一臺伺服器上,用於代理所有外部的遠端倉庫,並且能接受內部專案的上傳和獲取。
而這些倉庫又有是什麼用呢?當 Maven 專案需要依賴一些其他專案的 Java 庫時,Maven 首先會在本地倉庫查詢,如果存在對應的庫,就直接使用;如果本地倉庫不存在,Maven 就會去遠端倉庫查詢,找到對應的 Java 庫後下載到本地倉庫再使用,以便於下次需要該Java庫時,直接使用快取在本地倉庫的依賴庫即可,省去了重複通過網路查詢並下載的時間,對於 Maven 外掛也是同樣的過程。
通常情況下,中央倉庫是Maven 預設的遠端倉庫,而當引入了私服後,本地倉庫查詢結束未找到所需要的依賴庫時,就先從私服倉庫開始查詢,仍未找到的話,最後再去中央倉庫查詢,具體過程可以參考下圖:
在這裡我們再看下私服的作用有哪些:
- 內網訪問,節省外網頻寬。
- 一次外網下載,內網所有使用者就可以只下載私服快取,加速 Maven 專案構建。
- 允許上傳和下載私有庫,並且不被外部訪問,更加安全。
- 減少外部網路因素,提供專案構建的穩定性。
- 方便內部專案服務的依賴引用,而不需要其他專案的完整原始碼。
這裡對最後一小點的作用新增下具體描述:當我們有獨立的兩個Maven 專案,比如訂單服務專案和會員服務專案,其中訂單服務專案需要會員服務,依賴會員服務的 API 包,通過私服可以將編譯後的會員服務的 API 包上傳,然後訂單服務程式直接下載引用私服上的會員服務 API 包即可,這樣就不需要匯入會員服務專案程式碼,也不用關心會員服務具體實現了,起到了內部服務專案輕度引用的作用,描述可參見下圖。
搭建 Maven 私服
瞭解 Maven 私服之後,我們進一步學習。我們首先來搭建一個 Maven 私服。在這裡我們使用最流行的開源 Maven 倉庫管理軟體 - Nexus,來快速搭建 Maven 私服,傳統的搭建方式為在 Nexus 官網上下載開源版的 Nexus OSS 進行安裝:www.sonatype.com/nexus-repos… Docker 方式安裝 Nexus,不僅快速簡單,而佔用更少的機器資源。
如果對 Docker 不熟悉的同學,可以參見 10分鐘快速掌握Docker必備基礎知識 學習瞭解下,簡單使用 Docker 也是十分容易的。
下載 Nexus 映象
在終端控制檯上使用 Docker 指令下載 Nexus 官方提供的Docker 映象:
看到下圖結果時,就表示映象下載完成,可以通過 docker images
檢視。
啟動 Nexus 容器
使用下方指令啟動 Nexus 容器:
在這裡對輸入的 Docker 指令的引數進行簡單的說明:
-
-d
表示讓容器後臺執行。 -
-p 8081:8081
表示了容器啟動時開放內部埠 8081(後者的8081) 對映主機埠的 8081 ,即通過localhost:8081
可以訪問到 Nexus 容器所提供的服務。 -
-v /Users/One/Desktop/Nexus/nexus-data:/nexus-data
表示將容器內部/var/nexus-data
掛載到當前主機的指定目錄,需要注意的是,-v
指定的外部路徑必須為全路徑。 -
--restart=always
比較簡單,表示當 docker 服務啟動時,該容器也跟著啟動。
執行上述指令後,稍等片刻,訪問 http://localhost:8081/
,看到對應的 Nexus 後臺就表示私服安裝完成了,是不是很簡單呢。
容器啟動過程中,由於機器配置的不同,可能會出現啟動慢的情況,只需耐心等待即可。
啟動完成後,我們可以在所掛載的本機目錄下檢視 Nexus 容器執行產生的檔案。
配置 Maven 私服
私服安裝之後,我們首先進行登入操作,點選頁面左上角的 Sign In 按鈕,就會出現和下圖一樣的提示:
說明瞭 Nexus 預設登入賬號為 admin,並且密碼位於檔案 /nexus-data/admin.password
下,我們只需在本地配置的掛載目錄下檢視該檔案即可。
輸入預設的賬號密碼之後成功登入之後,Nexus 就會強制要求修改 admin 的密碼,並且設定基本訪問許可權,完成之後就正式進入了 Nexus 私服後臺。
這裡簡單對介面元素進行介紹:
- 預設的瀏覽介面,可以搜尋檢視倉庫的元件,以及進行上傳操作。
- 用於管理私服程式的配置。
- 賬戶資訊檢視,允許修改密碼。
進入私服程式的配置介面,我們需要對預設配置進行幾點調整。
中央倉庫的代理路徑設定
將私服配置裡中央倉庫的代理倉庫路徑更新為阿里雲倉庫提供的代理地址:maven.aliyun.com/repository/… 這樣一來可以更快速地訪問在中央倉庫上所需要的依賴和外掛。
新建自定義的倉庫
點選Create repository
,然後選擇型別為 maven2(hosted)
然後輸入倉庫名稱 private-release,並在 Version policy 一欄中選擇 Release,表示這個倉庫的儲存依賴為正式釋出的元件,然後在 Deployment policy 一欄中選擇 Allow redeploy,允許部署和更新私服上的元件。
最後點選藍色按鈕-Create repository
之後,就可以在倉庫列表看到自定義的倉庫了,有了 release 倉庫,我們再按照同樣方式操作新增一個 snapshot 倉庫,只需在 Version policy 一欄調整為 Snapshot 即可。
新增角色
Nexus 預設只有兩種角色:nx-anonymous
和 nx-admin
,前者只有瀏覽的許可權,後者為管理員許可權,一般情況下,我們還需要正對開發人員建立個角色。點選 Create Role
,新增一個 Role ID 為 developer
的自定義角色,並且只新增自定義倉庫的使用許可權,刪除操作除外。
儲存之後,新增的角色就展示在列表中,有了角色,就可以關聯使用者,進行許可權分配了。
新增使用者
跟許可權類似,預設的使用者只有兩種:admin
和 anonymous
,我們同樣需要建立屬於開發者的使用者物件。點選 Create local user
,填入使用者名稱,密碼等必填資訊之後,關聯我們先前的建立的角色,並儲存即可。
使用者建立完成之後,我們就可以用新的使用者登入私服,檢視對應許可權的內容了,例如我們用新建的使用者登入,所能操作的只有檢視和搜尋自定義的私服倉庫。
這樣一來我們就建立好了自己的私服倉庫,配置完成之後,開發者就可以在 Maven 專案開發中使用了。
使用 Maven 私服
有了私服和用於開發的賬號,我們就需要在本地 Maven 配置檔案 setting.xml 進行關聯。
設定 server 賬戶資訊:
設定私服倉庫地址:(這裡的地址,可以通過 Nexus 後臺上倉庫頁面的 cpoy
按鈕自動複製得到)
Maven 專案部署到私服
配置完成後,我們可以建立一個Maven工程,嘗試下打包到 Maven 私服。利用 IDE 快速生成 Maven 專案,在 POM 檔案新增 distributionManagement
節點,並且指定對應的私服倉庫 id 和地址,如下:
最後只要執行部署命令 mvn clean deploy
或者利用 IDE 的 部署外掛即可,當控制檯出現 BUILD SUCCESS
,如下圖類似時則說明部署完成。
從日誌上可以看出,我們的專案上傳都了 private- snapshot 倉庫下,此時我們可以在私服網站上的 private- snapshot 倉庫檢視到上傳的 jar。
如果部署過程中出現如下提示:帶有
Access denied to
則說明在 setting.xml 配置的使用者許可權不足,無法將 jar 部署到對應私服倉庫上去。
需要注意的是,對於一個Maven專案而言,如果專案的版本號中有 “SNAPSHOT” 字樣,則表示當前處於開發版本,Maven 會將釋出到 snapshotRepository
節點對應地址上去。否則,Maven則認為這是一個釋出版本,將程式釋出到 repository
節點對應的地址上。由於示例專案的版本為 1.0.0-SNAPSHOT
,所以最終專案上傳到了 private-snapshot
這個 Snapshot 型別的倉庫下。
接下來如果其他專案要依賴這個 jar 時,只需要在其 POM 檔案引入對應的座標即可。
將第三方 jar 包部署到 Maven 私服
這裡說到了第三方 jar 包,不是平常所提到的開源庫,更多的是來自其他第三方系統的 jar 包,由於專案需要,使用專案匯入的方式來很不方便,更好的處理方式就是將第三方系統的 jar 包手動上傳到 Maven 私服上,需要使用的專案直接從私服倉庫中拉取即可。
這種方式實現起來也比較方便,分為兩種:視覺化介面操作和命令列操作。
視覺化介面操作:就是在 Nexus 後臺上進去,執行上傳操作必須要對於的上傳許可權才可以,一般都是管理員賬號進行操作,選擇倉庫後進去上傳頁面,指定本地需要上傳的專案,自定義完座標資訊儲存即可。
命令列方式:直接在終端輸入下面指令即可:
- -DgroupId 和 -DartifactId 構成了該jar包在 pom.xml 的座標, 即對應依賴的
groupId
和artifactId
- -
Dfile
表示需要上傳的jar包的絕對路徑 - -Durl 為私服倉庫的url精確地址
- -DrepositoryId 為私服倉庫定義的id
- -Dversion 指定了版本號
- -Dpackaging 指定了打包方式
當控制檯日誌出現 BUILD SUCCESS
資訊時則表示打包成功,如果出現打包失敗,很有可能是 Maven 配置檔案裡 server
元素下的使用者許可權不足導致,需要 Nexus 後臺對使用者角色進行上傳許可權的分配。
結語
在 Java 企業級專案開發中,建立並維護私服是使用 Maven 必不可少的一步,本文從 Maven 的簡單介紹,到快速搭建和使用來進一步掌握 Maven 私服,為後續的企業微服務架構做好鋪墊。
推薦閱讀
參考資料
-
Maven入門,讀完這篇就夠了:juejin.im/post/5a4a5e…
-
Maven 實戰:book.douban.com/subject/534…
-
私服 maven 倉庫命令上傳 jar 包: www.jianshu.com/p/ccd7b6436…
-
What is a Maven Repository:medium.com/@chris.shel…