简介：该问题源于我们想对 dubbo-go 的 module path 做一次变更，使用 dubbo.apache.org/dubbo-go/v3 替换之前的 github.com/apache/dubbo-go。

问题背景

该问题源于我们想对 dubbo-go 的 module path 做一次变更，使用 dubbo.apache.org/dubbo-go/v3 替换之前的 github.com/apache/dubbo-go。

首先，我们做了路径映射，在 dubbo.apache.org 下放置了一个 dubbogo/v3 文件，内容如下：

<html>

  <head>

    <meta name="go-import" content="dubbo.apache.org/dubbo-go/v3 git <https://github.com/apache/dubbo-go>">

    <meta name="go-source" content="dubbo.apache.org/dubbo-go/v3 git <https://github.com/apache/dubbo-go/tree/3.0{/dir}> <https://github.com/apache/dubbo-go/blob/3.0{/dir}/{file}#L{line}>">

    <meta http-equiv="refresh" content="0; url=https://pkg.go.dev/dubbo.apache.org/dubbo-go/v3">

  </head>

  <body>

    <p>Redirecting to <a href="<https://pkg.go.dev/dubbo.apache.org/dubbo-go/v3>">pkg.go.dev/dubbo.apache.org/dubbo-go/v3</a>...</p>

  </body>

</html>

其次，我们修改了 go.mod 的 module 和对应的所有 import，并修改了所有子模块引用 dubbo-go 使用的 module 路径。

问题分析

在做完上述的修改后，我们提 PR 时，发现 CI 失败，经过进一步的日志排查，我们确定是 CI 在跑集成测试时发生了错误，具体的错误提示信息如下：

这一段的执行逻辑是希望利用 docker 对 dubbo-go 中的集成测试内容构建镜像，并启动容器进行测试，该镜像打包所用的 Dockerfile 路径在 github.com/apache/dubbo-go/test/integrate/dubbo/go-server 目录下，对照错误日志的 STEP 标识，我们可以定位到具体错误发生下面的两个步骤：

# ...

# STEP 9

RUN test ${PR_ORIGIN_REPO} && go mod edit -replace=dubbo.apache.org/dubbo-go/v3=github.com/{PR_ORIGIN_REPO}@${PR_ORIGIN_COMMITID} || go get -u dubbo.apache.org/dubbo-go/v3@develop

# ...

# STEP 11

RUN go mod tidy && go install github.com/apache/dubbo-go/test/integrate/dubbo/go-server

在 STEP 9 中，我们使用 go mod edit -replace 替换了 dubbogo 的依赖路径，将其替换为发起 PR 请求的仓库地址和 commit id。在此基础上，当镜像构建跑到 STEP11 ，尝试使用 go mod tidy 拉包时发生了错误。

回过头查看错误日志，我们可以发现：

由于我们只指定了 commit id，因此在 go mod 实际运行过程中，它会为我们生成一个假定版本号（关于假定版本号的更多说明可以查看本文最后的问题拓展），这个假定版本号抓取远程仓库的最新有效 tag 为 v1.4.1【注：此处远程仓库为 github.com/Mulavar/dubbo-go，这是我自己的 dubbo-go 分支，该分支拉取 fork 的时间比较早，其最后 tag 是 v1.4.1】，并自增为 v1.4.2，主版本是 v1。但在先前，我们的 dubbogo module path 是声明为 dubbo.apache.org/dubbogo/v3，主版本是 v3，这导致了 go mod edit -replace 前后的依赖主版本分别是 v3 和 v1 ，出现了不一致，实际拉取 dubbogo 依赖的时候出错。

问题解决

在问题分析一节中我们定位到这个问题在镜像构建的 STEP 9，即：

# STEP 9

RUN test ${PR_ORIGIN_REPO} && go mod edit -replace=dubbo.apache.org/dubbo-go/v3=github.com/{PR_ORIGIN_REPO}@${PR_ORIGIN_COMMITID} || go get -u dubbo.apache.org/dubbo-go/v3@develop

这一步，我们使用 go mod edit -replace 时将一个 v3 版本的 go module 替换成了一个 v1 版本的 module，导致主版本不一致发生错误，因此我们只需在替换依赖路径时指定替换后的 module 主版本也为 v3 即可，我们在 go mod edit -replace 后的模块依赖路径后也加上 v3 后缀如下所示。

