标签 代码评审 下的文章

小厂内部私有Go module拉取方案(续)

本文永久链接 – https://tonybai.com/2022/06/18/the-approach-to-go-get-private-go-module-in-house-part2

自从去年在公司搭建了内部私有Go module proxy后,我们的私有代理工作得基本良好。按理说,这篇续篇本不该存在:)。

日子一天天过去,Go团队逐渐壮大,空气中都充满了“Go的香气”。

突然有一天,业务线考虑将目前在用的gerrit换成gitlab。最初使用gerrit的原因不得而知,但我猜是想使用gerrit强大且独特的code review机制和相应的工作流。不过由于业务需求变化太快,每个迭代的功能都很多,“+2”的review机制到后来就形同虚设了。

如果不用gerrit review工作流,那么gerrit还有什么存在的价值呢。从管理员那边反馈,gerrit配置起来也是比较复杂的,尤其是权限。两者叠加就有了迁移到gitlab的想法。这样摆在Go团队面前的一个事情就是如何让我们内部私有go module代理适配gitlab

如果你还不清楚我们搭建私有Go module代理的原理,那么在进一步往下阅读前,请先阅读一下《小厂内部私有Go module拉取方案》

适配gitlab

回顾一下我们的私有Go module代理的原理图:

基于这张原理图,我们分析后得出结论:要适配gitlab仓库,其实很简单,只需修改govanityurls的配置文件中的各个module的真实repo地址即可,这也符合更换一个后端代码仓库服务理论上开发人员无感的原则。

下面我们在gitlab上创建一个foo repo,其对应的module path为mycompany.com/go/foo。我们使用ssh方式拉取gitlab repo,先将goproxy所在主机的公钥添加到gitlab ssh key中。然后将gitlab clone按钮提示框中给出的clone地址:git@10.10.30.30:go/foo.git填到vanity.yaml文件中:

//vanity.yaml
  ... ...
  /go/foo:
     repo: ssh://git@10.10.30.30:go/foo.git
     vcs: git

我门在一台开发机上建立测试程序,该程序导入mycompany.com/go/foo,执行go mod tidy命令的结果如下:

$go mod tidy
go: finding module for package mycompany.com/go/foo
demo imports
    mycompany.com/go/foo: cannot find module providing package mycompany.com/go/foo: module mycompany.com/go/foo: reading http://10.10.20.20:10000/mycompany.com/go/foo/@v/list: 404 Not Found
    server response:
    go list -m -json -versions mycompany.com/go/foo@latest:
    go: mycompany.com/go/foo@latest: unrecognized import path "mycompany.com/go/foo": http://mycompany.com/go/foo?go-get=1: invalid repo root "ssh://git@10.10.30.30:go/foo.git": parse "ssh://git@10.10.30.30:go/foo.git": invalid port ":go" after host

从goproxy返回的response内容来看,似乎是goproxy使用的go命令无法识别:”ssh://git@10.10.30.30:go/foo.git”,认为10.10.30.30后面的分号后面应该接一个端口,而不是go。

我们将repo换成下面这样的格式:

  /go/foo:
     repo: ssh://git@10.10.30.30:80/go/foo.git
     vcs: git

重启govanityurls并重新执行go mod tidy,依旧报错:

$go mod tidy
go: finding module for package mycompany.com/go/foo
demo imports
    mycompany.com/go/foo: cannot find module providing package mycompany.com/go/foo: module mycompany.com/go/foo: reading http://10.10.20.20:10000/mycompany.com/go/foo/@v/list: 404 Not Found
    server response:
    go list -m -json -versions mycompany.com/go/foo@latest:
    go: module mycompany.com/go/foo: git ls-remote -q origin in /root/.bin/goproxycache/pkg/mod/cache/vcs/4d37c02c151342112bd2d7e6cf9c0508b31b8fe1cf27063da6774aa0f53d872f: exit status 128:
        kex_exchange_identification: Connection closed by remote host
        fatal: Could not read from remote repository.

直接在主机上通过git clone git@10.10.30.30:80/go/foo.git也是报错的!ssh不行,我们再来试试http方式。 使用http方式呢,每次clone都需要输入用户名密码,不适合goproxy。是时候让personal token上阵了!在gitlab上分配好personal token,然后在本地建立~/.netrc如下:

