原文来源于:https://www.yii666.com/blog/337821.html

原标题:Go Mod引用私有库

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

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

  • 本文最新状态查看链接:Go Mod引用私有库

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

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

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

module gitlab.example.com/A
replace "gitlab.example.com/B" => "../B
go get your@master deps@master

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

2.1. 配置go环境变量

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

go env -w GO111MODULE=on

2.2. 设置 Go GOPRIVATE 变量

# 配置多个私有项目地址
go env -w GOPRIVATE="gitlab.example.com"
# 其中gitee.com/user 是你的个人账户所在地址

2.3. Golang项目非代理NOPROXY配置

如果设置GONOPROXY和GONOSUMDB均为none,意味着所有module,不管是公共的还是私有的,都要经过proxy下载,经过sumdb验证;默认情况下,如果设置GOPRIVATE,会自动设置GONOPROXY和GONOSUMDB;即可不配置如下:

GONOPROXY= "gitlab.example.com"
GONOSUMDB= "gitlab.example.com"

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

3.1. 必要条件

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

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

创建文件 ~/.netrc

$ vi ~/.netrc
machine  gitlab.example.cn
login <gitlab_user_name>
password <personal_access_token>
  • 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 config --global url."https://${user}:${personal_access_token}@gitlab.example.com".insteadOf "https://gitlab.example.com"
  • Git全局配置查看和删除
#查看git全局配置
git config --global -l
# 删除url路径替换, 或是修改${GitProject}/.git/config文件中对应url
git config --global --unset url..insteadOf

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

git config --global url..insteadOf "https://gitlab.example.com"
  • 多ssh认证

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:文章地址https://www.yii666.com/blog/337821.html

$ ~/.ssh/config
Host github-personal
    Hostname github.com #网站地址
    User git        #git ssh访问
    IdentityFile ~/.ssh/id_ed25519_personal  #区别在于指定不通key

Host github-work
    Hostname github.com
    User git
    IdentityFile ~/.ssh/id_ed25519_work

# git配置
[url "git@github-work:"]
	insteadOf = "https://github.com/work/"
[url "git@github-personal:"]
    insteadOf = "https://github.com/personal/"

Gitlab Bug: Sub Groups

该问题,建议采用netrc的方式解决;直接可以规避SubGroups的bug问题;网址:yii666.com

  • 如果非要采用git ssh/https方式改动,可以参考文章Go Module 工程化实践(二):go get 取包原理篇

go get的源码实现中,包的查询路径是通过一组正则匹配出来的;下载golang的代码后,查看文件 /usr/lib/golang/src/cmd/go/internal/get/vcs.go; 修改私有仓库正则表达式,并在实例路径 G O R O O T / s r c / c m d / g o 路 径 下 编 译 g o 的 二 进 制 文 件 , 拷 贝 到 {GOROOT}/src/cmd/go路径下编译go的二进制文件,拷贝到 GOROOT/src/cmd/go路径下编译go的二进制文件,拷贝到{GOROOT}/bin路径下即可;文章来源地址:https://www.yii666.com/blog/337821.html

4. Golang私有项目的http访问

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

go: gitee.com/modules/[email protected]: unrecognized import path "gitee.com/modules/project": https fetch: Get "https://gitee.com/modules/project?go-get=1": dial tcp 123.123.123:443: connect: connection refused

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

go get -insecurego env -w GOINSECURE=gitee.com/user_name

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

 gitlab.example.cn/[email protected]: invalid version: unknown revision 000000000000
//go.mod文件
module gitlab.example.cn/projectA
go 1.16
require (
    //因projectB并没有打tag,这里通过指定master分支,自动获取其hash值;也可指定其他分支;
    gitlab.example.cn/projectB master
)
go mod tidy
#如果有层级依赖,采用如下方法
#go get your@master deps@master
//go.mod文件
module gitlab.example.cn/projectA
go 1.16
require (
    //因projectB并没有打tag,这里通过指定分支,自动获取其版本值,版本号-时间戳-提交Hash值;
    gitlab.example.cn/projectB v0.0.0-20220523020601-cbdabf7b07db
)

6. 参考文章

go get