修改前：

go mod edit -replace=dubbo.apache.org/dubbo-go/v3=github.com/{PR_ORIGIN_REPO}@${PR_ORIGIN_COMMITID}

⇒ 修改后：

go mod edit -replace=dubbo.apache.org/dubbo-go/v3=github.com/${PR_ORIGIN_REPO}/v3@${PR_ORIGIN_COMMITID}

修复该问题后我们提交代码查看 CI，在 STEP 8 打印的日志信息中，可以看到替换后的 dubbogo 路径多了 v3，并且在拉包的时候跟的版本号（v3.0.0-20210509140455-2574eab5ad0b）主版本同样是 v3，成功拉取了依赖。

问题拓展

1. Semantic Import Versioning

在我们使用 Go modules 去构建项目的依赖关系时，对 go 项目的依赖都需要声明我们所使用的版本号，考虑到每次发布新版本时，兼容一直是开发者最为重视和头痛的问题，因此 go 通过语义导入版本控制（Semantic Import Versioning）来制定版本号的标准，来确保每个开发者能够根据自己的项目需求指定使用的依赖版本。根据 go 的语义导入版本控制准则，版本号由三部分构成：

注：上图及以上部分内容参考自《Go Modules 详解》一文。

其中 Major version 表示这是一个新的大版本，甚至这个新版本可能和旧版本是不兼容的。

而 Minor version 则表示这是一个大版本中的迭代，主要用于新增 feature 时递增。

Patch version 则是粒度最细的版本更新，表示一些 bug 的修复。

而指定主版本则有两种方式，一种是如上的直接声明，另一种则是在项目路径的最后加上版本后缀，如 dubbogo 3.0 版本声明的 module 则是 dubbo.apache.org/dubbo-go/v3，其中 v3 就是一个主版本的声明。

2. pseudo-version

Go 在使用依赖时推崇我们指定明确的版本号，比如 dubbogo 的 go.mod 中声明的对 cloud.google.com/go 的依赖：

但考虑到在某些场景下，我们想要使用模块依赖的某个未发版的版本（该模块只有一个已知的 commit id），如 dubbogo 声明的 github.com/Microsoft/go-winio 依赖，就可以使用一个假定版本号（pseudo-version）去替代真实的版本号。假定版本号的格式为：

// (1) vX.0.0-yyyymmddhhmmss-abcdef123456

// (2) vX.Y.(Z+1)-0.yyyymmddhhmmss-abcdef123456

// (3) vX.Y.(Z+1)-0.yyyymmddhhmmss-abcdef123456+incompatible

// (4) vX.Y.Z-pre.0.yyyymmddhhmmss-abcdef123456

// (5) vX.Y.Z-pre.0.yyyymmddhhmmss-abcdef123456+incompatible

可以看到 pseudo-version 被短斜杠分为三部分，其中第一部分 X.Y.Z 与 4.1 节提到的一致，分别是 major version、minor version、patch version，而第二部分是一个格式为 yyyymmddhhmmss 的时间戳，第三部分是一个 12 位的 commit hash，可以手动指定，如果没有，则由 go 自动生成。

关于 pseudo-version，go 的生成规则如下：

查询该项目对应主版本（若项目依赖路径没有显式的 v2/v3 后缀，则默认为 v1 版本）的最新 tag。
有 tag 则使用最新 tag 递增 patch version。
无 tag ，根据项目路径带的后缀版本号自动生成（如 v3 则自动生成一个 3.0.0 开头的 pseudo-version）。

遵循这个规则，回头看前文的问题分析和问题解决，我们就可以明白为什么在一开始 dubbo-go 的 pseudo-version 是 v1.4.2，这正是因为 go 认为 replace 后的 dubbogo 依赖主版本是 v1，去查找了该主版本下的最新 tag，并递增了 patch version，从而导致前后主版本不一致，当我们对版本路径加上 v3 后，go 查找不到对应主版本下的 tag，为我们自动生成了 v3.0.0，从而通过了 CI 。

3. Go 模块嵌套

和 Java 不同，go 其实是没有子模块概念的。即使有些时候，我们会看到有个 repo 里有多个 Go modules，比如项目的根目录有一个 go.mod ，里面有些子目录里又有 go.mod 。