# cat ~/.netrc
machine 10.10.30.30
login tonybai
password [your personal token]

然后我们将vanity.yaml中的repo改为如下形式:

// vanity.yaml

  /go/foo:
     repo: http://10.10.30.30/go/foo.git
     vcs: git

这样再执行go mod tidy,foo仓库就被顺利拉取了下来。

答疑

1. git clone错误

在搭建goproxy时,我们通常会在goproxy服务器上手工验证一下是否可以通过git成功拉取私有仓库,如果git clone出现下面错误信息,是什么问题呢?

$ git clone ssh://tonybai@10.10.30.30:29418/go/common
Cloning into 'common'...
Unable to negotiate with 10.10.30.30 port 29418: no matching key exchange method found. Their offer: diffie-hellman-group14-sha1,diffie-hellman-group1-sha1
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

这里的错误提示信息其实是很清楚明了的。git服务器端支持diffie-hellman-group1-sha1和diffie-hellman-group14-sha1这两种密钥交换方法,而git客户端却默认一个都不支持。

怎么解决呢?我们需要在goproxy所在主机增加一个配置.ssh/config:

// ~/.ssh/config
Host 10.10.30.30
    HostName 10.10.30.30
    User tonybai
    Port 29418
    KexAlgorithms +diffie-hellman-group1-sha1

    IdentityFile ~/.ssh/id_rsa

有了这条配置后,我们就可以成功clone。

2. 使用非安全连接

有些童鞋使用这个方案后会遇到下面问题:

$go get mycompany.com/go/common@latest
go: module mycompany.com/go/common: reading http://10.10.30.30:10000/mycompany.com/go/common/@v/list: 404 Not Found
    server response:
    go list -m -json -versions mycompany.com/go/common@latest:
    go list -m: mycompany.com/go/common@latest: unrecognized import path "mycompany.com/go/common": https fetch: Get "https://mycompany.com/go/common?go-get=1": dial tcp 127.0.0.1:443: connect: connection refused

首先,go get得到的服务端响应信息中提示:无法连接127.0.0.1:443,查看goproxy主机的nginx access.log,也无日志。说明goproxy没有发起请求。也就是说问题出在go list命令这块,它为什么要去连127.0.0.1:443?我们的代码服务器使用的可是http而非https方式访问。

这让我想起了Go 1.14中增加的GOINSECURE,go命令默认采用的是secure方式,即https去访问代码仓库的。如果不要求非得以https获取module,或者即便使用https,也不再对server证书进行校验,那么需要设置GOINSECURE环境变量,比如;

export GOINSECURE="mycompany.com"

这样再获取mycompany.com/…下面的go module时,就不会出现上面的错误了!


“Gopher部落”知识星球旨在打造一个精品Go学习和进阶社群!高品质首发Go技术文章,“三天”首发阅读权,每年两期Go语言发展现状分析,每天提前1小时阅读到新鲜的Gopher日报,网课、技术专栏、图书内容前瞻,六小时内必答保证等满足你关于Go语言生态的所有需求!2022年,Gopher部落全面改版,将持续分享Go语言与Go应用领域的知识、技巧与实践,并增加诸多互动形式。欢迎大家加入!

img{512x368}
img{512x368}

img{512x368}
img{512x368}

我爱发短信:企业级短信平台定制开发专家 https://tonybai.com/。smspush : 可部署在企业内部的定制化短信平台,三网覆盖,不惧大并发接入,可定制扩展; 短信内容你来定,不再受约束, 接口丰富,支持长短信,签名可选。2020年4月8日,中国三大电信运营商联合发布《5G消息白皮书》,51短信平台也会全新升级到“51商用消息平台”,全面支持5G RCS消息。

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

Gopher Daily(Gopher每日新闻)归档仓库 – https://github.com/bigwhite/gopherdaily

我的联系方式:

  • 微博:https://weibo.com/bigwhite20xx
  • 博客:tonybai.com
  • github: https://github.com/bigwhite

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

只为那一抹释然

一切没有目标的努力,都是瞎忙活儿。
                                                    - Tony Bai

刚实施回来,就又投入到新工作中,到今天才有那么一点点时间写写这件事儿。

