Hello,Go module proxy

https://tonybai.com/2018/11/26/hello-go-module-proxy/
十一月 26, 2018 0 条评论

一. Go module引入的幸福与“无奈”

《Go 1.11中值得关注的几个变化》一文中,我们知道了Go语言通过引入module的概念进而引入了Go tool的另外一种工作模式module-aware mode。在新的工作模式下,Go module支持了Versioned Go,并初步解决了包依赖管理的问题。

对于全世界绝大多数Gophers来说,Go module的引入带来的都是满满的幸福感,但是对于位于中国大陆地区的Gopher来说,在这种幸福感袭来的同时,也夹带了一丝“无奈”。其原因在于module-aware mode下,go tool默认不再使用传统GOPATH下或top vendor下面的包了,而是在GOPATH/pkg/mod(go 1.11中是这个位置,也许以后版本这个位置会变动)下面寻找Go module的local cache。

由于众所周知的原因,在大陆地区我们无法直接通过go get命令或git clone获取到一些第三方包,这其中最常见的就是golang.org/x下面的各种优秀的包。但是在传统的GOPATH mode下,我们可以先从golang.org/x/xxx的mirror站点github.com/golang/xxx上git clone这些包,然后将其重命名为golang.org/x/xxx。这样也能勉强通过开发者本地的编译。又或将这些包放入vendor目录并提交到repo中,也能实现正确的构建。

但是go module引入后,一旦工作在module-aware mode下,go build将不care GOPATH下或是vendor下的包,而是到GOPATH/pkg/mod查询是否有module的cache,如果没有,则会去下载某个版本的module,而对于golang.org/x/xxx下面的module,在大陆地区往往会get失败。

有朋友可能会说,可以继续通过其他mirror站点下载再改名啊?理论上是可行的。但是现实中,这样做很繁琐。我们先来看看go module的专用本地缓存目录结构:

  1. /Users/tony/go/pkg/mod $tree -L 7
  2. .
  3. ├── cache
  4. └── download
  5. └── golang.org
  6. └── x
  7. └── text
  8. └── @v
  9. ├── list
  10. ├── v0.1.0.info
  11. ├── v0.1.0.mod
  12. ├── v0.1.0.zip
  13. ├── v0.1.0.ziphash
  14. ├── v0.3.0.info
  15. ├── v0.3.0.mod
  16. ├── v0.3.0.zip
  17. └── v0.3.0.ziphash
  18. └── golang.org
  19. └── x
  20. ├── text@v0.1.0
  21. └── text@v0.3.0

我们看到mod下的结构是经过精心设计的。cache/download下面存储了每个module的“元信息”以及每个module不同version的zip包。比如在这里,我们看到了golang.org/x/text这个module的v0.1.0和v0.3.0两个版本的元信息和对应的源码zip;同时mod下还直接存有text module的两个版本v0.1.0和v0.3.0的源码。

如果我们还像GOPATH mode下那种通过“mirror站下载再改名”的方式来满足go build的需求,那么我们需要手工分别制作某个module的不同版本的元信息以及源码目录,制作元信息时还要了解每个文件(比如:xx.info、xxx.mod等)的内容的生成机制,这样的方法的“体验”并不好。

二. “解铃还须系铃人” – 使用Go module proxy

那么问题来了:大陆Gopher如何能在go module开启的状态下享受go module带来的福利呢? “解铃还须系铃人”!答案就在go 1.11中。Go 1.11在引入go module的同时,还引入了Go module proxy(go help goproxy)的概念。

go get命令默认情况下,无论是在gopath mode还是module-aware mode,都是直接从vcs服务(比如github、gitlab等)下载module的。但是Go 1.11中,我们可以通过设置GOPROXY环境变量来做一些改变:让Go命令从其他地方下载module。比如:

  1. export GOPROXY=https://goproxy.io

一旦如上面设置生效后,后续go命令会通过go module download protocol与proxy交互下载特定版本的module。聪明的小伙伴们一定想到了。如果我们在某个国外VPS上搭建一个go module proxy server的实现,我们将可以通过该proxy下载到类似golang.org/x下面的module。与此同时,一些诸如从github.com上get package慢等次要的问题可能也被一并fix掉了。

显然Go官方加入go proxy的初衷并非为了解决中国大陆地区的下载qiang外包的烦恼的。但不可否认的是,GOPROXY让gopher在versioned go的基础上,对module和package的获取行为上增加了一层控制和干预能力。

三. Go module proxy的实现之一:athens

至于proxy具体带来怎样的控制和干预能力、给gopher带来哪些好处,就要看我们选择了哪种go module proxy的具体实现了。

当前go module proxy的一个受关注度较高的实现是微软Azure开发人员Aaron Schlesinger主导开源athens。athens项目的目标是致力于建设一个联合的、组织良好的go proxy网络(而不是单一的global go module proxy),以提升gopher使用module的体验。athens项目重点关注于:

  • Go module代理服务器的实现,用于边缘部署
  • 一个带身份验证的module proxy的协议
  • 一个module公证服务器,用来验证module源代码
  • 满足企业级需求,提供一种方案让企业可以指定包含/排除的Go外部module列表