这在 Go modules 被称为嵌套模块，而非父子模块，即两个模块没有任何关系，是相互独立的。

那什么时候才需要单 repo 多模块呢？一般来说，碰到以下两种情况我们才会考虑使用单 repo 多模块的开发形式。

某个嵌套模块变动非常频繁，需要经常发版。
当中的嵌套模块仅仅依赖某个固定版本的根模块。

两种情况其实本质都是两个模块之间没什么强的版本绑定关系，但是由于一些其他原因需要放在一个 rpeo 下，因此形成了单 repo 多模块的局面。

4. dubbogo 静态映射文件内容解析

dubbo-go 使用了静态文件映射的方式实现了模块重定向，静态文件的内容如下：

其中的核心部分是 meta 标签 go-import 和 go-source。

<html>

  <head>

    <meta name="go-import" content="dubbo.apache.org/dubbo-go/v3 git <https://github.com/apache/dubbo-go>">

    <meta name="go-source" content="dubbo.apache.org/dubbo-go/v3 git <https://github.com/apache/dubbo-go/tree/3.0{/dir}> <https://github.com/apache/dubbo-go/blob/3.0{/dir}/{file}#L{line}>">

    <meta http-equiv="refresh" content="0; url=https://pkg.go.dev/dubbo.apache.org/dubbo-go/v3">

  </head>

  <body>

    <p>Redirecting to <a href="<https://pkg.go.dev/dubbo.apache.org/dubbo-go/v3>">pkg.go.dev/dubbo.apache.org/dubbo-go/v3</a>...</p>

  </body>

</html>

1）go-import

go-import 的作用，是告诉 go get 去哪儿可以找到源码，content 分为三部分：

dubbo.apache.org/dubbo-go/v3：这个项目的 module 声明。
git：使用的版本控制工具。
<https://github.com/apache/dubbo-go>：告诉 go get 这个项目应该去哪儿找源代码。

2）go-source

go-source 的作用，则是给项目生成具体的 go doc（现为 pkg.go.dev ) 文档，一共有 4 部分，前两部分和 go-import 一样，是该项目的 module 声明和版本控制工具，后两部分则分别起如下作用：

<https://github.com/apache/dubbo-go/tree/3.0{/dir}>：声明该项目的源代码所在位置。
<https://github.com/apache/dubbo-go/blob/3.0{/dir}/{file}#L{line}>：映射文档和代码，帮助我们在点击文档的目录树时，可以跳转到对应的具体内容。

比如在 https://pkg.go.dev/dubbo.apache.org/dubbo-go/v3 上，我们点击其中一个文件：

就会跳转到对应文件对应的文档。

欢迎对 apache/dubbo-go 项目有兴趣的同学搜索钉钉群号 31363295，加入钉钉交流群！

参考资料

《The Go Blog — Using Go Modules》：https://blog.golang.org/using-go-modules
《Go Modules Reference》：https://golang.org/ref/mod
《Go Module 如何发布 v2 及以上版本》：https://blog.cyeam.com/go/2019/03/12/go-version
《Go Modules 详解》：https://www.sulinehk.com/post/go-modules-details/

作者简介

董剑辉(github @Mulavar)，刚从浙江大学 VLIS 实验室毕业，目前在任猿辅导服务端开发工程师。

盛傲飞(github @aofei)，goproxy.cn 项目作者，曾给 go 源码【如 mod 工具】提交过很多 PR。

原文链接
本文为阿里云原创内容，未经允许不得转载。

dubbo-go v3 版本 go module 踩坑记的更多相关文章