* 缘起

我们的遗留系统性能一直不高,导致这一局面的因素有很多,比如最初设计和实现的“考虑不足”、后续维护人员的“随波逐流”甚至缺少勇气对影响性能的关 键代码进行重构等等。技术债务就这样一直积累着。直到两年前,我们终见其导致的巨大的影响了。

由于客户方成本压缩,单节点性能低意味着需要更多的硬件投入,并连带着报价升高,导致我们的产品市场竞争力下降。而竞争对手产品的性能是我们的 3-5倍,这终于引起了领导的重视,并下达了开发高性能版本的任务命令。

* 抉择

遗留系统的问题有很多,性能差仅仅是表象之一。可维护性差更让人印象深刻。遗留系统就像一件打满补丁的旧衣裳,虽然依旧能穿着遮体御寒,但却让我 们时刻战战兢兢,生怕一个动作会导致它解体,变得支离破碎。

对于我们这样一个mission-critical的系统来说,开发周期显然是不会短的。在性能达标的同时,更为重要的是保证产品的质量,确保上 线后运行稳定。因此摆在我们面前有两条路:
    1、在遗留系统上做“大修” – 大规模重构
    2、重写,把构成系统的骨架重新设计和实现,使它能够足够坚固,满足在“高速公路”上驰骋的要求。

我们最终选择了重写,也就是风险较大的那条路。在我们的理解中,重写软件就好比汽车升级平台,就像大众将传统的PQ25、PQ35等统统升级为 MQB平台那样。平台的升级,不光影响技术,还会影响方方面面,比如团队的能力、思维方式、合作模式以及团队过程改善等等。做 得好的话,会使整个团队迈上一个新台阶,这是原地修补所不能够带来的。

对于我个人来说,这也是我期望中的实验田,我将把之前研究的诸多实践落地,帮助团队提升能力。

自私地说,重写系统也是我的一个小理想,能遇到这样一个从无到有构建一个系统的机会是不多的,因此很是希望能看到一个系统一点一点的在自己的呵护 下“成长”起来。虽然我也清楚完成这样一个系统需要很长时间,而这期间我可能需要时刻紧绷着神经,直到系统正式上线后,才能感受到那一抹释然。

* 建立“骨架(skeleton)”

我们将项目分成两个阶段:建立系统“骨架”和为系统“添肉”,即添加业务逻辑。

系统的性能目标是原遗留系统的10倍,这样我们建立的骨架的性能至少要高于原遗留系统的10倍。在“添肉”之前我们要充分证明骨架的设计是合理、 有效、稳定和高性能的。

遗留系统性能低,并非因为当初的设计者能力有什么问题,更多是局限于当初的设计目标。系统初期业务量不大,接入的外部网元不多,因此系统大量使用 了链表这种简单但低效的数据结构;为了easy coding,当初的设计者选择了全局大锁;在客户端-服务器处理模型上,选择了一个连接一个进程的“高耗能”模式。最初这样的设计应对当年的业务量也是 绰绰有余的,但应付今天的业务规模就显得颇为捉襟见肘了,以至于我们不得不通过罗列机器来满足业务增长的状况。服务器增多,却导致了我们维护 和监控难度的增加。

为了应付现有业务量规模以及未来若干年的业务量增长,我们的新系统的骨架在设计时显然要扬长避短:
    – 我们重新设计了通用的服务端框架和客户端框架,使得系统各个业务模块采用相同的通信处理机制;
    – 我们没有选择线程,而是依旧采用成熟的进程(资源隔离式) + IO多路复用(linux下epoll机制)的服务器-客户端模型,与以往不同的是,我们在每个进程中处理多个链接,设定进程数量在合理水平,避免大量上下文切换带来的性能损耗;
    – 将传统的全局big lock更换成了细粒度锁;
    – 采用高效的数据结构和算法,比如用hash和array替代掉list等;
    – 用简单队列替换掉原先复杂的队列调度结构,降低代码理解难度和后续维护门槛。
    – … …

我们要求对骨架代码进行严格的单元测试,通过lcut为骨架代码建立起单元测试集,并结合持续集成对骨架代码进行持续的单元测试验证。

