Go Mod引用私有库

  • Code, Golang
  • 580 clicked

在Go 1.11之后推出了依赖包管理工具Go Modules之后,Go项目可以在 GOPATH 之外的位置创建,当项目中仅使用了公有库作为依赖时,使用 go get 或 go mod 更新依赖一切如初,没有任何问题。

由于Go Modules默认使用代理去更新依赖,所以当使用了私有仓库作为依赖时,Go更新依赖的相关命令将不再可用。

1. 基础方式:Golang私有项目的路径替换

如果私有项目A依赖另一个私有项目B,且通过go get无法获取权限,可以采用replace方式;

在A项目中的go.mod文件中,加入 replace 操作;

  • Go Get模式下,私有module多级引用: go get your@master deps@master

2. 高级方式:go mod私有项目的访问

2.1. 配置go环境变量

go get通过代理服务拉取私有仓库(企业内部module或托管站点上的private库),而代理服务不可能访问到私有仓库,会出现了404错误. Go提供了一个方便的解决方案:GOPRIVATE环境变量。通过以下配置,可以实现更新私有库依赖。

2.2. 设置 Go GOPRIVATE 变量

  • 默认情况下,如果设置GOPRIVATE,会自动设置GONOPROXY和GONOSUMDB配置;
  • Golang项目非代理NOPROXY配置

    如果设置GONOPROXY和GONOSUMDB均为none,意味着所有module,不管是公共的还是私有的,都要经过proxy下载,经过sumdb验证;

3. Go到私有仓库的请求认证

3.1. 必要条件

  • GitLab 实例必须能够通过HTTPS访问
  • 必须拥有私有访问秘钥,或是access token,或是ssh key;

3.2. 方法一:Go请求的认证, 创建.netrc文件

  • Linux下创建文件~/.netrc

    其中<gitlab_user_name>为gitlab的用户名,<personal_access_token>为在gitlab中申请的私有access token,对private级别项目也可生效;

  • Windows系统下, Go 读取文件为 ~/_netrc而不是Linux下的 ~/.netrc

  • Go命令不会在非安全链接下传输证书,所以它会通过Go创建的https请求完成认证,而不是通过Git创建的认证请求;

  • personal_access_token申请如下

3.3. 方法二:Git请求认证

如果Go无法通过代理获取module,会使用Git。 Git使用.netrc文件完成认证请求,但是也可通过其他认证方法。下面也可通过Git配置:

3.3.1. 在请求URL中嵌入认证信息Access_Token

  • Git全局配置查看和删除

3.3.2. 使用SSH替换HTTPS进行认证

The explicit env settings are unnecessary
The tidy should be called before vendor to have a consistent state
You can setup git and ssh configs(~/.ssh/config) so they will automatically use the right profiles:

4. Gitlab Bug: Sub Groups

该问题,建议采用netrc的方式解决;直接可以规避Gitlab中SubGroups的bug问题;例如gitlab.example.com/subgroup1/subgroup2/project1

go get的源码实现中,包的查询路径是通过一组正则匹配出来的;下载golang的代码后,查看文件 /usr/lib/golang/src/cmd/go/internal/get/vcs.go; 修改私有仓库正则表达式,并在实例路径${GOROOT}/src/cmd/go路径下编译go的二进制文件,拷贝到${GOROOT}/bin路径下即可;

5. Golang私有项目的http访问

如果私有库不支持https协议,会报如下的错误。这是因为Go更新依赖时,会强制校验CA证书来确保依赖库的安全性。

如果私有库不支持https协议,还需要go配置参数或环境变量,使其使用http方式访问

5.1. 方法一go get -insecure

使用 go get -insecure,这种方式不推荐,原因如下:

  • 添加 -insecure 参数即表示更新依赖时可以不去校验CA证书,但是这会带来一个问题:范围无法界定(overkill),所有与要更新依赖相关联的依赖,均不会去做校验,可能会意外更新到不安全的依赖。
  • -insecure 仅支持 go get 命令,不支持 go mod 命令,因此使用 go mod 命令时是无法更新不支持https协议的私有库的。

5.2. 方法二GOINSECURE

添加 GOINSECURE 参数,推荐这种方式

  • 在Go 1.14中增加了新的环境变量,用于指定哪些域名下的仓库不去校验CA证书。
  • 使用方式同 GOINSECURE 类似 go env -w GOINSECURE=gitlab.example.com

6. 版本解决:invalid version: unknown revision 000000000000

在私有仓库中,暂时没有打tag指定版本。这里通过指定分支,实现对应hash值得指定;报错如下: gitlab.example.cn/projectB@v0.0.0-00010101000000-000000000000: invalid version: unknown revision 000000000000

  1. 修改go.mod指定库的版本到指定分支

  2. 执行go mod tidy命令,自动检出对应版本;

    查看配置自动更新如下:

7. 参考文章

赞赏

微信赞赏支付宝赞赏

发表评论

邮箱地址不会被公开。 必填项已用*标注