Spark踩坑记——从RDD看集群调度
[TOC] 前言在Spark的使用中,性能的调优配置过程中,查阅了很多资料,之前自己总结过两篇小博文Spark踩坑记--初试和Spark踩坑记--数据库(Hbase+Mysql),第一篇概况的归纳了 ...
Vue + TypeScript + Element 搭建简洁时尚的博客网站及踩坑记
前言本文讲解如何在 Vue 项目中使用 TypeScript 来搭建并开发项目,并在此过程中踩过的坑 . TypeScript 具有类型系统,且是 JavaScript 的超集,TypeScript ...
【踩坑记】从HybridApp到ReactNative
前言随着移动互联网的兴起,Webapp开始大行其道.大概在15年下半年的时候我接触到了HybridApp.因为当时还没毕业嘛,所以并不清楚自己未来的方向,所以就投入了HybridApp的怀抱. Hy ...
Spark踩坑记——共享变量
[TOC] 前言 Spark踩坑记--初试 Spark踩坑记--数据库(Hbase+Mysql) Spark踩坑记--Spark Streaming+kafka应用及调优在前面总结的几篇spark踩 ...
windows container 踩坑记
windows container 踩坑记 Intro 我们有一些服务是 dotnet framework 的,不能直接跑在 docker linux container 下面,最近一直在折腾把它部署 ...
centos 7( linux )下搭建elasticsearch踩坑记
原文:https://blog.csdn.net/an88411980/article/details/83150380 概述公司最近在做全文检索的项目,发现elasticsearch踩了不少 ...
iOS自动化打包上传的踩坑记
http://www.cocoachina.com/ios/20160624/16811.html 很久以前就看了很多关于iOS自动打包ipa的文章, 看着感觉很简单, 但是因为一直没有AppleDe ...
十年老苹果（A1286）强升Catalina及Win10踩坑记（续）
背景自上次发布十年老苹果(A1286)强升Catalina及Win10踩坑记以来,因为后半部分-----系统安装上的细节描述过于简略,一些朋友在安装过程中总是又遇到坑,由此特意详述这一过程,让园友少 ...
[技术博客] 敏捷软工——JavaScript踩坑记
[技术博客] 敏捷软工--JavaScript踩坑记一.一个令人影响深刻的坑 1.脚本语言的面向对象面向对象特性是现代编程语言的基本特性,JavaScript中当然集成了面向对象特性.但是Java ...
WinUI 3 踩坑记：前言
WinUI 3 (Windows App SDK 于 2021 年 11 月发布了第一个正式版 v1.0.0 [1],最新版本是 v1.1.5 [2].我的基于 WinUI 3 的个人项目寻空从年 ...

随机推荐

Handler屏障消息
Handler 屏障消息 Handler Message 种类 Handler的Message种类分为3种: 普通消息屏障消息异步消息同步消息我们默认用的都是同步消息,即前面讲Handler里 ...
25_H.264编码
本文主要介绍一种非常流行的视频编码:H.264. 计算一下:10秒钟1080p(1920x1080).30fps的YUV420P原始视频,需要占用多大的存储空间? (10 * 30) * (1920 ...
大年学习linux（第六节---软件安装）
六.软件安装 rpm RPM软件包的管理工具补充说明 rpm命令是RPM软件包的管理工具.rpm原本是Red Hat Linux发行版专门用来管理Linux各项套件的程序,由于它遵循GPL规则且功 ...
记录--用js如何实现将手机号中间的几位数字变成****
这里给大家分享我在网上总结出来的一些知识,希望对大家有所帮助今天,我们要实现一个很常见并且简单的功能:将手机号中间的几位数变成**** 这个功能其实很常见,比如我们微信的账号安全里面显示的手机号.掘 ...
应急响应靶机训练-Linux2
靶机来源: 知攻善防实验室公众号 https://mp.weixin.qq.com/s/xf2FgkrjZg-yWlB9-pRXvw 我是在另一台主机上通过ssh连接到靶机进行解题的,我的ip为192 ...
vue中类tabs左右滑动
效果图思路给定一个变量用来记录滚动了几列,每滚动一次加1滚动一列,监听页面滚动父级元素宽度改变,重新设置滚动的距离(放在计算属性中让其自动计算) <template> <div ...
IDEA 突然无法打开解决办法
如果实在没有方法了可以试一试删除所有的配置文件,默认位置C:\Users\${你的用户名}\${.IntelliJIdea+版本} 注意:删除配置后之前所有的设置都会失效,谨慎操作.
vue项目中添加水印效果
新建js文件:例如warterMark.js 'use strict' let watermark = {} let setWatermark = (str) => { let id = '1. ...
浅析JS原型链
目录实例对象原型对象对象原型短暂总结一下 constructor 原型链何为原型链呢? 就是实例对象和原型对象之间的链接,每一个对象都有原型,原型本身又是对象,原型又有原型,以此类推形成一个 ...

dubbo-go v3 版本 go module 踩坑记