GoPath模式和GoMoudle模式的相愛相殺

相信看我文章的文章的童鞋,golang版本已是1.3版本以上。若是你的版本還停留在1.3如下,那這篇文章能夠作爲你的提高之法。html

go moudle的前世此生

前世-gopath

gopath是什麼

GOPATH 是什麼,相信已經不用我再多說什麼了。你們深受摧殘多年,應該已經有所體會。在v.1.11版本以前,安裝GO確定要在環境變量中配置GoPath,咱們能夠簡單的將其理解成是工做目錄。目錄結構以下node

-- bin 存放編譯後生成的二進制可執行文件git

-- pkg 存放編譯後生成的 .a 文件程序員

-- src 存放項目的源代碼,能夠是你本身寫的代碼,也能夠是你 go get 下載的包github

將你的包或者別人的包所有放在 $GOPATH/src 目錄下進行管理的方式,咱們稱之爲 GOPATH 模式。golang

gopath有什麼樣的問題?

版本管理問題算法

GOPATH 根本沒有版本的概念,若是你所應用的庫須要升級,那就是全局升級,因此涉及這個庫的服務在下一次編譯中都會使用新的庫,這是一件很危險的事情。版本管理很是重要,本身應該管理好本身的引用庫。shell

協同開發問題npm

當其餘的開發者get到源碼進行修改的時候,你沒法保證他下載的包是否是你所指望的版本,這及有可能致使服務出錯,且很難查找緣由。json

此生-GoMoudle

go modules 在 v1.11 版本正式推出,在發佈的 v1.14 版本中,官方正式發話,稱其已經足夠成熟,能夠應用於生產上。

從 v1.11 開始,go env 多了個環境變量: GO111MODULE ,這裏的 111,其實就是 v1.11 的象徵標誌, go 裏好像很喜歡這樣的命名方式,好比當初 vendor 出現的時候,也多了個 GO15VENDOREXPERIMENT環境變量,其中 15,表示的vendor 是在 v1.5 時才誕生的。

GO111MODULE 是一個開關,經過它能夠開啓或關閉 go mod 模式。

它有三個可選值:offonauto,默認值是auto

  1. GO111MODULE=off禁用模塊支持,編譯時會從GOPATHvendor文件夾中查找包。
  2. GO111MODULE=on啓用模塊支持,編譯時會忽略GOPATHvendor文件夾,只根據 go.mod下載依賴。
  3. GO111MODULE=auto,當項目在$GOPATH/src外且項目根目錄有go.mod文件時,自動開啓模塊支持。

go mod 出現後, GOPATH(確定沒人使用了) 和 GOVENDOR 將會且正在被逐步淘汰,可是若你的項目仍然要使用那些即將過期的包依賴管理方案,請注意將 GO111MODULE 置爲 off。

具體怎麼設置呢?可使用 go env 的命令,如我要開啓 go mod ,就使用這條命令

go env -w GO111MODULE="on"

go mod 使用

go mod 再也不依靠 $GOPATH,使得它能夠脫離 GOPATH 來建立項目

你能夠在你電腦的任意位置建立一個文件夾go_demo

使用 go mod 命令初始化,此時目錄下只有2個文件,go.mod是執行命令後生成的文件。

go mod init go_demo

image-20210316171010002

文件main.go解釋:引入一個now的時間處理庫,輸出時間

package main

import (
	"fmt"

	"github.com/jinzhu/now"
)

func main() {
	fmt.Println("hello world", now.BeginningOfDay())
}

go.mod內容

module go_demo

go 1.15

require github.com/jinzhu/now v1.1.1

內容解釋:

  • 第一行:模塊的引用路徑
  • 第二行:項目使用的 go 版本
  • 第三行:項目所需的直接依賴包及其版本

此時咱們在命令行執行go build進行編譯,發現多了一個go.sum文件,那麼這個文件又是什麼?

image-20210316171039541

go.sum 文件相比go.mod就比較複雜了。雖然內容多,可是也不難理解。

每一行都是由 模塊路徑模塊版本哈希檢驗值 組成,其中哈希檢驗值是用來保證當前緩存的模塊不會被篡改。hash 是以h1:開頭的字符串,表示生成checksum的算法是初版的hash算法(sha256)。


go.mod 和 go.sum 是 go modules 版本管理的指導性文件,所以 go.mod 和 go.sum 文件都應該提交到你的 Git 倉庫中去,避免其餘人使用你寫項目時,從新生成的go.mod 和 go.sum 與你開發的基準版本的不一致。


go mod的好處

相比gopath的方式,go mod的好處顯而易見。你沒必要爲了版本依賴費勁頭腦,模塊化自動幫你作好了。這就有點C#中Nuget的味道,node的npm的感受。開發者不該爲了這種事情操心,而應該專一於編碼問題。

go mod 命令使用

經常使用

go mod init:初始化go mod, 生成go.mod文件,後可接參數指定 module 名,上面已經演示過。

go mod download:手動觸發下載依賴包到本地cache(默認爲$GOPATH/pkg/mod目錄)

go list -m -json all:以 json 的方式打印依賴詳情

不經常使用

  • go mod graph: 打印項目的模塊依賴結構
  • go mod tidy :添加缺乏的包,且刪除無用的包
  • go mod verify :校驗模塊是否被篡改過
  • go mod why: 查看爲何須要依賴
  • go mod vendor :導出項目全部依賴到vendor下
  • go mod edit :編輯go.mod文件

如何看待go moudle並應用於工做

go mode 方式確定是推薦的一種方式,若是不是基於歷史項目-使用GOPATH,推薦儘快使用go mod方式,這能讓你省去不少糟心的事情。可是若是公司的項目還有很多就是基於gopath方式的,那你也不要着急,gopath的舊項目也是支持切換成go mod模式的,方式也很簡單,你們動動小手,一百度就能夠。固然正式的切換確定是須要領導贊成的,畢竟工做系統隨意切換仍是有風險的。

參考文章

一文搞懂 Go Modules

關於我

做者博客|文章首發

最後

本文到此結束,但願對你有幫助 😃

若是還有什麼疑問或者建議,能夠多多交流,原創文章,文筆有限,才疏學淺,文中如有不正之處,萬望告知。

更多精彩技術文章彙總在個人 公衆號【程序員工具集]】,持續更新,歡迎關注訂閱收藏。

wechat.png

相關文章
相關標籤/搜索