配置
Go 1.11 之后官方支持的版本管理工具 升级golang 版本到 1.11以后的 Go下载
GO111MODULE
环境变量 GO111MODULE
开启或关闭模块支持,它有三个可选值:off、on、auto,默认值是 auto。
GO111MODULE=off
无模块支持,go 会从 GOPATH 和 vendor 文件夹寻找包。GO111MODULE=on
模块支持,go 会忽略 GOPATH 和 vendor 文件夹,只根据 go.mod 下载依赖。GO111MODULE=auto
在 $GOPATH/src 外面且根目录有 go.mod 文件时,开启模块支持。 ```go export GO111MODULE=on $ source ~/.bash_profile $ echo $GO111MODULE
<a name="drCM3"></a>
#### goproxy.io
goproxy.io [ Github ](https://github.com/goproxyio/goproxy)可以给go modules 设置全局代理,下载golang/x的包文件 也就就不需要设置replace<br />Linux 和mac OS
```shell
export GOPROXY=https://goproxy.io
powershell (windows)
$env:GOPROXY = "https://goproxy.io"
export GO111MODULE=on
# Set the GOPROXY environment variable
export GOPROXY=https://goproxy.io
通过环境变量设置:
export GOPROXY=https://goproxy.io
在 Intelli Idea 中设置:
Intelli Idea -> Preferences -> Languages & Frameworks -> Go -> Go Modules(vgo),在 Proxy 中输入 https://goproxy.io:
常用命令
go mod help
Go mod provides access to operations on modules.
Note that support for modules is built into all the go commands,
not just 'go mod'. For example, day-to-day adding, removing, upgrading,
and downgrading of dependencies should be done using 'go get'.
See 'go help modules' for an overview of module functionality.
Usage:
go mod <command> [arguments]
The commands are:
download download modules to local cache
edit edit go.mod from tools or scripts
graph print module requirement graph
init initialize new module in current directory
tidy add missing and remove unused modules
vendor make vendored copy of dependencies
verify verify dependencies have expected content
why explain why packages or modules are needed
Use "go help mod <command>" for more information about a command.
命令 | 说明 |
---|---|
download | download modules to local cache (下载依赖的module到本地cache)) |
edit | edit go.mod from tools or scripts (编辑go.mod文件) |
graph | print module requirement graph (打印模块依赖图)) |
init | initialize new module in current directory (初始化.mod 包管理文件到当前工程。) |
tidy | add missing and remove unused modules (增加缺失的module,去掉未用的module) |
vendor | make vendored copy of dependencies (vendor版本的解决方案,将依赖复制到vendor下面) |
verify | verify dependencies have expected content (校验依赖) |
why | explain why packages or modules are needed (解释为什么需要依赖) |
创建Mod
go mod init
go: modules disabled inside GOPATH/src by GO111MODULE=auto; see 'go help modules'
在当前目录下,命令行运行 go mod init + 模块名称 初始化模块
export GO111MODULE=on
$ go mod init server
go: creating new go.mod: module mServer
go: copying requirements from Gopkg.lock
运行完后,会在当前项目目录下生成一个go.mod 文件,这是一个关键文件,之后的包的管理都是通过这个文件管理。
除了go.mod之外,go命令还维护一个名为go.sum的文件,其中包含特定模块版本内容的预期加密哈希,go.sum 文件不需要手工维护。
Cache 路径
默认在$GOPATH/pkg
下面:
$GOPATH/pkg/mod
我们来看看一个项目下载下来的文件形式:
➜ mod ls -lh cache/download/github.com/go-kit/kit/@v/
total 3016
-rw-r—r— 1 a1 staff 7B Sep 29 15:37 list
-rw———- 1 a1 staff 50B Sep 29 15:37 v0.7.0.info
-rw———- 1 a1 staff 29B Sep 29 15:37 v0.7.0.mod
-rw-r—r— 1 a1 staff 1.5M Sep 29 15:37 v0.7.0.zip
-rw-r—r— 1 a1 staff 47B Sep 29 15:37 v0.7.0.ziphash
可以看出项目库会对每个版本创建一个文件夹,文件夹下有对于版本的信息。
工作机制
main.go文件:
package main
import (
"github.com/gin-contrib/pprof"
"github.com/gin-gonic/gin"
)
func main() {
router := gin.Default()
pprof.Register(router)
router.Run(":8000")
}
按照过去的做法,要运行main.go需要执行go get
命令 下载gin包到 $GOPATH/src。
go get -u github.com/gin-gonic/gin
go 会自动查找代码中的包,下载依赖包,并且把具体的依赖关系和版本写入到go.mod和go.sum文件中。
查看go.mod,它会变成这样:
module baxiang.cn/GoNote
go 1.12
replace (
golang.org/x/text => github.com/golang/text v0.3.0
golang.org/x/text v0.3.0 => github.com/golang/text v0.3.0
)
require (
github.com/gin-contrib/pprof v1.2.0
github.com/gin-contrib/sse v0.0.0-20190301062529-5545eab6dad3 // indirect
github.com/gin-gonic/gin v1.3.0
github.com/golang/protobuf v1.3.1 // indirect
github.com/json-iterator/go v1.1.6 // indirect
github.com/mattn/go-isatty v0.0.7 // indirect
github.com/ugorji/go v1.1.4 // indirect
)
module 定义当前模块和包路径
go 定义go版本
require 定义依赖的模块和版本
exclude 排查特定模块和版本的使用
replace 模块源的替换
require关键子是引用,后面是包,最后v1.3.0 是引用的版本号
使用Go mod依赖的第三方包被默认下载到$GOPATH/pkg/mod
路径下。indirect
表示这个库是间接引用进来的。
vendor目录
如果你不喜欢 go mod 的缓存方式,你可以使用vendor命令回到 godep 或 govendor 使用的 vendor 目录进行包管理的方式。
go mod vendor
当然这个命令并不能让你从godep之类的工具迁移到 go modules,它只是单纯地把 go.sum 中的所有依赖下载到 vendor 目录里,如果你用它迁移 godep 你会发现 vendor 目录里的包会和 godep 指定的产生相当大的差异,所以请务必不要这样做。
使用 go build -mod=vendor 来构建项目,因为在 go modules 模式下 go build 是屏蔽 vendor 机制的,所以需要特定参数重新开启 vendor 机制:
go build -mod=vendor
构建成功。当发布时也只需要和使用 godep 一样将 vendor 目录带上即可
版本管理
$ tree -L 1
.
├── gin@v0.0.0-20190328061400-ce20f107f5dc
├── gin@v1.1.4
└── gin@v1.3.0
3 directories, 0 files
在上一个问题里,可以看到最终下载在$GOPATH/pkg/mod
下的github.com/gin-gonic
的gin包@ vx.x.x,代表着不同的version,$GOPATH/pkg/mod
里可以保存相同包的不同版本。
版本是在go.mod中指定的。
如果,在go.mod中没有指定,go命令会自动下载代码中的依赖的最新版本,本例就是自动下载最新的版本。
如果,在go.mod用require语句指定包和版本 ,go命令会根据指定的路径和版本下载包,
指定版本时可以用latest
,这样它会自动下载指定包的最新版本;如果包的作者还没有标记版本,默认为 v0.0.0
go get
新版 go get
可以在末尾加 @
符号,用来指定版本。
它要求仓库必须用 v1.2.0
格式打 tag,像 v1.2
少个零都不行的,必须是语义化的、带 v
前缀的版本号。其中latest
匹配最新的 tag。
go get github.com/gorilla/mux # 匹配最新的一个 tag
go get github.com/gorilla/mux@latest # 和上面一样
go get github.com/gorilla/mux@v1.6.2 # 匹配 v1.6.2
go get github.com/gorilla/mux@e3702bed2 # 匹配 v1.6.2
go get github.com/gorilla/mux@c856192 # 匹配 c85619274f5d
go get github.com/gorilla/mux@master # 匹配 master 分支
https 身份验证
官方文档: https://golang.org/doc/faq#git_https
在当前用户目录下创建 $HOME/.netrc
文件,增加如下内容
machine github.com login USERNAME password APIKEY
machine git服务器的域名
password 是personal access token
,
github的获取方式
gitlab
ssh替换https
如果是私有的git库怎么获取呢?比如在公司使用gitlab搭建的git仓库,,假设你要获取https://gitlab.com/,对应的ssh地址为git@gitlab.com,那么要在终端执行如下命令。
git config --global url."git@gitlab.com:".insteadOf "https://gitlab.com/"
这段配置的意思就是,当我们使用https://gitlab.com/获取git库代码的时候,实际上使用的是git@gitlab.com这个url地址获取的,也就是http到ssh协议的转换,是自动的,上面的命令等于在 $HOME/.gitconfig
配置文件中,增加了如下配置:
[url "git@gitlab.com:"]
insteadOf = https://gitlab.com/
现在我们就可以使用go get
直接获取了,比如:
go get -v -insecure git@gitlab.com/hello
-insecure
标识,因为我们使用的是http协议, 是不安全的。
replace
golang.org/x/… 等包在中国大陆区域无法下载
依赖包地址变更
在go.mod文件里用 replace 替换包地址
replace (
golang.org/x/text => github.com/golang/text latest
golang.org/x/text v0.3.0 => github.com/golang/text v0.3.0
)
go mod会用 github.com/golang/text 替代golang.org/x/text,原理就是下载github.com/golang/text 的最新版本到 $GOPATH/pkg/mod/golang.org/x/text
下。
参考
https://studygolang.com/articles/26694
https://www.cnblogs.com/sunsky303/p/10710637.html
https://xuanwo.io/2019/08/22/go-modules-migrate/
https://hihozhou.com/blog/2019/11/14/go-mod-private.html
https://www.cnblogs.com/hiwz/p/12652153.html
https://www.cnblogs.com/mingbai/p/go13moduleuser.html
https://gitlab.com/gitlab-org/gitlab-foss/-/issues/65681
https://github.com/golang/go/issues/22640
https://iliubang.cn/go/2019/10/17/%E5%9F%BA%E4%BA%8E%E5%85%AC%E5%8F%B8%E7%A7%81%E6%9C%89gitlab%E7%9A%84go-module%E5%AE%9E%E8%B7%B5.html
https://gitlab.com/gitlab-org/gitlab-foss/-/issues/65462#note_199665369
https://blog.csdn.net/zchdjb/article/details/93998416