athens项目从今年8月份宣布开源到现在依旧很年轻,截止至本文发布时,athens刚刚发布了第一个Beta版本v0.2.0,还尚未发布正式的1.0.0版本。

接下来,我们来试用一下athens,并对其主要功能进行一些验证。

1. 安装athens

athens的工作原理并不复杂,athens在收到用户请求的时候,会检查本地缓存是否有对应版本的module,如果有,则直接返回应答;如果没有。则会向upstream vcs请求下载对应的module。获取成功后cache到本地,并給请求端返回应答。athens强调”immutable(不变性)”的理念。这样即便upstream vcs的原始module对应的repo被删除了或被force push破坏了,只要module缓存在athens自己的存储上了,客户端的module请求就会得到满足,gopher的build不会因为repo被删除而受到破坏。

athens目前提供了基于docker和基于k8s的安装方式(物理binary安装目前尚未提供)。我们选择在一个国外的VPS上使用docker方式安装athens:

  1. # docker run -d -v /root/athens-storage:/var/lib/athens -e ATHENS_DISK_STORAGE_ROOT=/var/lib/athens -e ATHENS_STORAGE_TYPE=disk --name athens-proxy --restart always -p 3000:3000 gomods/athens:v0.2.0
  2. 30cdcc55028de0028eae910758a6ee08ecaf960ab0e79a25e8a1353b8e8ff57c
  3. # docker ps
  4. CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
  5. 30cdcc55028d gomods/athens:v0.2.0 "athens-proxy -con..." 12 seconds ago Up 12 seconds 0.0.0.0:3000->3000/tcp athens-proxy
  6. # docker logs -f athens-proxy
  7. buffalo: Unless you set SESSION_SECRET env variable, your session storage is not protected!
  8. time="2018-11-26T09:59:09Z" level=info msg="Exporter not specified. Traces won't be exported"
  9. buffalo: Starting application at :3000

我们使用local disk作为athens的存储方案。我们在本地建立/root/athens-storage目录,并将其挂载到容器的/var/lib/athens路径下,并设定ATHENS_DISK_STORAGE_ROOT=/var/lib/athens。从athens container的启动日志来看,容器已经启动成功了!

2. 通过athens下载public repo中的module

接下来我们来验证一下通过athens获取public module。我们还使用gocmpp这个代码,它依赖golang.org/x/text module下面的package。

img{512x368}

我们首先clean一下$GOPATH/pkg/mod,然后设置一下GOPROXY环境变量:

  1. export GOPROXY=YOUR_VPS_IP:3000

接下来,我们进入到gocmpp目录下,执行go build:

  1. $go build
  2. go: finding golang.org/x/text v0.3.0
  3. go: downloading golang.org/x/text v0.3.0

我们看到go compiler顺利下载了golang.org/x/text module相关文件。再来看一下athens的日志:

  1. # docker logs -f athens-proxy
  2. handler: GET /golang.org/x/text/@v/v0.3.0.info [200]
  3. handler: GET /golang.org/x/text/@v/v0.3.0.mod [200]
  4. handler: GET /golang.org/x/text/@v/v0.3.0.zip [200]

如果此时我们再次尝试通过athens获取text module,由于text module已经cache到了athens上,所以后续的get速度会很快。并且由于download protocol中获取module是通过get zip包的方式,理论上也要比clone repo快许多。

3. 通过athens下载private repo中的module

athens这个go module proxy的实现为module get行为提供的额外控制力之一就包括可以用来获取private repo中的module,这也是一个企业级的需求。通常企业private repo都是有身份验证的,因此我们需要在athens中配置访问private repo的账号和凭证信息。目前athens官方文档中提供了通过.netrc方式访问带有身份验证的private repo的功能,这种方式的不足之处就是要将password明文形式存储在athens部署的host上。

我用bitbucket上的一个private repo来模拟私有git仓库:bitbucket.org/bigwhite/mydog。

img{512x368}

为了让athens可以正常访问该private repo,我们需要为athens做一些额外配置:添加.netrc。

我们创建.netrc文件:

  1. //.netrc
  2. machine bitbucket.org
  3. login MY_USERNAME1
  4. password MY_PASSWORD1
  5. machine gitlab.com
  6. login MY_USERNAME2
  7. password MY_PASSWORD2

我们在.netrc中配置了我们访问各大repo service的user和password。

接下来,我们需要重新创建一下athens container:

先停掉并删除当前athens-proxy container:

  1. # docker ps
  2. CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
  3. 30cdcc55028d gomods/athens:v0.2.0 "athens-proxy -con..." 3 hours ago Up 3 hours 0.0.0.0:3000->3000/tcp athens-proxy
  4. # docker stop athens-proxy
  5. athens-proxy
  6. # docker rm athens-proxy
  7. athens-proxy

