Go Module 常见问题

为什么使用Go Module?

不需要将项目放在GOPATH以及长长的路径下
依赖库的版本控制
有GOPROXY，拉取任何代码都十分方便

如何使用

在go module才诞生的前几个版本中使用它你会遇到诸多疑难杂症，但在1.13版本中go module已经足够完善，所以我推荐升级到1.13版本。这篇文章记录的也是在Go1.13环境下遇到的问题。

如何使用并不是此文重点，所以请读官方文章：

using-go-modules
go1.13

常见问题

Proxy

我们的项目总会依赖到墙外的包，如google.golang.org/grpc、golang.org/x/net，在没有go module的时候我们有很多复杂的办法来获取他们，但现在不需要再这么麻烦，只需要一行代码：

go env -w GOPROXY=https://goproxy.cn,direct

设置好GOPROXY之后，在go module环境下（运行过 go mod init的文件夹中）拉取墙外的包：go get golang.org/x/net就会飞快。

私有仓库

go module有在服务器端CheckSum的验证逻辑，但私有仓库无法被外部服务器访问，所以私有仓库无法像公共仓库一样正常被go module获取。

为了解决这个问题，Go1.13引入了新的环境变量：GOPRIVATE。

例如内部包路径是这样：go.bysir.top/xxx/xxx，那我们就可以如下设置

go env -w GOPRIVATE=go.bysir.top

它是前缀匹配的，设置为go.bysir.top则意味着所有以go.bysir.top开头的包都会被视为是私有的。

私有的包不会走代理，也不会有CheckSum逻辑。

好了，现在解决了go mod的问题，却还有一个更严峻的问题是如何让我们自己的服务器（或电脑）有权限获取这个仓库呢？

假设私有包名是go.bysir.top/go，那么我们要获取这个包则需要运行以下Shell：

go get go.bysir.top/go

如果你是在开发机器上获取这个私有包，可能会很顺利的获取到私有包，这是因为很可能在这个机器上已经记录了仓库的登陆账号密码，你可以查看这个git文档了解原理：Git-工具-凭证存储。否则的话，可能会遇到下面的错误

get "go.bysir.top/go": found meta tag get.metaImport{Prefix:"gitlab.com/xxx", VCS:"git", RepoRoot:"https://go.bysir.top/go.git"} at //go.bysir.top/go?go-get=1
go get go.bysir.top/go: git ls-remote -q https://go.bysir.top/go.git in /Users/bysir/go/pkg/mod/cache/vcs/91fae55e78195f3139c4f56af15f9b47ba7aa6ca0fa761efbd5b6e2b16d5159d: exit status 128:
    fatal: could not read Username for 'https://go.bysir.top': terminal prompts disabled
Confirm the import path was entered correctly.
If this is a private repository, see https://golang.org/doc/faq#git_https for additional information.

解决办法之一是先使用git clone一次仓库，git clone https://go.bysir.top/go.git，输入账号密码，目的是让git记录上账号密码。

如果你是在CI机器上获取这个私有包，那么更好的方式是刚刚的错误提示中提到的文章(https://golang.org/doc/faq#git_https)中的方法：

配置.netrc

echo "machine {Server} login {Repo UserName} password {Password}"> ~/.netrc

例如

machine go.bysir.top login bysir password mypwd

自定义包名

一般来说私有仓库的git地址并不美观，就拿coding来说，它的项目地址是这样的：https://e.coding.net/bysir/go.git，我们并不想拿它当做包名，那我们是否可以自定义导入包名呢？

github上有一个程序可以用来实现自定义导入包名：Go Vanity URLs

Go Vanity URLs is a simple App Engine Go app that allows you to set custom import paths for your Go packages.

原理很简单：go-import meta tag