骨架完成后,我们对其进行了全面的压力测试,确保其性能水平达到我们设计要求,这是我们进入下一阶段的前提条件。

* 添肉(business logic)

有了稳定、可靠、高效的骨架,我们在”添肉“阶段就更加有信心了。用C写纯业务逻辑是苦逼了一些,但还好我们没有全部将以前遗留代码扔掉,我们为了保证功 能Feature不丢失,我们会尽量复用之前的业务逻辑,当然是“规范地”搬到新系统中的,尽可能地去除原有代码中的Bad smell

与骨架相比,业务逻辑相对复杂,且耦合较多,因此对这些业务逻辑做单元测试真是一件让人头疼的事情。不过这也和我们最初的估计相符,最初制定的策略就是对骨架代码做高覆盖,对业务代码则宽松些,尽量覆盖即可。

* 附加实践

就像前面所说的那样,围绕着这次重写系统,我策划了很多实践有了落脚之地,包括:
    – 试点知识管理 :通过这次重写,建立起关于该系统的知识库;
    – 增加基于ReviewBoard在线代码评审环节;
    – 引入基于Jenkins持续集成
    – 重新思考和设计构建环节,通过buildc提高构建效率;
    – 重新设计通用安装包
    – 使用LCUT对骨架进行单元测试覆盖;
    – 规范commit log以及代码提交流程
    – 应用代码风格检查工具,使得所有代码风格一致。

事实证明上述实践在这次系统重写的过程中产生了很好的效果,尤其在代码质量保证方面,系统上线后的结果也恰恰印证了这一点。

* 上线

“丑媳妇总要见公婆”。我们的新系统也到了该上线服务的时候了。为了这次上线,我们做了较为充分的实施准备,无论是人员还是时间,都有倾向性的向这个系统 投入。我们也提前做好了应对各种突发问题的预案。可实际情况出乎预料,与遗留系统的版本升级相比,这次全新系统上线显得十分顺利,系统的核心相当稳定,出 现的一些问题也都比较边缘,对这次成功上线已经不构成什么影响了。

* 那一抹释然

在实施人员庆贺上线成功时,在领导口头表扬时,我的内心却显得十分平静。对于新系统来说,这是一个好的开始。对我个人来说,我感受到了那一抹期望已久的释 然。在这个领域里这个方向上已经摸爬滾打了多年,虽然还有好多地方需要改进,好多实践需要完善,但我的内心告诉我:“够了”、“已经没什么牵挂了”、“是 时候换换方向、换换领域了”、“让其他人去做吧”。我已经在产品和团队中融入了我的思想,我相信他们都能很好的演化和发展。而我则为接受新思想、新领域做 好了准备。

的确也到了为自己设立新目标的时候了!

如发现本站页面被黑,比如:挂载广告、挖矿等恶意代码,请朋友们及时联系我。十分感谢! Go语言第一课 Go语言精进之路1 Go语言精进之路2 商务合作请联系bigwhite.cn AT aliyun.com

欢迎使用邮件订阅我的博客

输入邮箱订阅本站,只要有新文章发布,就会第一时间发送邮件通知你哦!

这里是 Tony Bai的个人Blog,欢迎访问、订阅和留言! 订阅Feed请点击上面图片

如果您觉得这里的文章对您有帮助,请扫描上方二维码进行捐赠 ,加油后的Tony Bai将会为您呈现更多精彩的文章,谢谢!

如果您希望通过微信捐赠,请用微信客户端扫描下方赞赏码:

如果您希望通过比特币或以太币捐赠,可以扫描下方二维码:

比特币:

以太币:

如果您喜欢通过微信浏览本站内容,可以扫描下方二维码,订阅本站官方微信订阅号“iamtonybai”;点击二维码,可直达本人官方微博主页^_^:
本站Powered by Digital Ocean VPS。
选择Digital Ocean VPS主机,即可获得10美元现金充值,可 免费使用两个月哟! 著名主机提供商Linode 10$优惠码:linode10,在 这里注册即可免费获 得。阿里云推荐码: 1WFZ0V立享9折!


View Tony Bai's profile on LinkedIn
DigitalOcean Referral Badge

文章

评论

  • 正在加载...

分类

标签

归档



View My Stats