重新创建athens container时,我们将前面创建的.netrc挂载到container中,并通过ATHENS_NETRC_PATH指定container内.netrc的位置:

  1. # docker run -d -v $ATHENS_STORAGE:/var/lib/athens -v /root/athens-install:/root -e ATHENS_NETRC_PATH=/root/.netrc -e ATHENS_DISK_STORAGE_ROOT=/var/lib/athens -e ATHENS_STORAGE_TYPE=disk --name athens-proxy --restart always -p 3000:3000 gomods/athens:v0.2.0
  2. 751c88648fd4075aa22ff3a4cc62f6467b50d415b6fbf465af247fc6a3978c2e

接下来,我们就来编写一个“驱动”程序:testmydog

  1. $tree ./testmydog
  2. ./testmydog
  3. ├── go.mod
  4. └── main.go
  5. 0 directories, 2 files

main.go的内容如下:

  1. package main
  2. import (
  3. "fmt"
  4. "bitbucket.org/bigwhite/mydog"
  5. )
  6. func main() {
  7. fmt.Println(mydog.Add(1, 2))
  8. }

我们来构建一下该程序:

  1. $go build
  2. go: finding bitbucket.org/bigwhite/mydog latest
  3. go: downloading bitbucket.org/bigwhite/mydog v0.0.0-20181126081441-684c772f5624

go命令从athens成功下载了我的私有repo中的mydog module。我们再来看看athens的日志:

  1. handler: GET /bitbucket.org/bigwhite/mydog/@v/list/ [200]
  2. handler: GET /bitbucket.org/bigwhite/mydog/@latest/ [200]
  3. handler: GET /bitbucket.org/bigwhite/mydog/@v/v0.0.0-20181126081441-684c772f5624.zip [200]
  4. handler: GET /bitbucket.org/bigwhite/mydog/@v/v0.0.0-20181126081441-684c772f5624.mod [200]

4 athens的global proxy

athens还提供了一个试验性的global public proxy:athens.azurefd.net供全球gopher使用。不过在我这里通过联通网络是无法ping通该proxy的:

  1. $ping athens.azurefd.net
  2. PING standard.t-0001.t-msedge.net (13.107.246.10): 56 data bytes
  3. Request timeout for icmp_seq 0
  4. Request timeout for icmp_seq 1
  5. Request timeout for icmp_seq 2
  6. ^C
  7. --- standard.t-0001.t-msedge.net ping statistics ---
  8. 4 packets transmitted, 0 packets received, 100.0% packet loss

但是在我国外的VPS上,与该global proxy的通信是正常的:

  1. # ping athens.azurefd.net
  2. PING standard.t-0001.t-msedge.net (13.107.246.10) 56(84) bytes of data.
  3. 64 bytes from 13.107.246.10: icmp_seq=1 ttl=122 time=1.94 ms
  4. 64 bytes from 13.107.246.10: icmp_seq=2 ttl=122 time=1.21 ms
  5. 64 bytes from 13.107.246.10: icmp_seq=3 ttl=122 time=1.30 ms
  6. --- standard.t-0001.t-msedge.net ping statistics ---
  7. 3 packets transmitted, 3 received, 0% packet loss, time 2002ms
  8. rtt min/avg/max/mdev = 1.217/1.491/1.949/0.328 ms

如果你是国内gopher,那么建议该global proxy还是先不要用了。

四. 另外一个go module proxy的实现:goproxy

github上还有另外一个go module proxy的实现:goproxy。该项目目前看仅是一个public module proxy,并未提供对private repo中module获取的支持。

不过该项目提供的global proxy: https://goproxy.io/ 却是可以在国内使用的,并且速度还很快!Gopher们只需将该proxy配置到GOPROXY中即可:

  1. export GOPROXY=https://goproxy.io

五. 小结

和goproxy项目相比,athens项目显然有更大的“野心”,也有Microsoft这个平台作为背后支撑。但athens毕竟开发时间较短,还有很长之路要走。待Go module在Go 1.12中成型并成熟时,希望那个时候的athens项目能给我们带来更多惊喜。


我的网课“Kubernetes实战:高可用集群搭建、配置、运维与应用”在慕课网上线了,感谢小伙伴们学习支持!

我爱发短信:企业级短信平台定制开发专家 https://51smspush.com/
smspush : 可部署在企业内部的定制化短信平台,三网覆盖,不惧大并发接入,可定制扩展; 短信内容你来定,不再受约束, 接口丰富,支持长短信,签名可选。

著名云主机服务厂商DigitalOcean发布最新的主机计划,入门级Droplet配置升级为:1 core CPU、1G内存、25G高速SSD,价格5$/月。有使用DigitalOcean需求的朋友,可以打开这个链接地址https://m.do.co/c/bff6eed92687 开启你的DO主机之路。

我的联系方式:

微博:https://weibo.com/bigwhite20xx
微信公众号:iamtonybai
博客:tonybai.com
github: https://github.com/bigwhite

微信赞赏:
img{512x368}

商务合作方式:撰稿、出书、培训、在线课程、合伙创业、咨询、广告合作。

© 2018, bigwhite. 版权所有.

Related posts:

  1. 初窥Go module
  2. Go 1.11中值得关注的几个变化
  3. 定制Go Package的Go Get导入路径
  4. TB一周萃选[第10期]
  5. 初窥dep
ft_authoradmin  ft_create_time2019-06-22 12:27
 ft_update_time2019-06-22 12:27