大家好，我是煎魚(yú)。

前幾年非常高頻的接觸到這一堆微服務(wù)相關(guān)組件：grpc + grpc-gateway + etcd + protobuf + protoc-gen-go，一開(kāi)始都是相安無(wú)事，逐步跟進(jìn)新版本。

這不，幺蛾子就來(lái)了。寫這些組件的開(kāi)發(fā)大佬（或公司）都不在一起，各自為政，各有各的想法、喜歡、規(guī)范...因此會(huì)出互相不兼容，甚至出現(xiàn)了卡脖子的情況。

圖片

各種兼容問(wèn)題

當(dāng) etcd 是 v3.3/v3.4，grpc > v1.27 時(shí)，經(jīng)常會(huì)遇到各種看著腦殼痛的兼容性問(wèn)題。

至少但不限于如下幾個(gè)場(chǎng)景。只是例舉幾個(gè)比較常見(jiàn)的三個(gè)兼容錯(cuò)誤。

找不到 grpc/naming

找不到 grpc-go 庫(kù)中的google.golang.org/grpc/naming 包。原因是什么？原因之一是 go.etcd.io/etcd/client 引用到 grpc-go 庫(kù)中的實(shí)驗(yàn)包。

在 go mod tidy 時(shí)，會(huì)遇到如下報(bào)錯(cuò)：

go: finding module for package google.golang.org/grpc/naming
go: finding module for package google.golang.org/grpc/examples/helloworld/helloworld
go: found google.golang.org/grpc/examples/helloworld/helloworld in google.golang.org/grpc/examples v0.0.0-20231026203026-8cb98464e599
go: finding module for package google.golang.org/grpc/naming
go: git.xxx.cn/xxx/xxx-common/jy imports
 go.etcd.io/etcd/client tested by
 go.etcd.io/etcd/client.test imports
 github.com/coreos/etcd/integration imports
 github.com/coreos/etcd/proxy/grpcproxy imports
 google.golang.org/grpc/naming: module google.golang.org/grpc@latest found (v1.59.0), but does not contain package google.golang.org/grpc/naming

看到最后的 but does not contain package google.golang.org/grpc/naming。以為是 grpc-go 亂刪庫(kù)，做了不兼容變更。

想著找官方解決一下問(wèn)題。印象很深刻，人家 grpc-go 表示：我這庫(kù)早就聲明了是實(shí)驗(yàn)性，隨時(shí)可能刪除，你不應(yīng)該依賴他。（不會(huì)支持的意思）

找不到 etcd/clientv3/balancer/picker

還是由于 grpc-go 庫(kù)的實(shí)驗(yàn)包在新版本去掉了。會(huì)導(dǎo)致 etcd v3.3 出現(xiàn)：undefined: balancer.PickOptions 和 undefined: resolver.BuildOption 的相關(guān)錯(cuò)誤信息：

$ go get go.etcd.io/etcd/clientv3
# github.com/coreos/etcd/clientv3/balancer/resolver/endpoint
../../go/pkg/mod/github.com/coreos/etcd@v3.3.18+incompatible/clientv3/balancer/resolver/endpoint/endpoint.go:114:78: undefined: resolver.BuildOption
../../go/pkg/mod/github.com/coreos/etcd@v3.3.18+incompatible/clientv3/balancer/resolver/endpoint/endpoint.go:182:31: undefined: resolver.ResolveNowOption
# github.com/coreos/etcd/clientv3/balancer/picker
../../go/pkg/mod/github.com/coreos/etcd@v3.3.18+incompatible/clientv3/balancer/picker/err.go:37:44: undefined: balancer.PickOptions
../../go/pkg/mod/github.com/coreos/etcd@v3.3.18+incompatible/clientv3/balancer/picker/roundrobin_balanced.go:55:54: undefined: balancer.PickOptions

不得不說(shuō)，這個(gè) BUG 我還給 etcd 提了 issues 和 pr：

圖片

最終合并了。（但是 etcd v3.5 當(dāng)年發(fā)布的太慢了，沒(méi)等到...）

找不到 grpc.SupportPackageIsVersion6

protoc-gen-go 與 grpc 版本不兼容。會(huì)出現(xiàn)如下報(bào)錯(cuò)：

Getting error undefined: grpc.SupportPackageIsVersion6 and undefined: grpc.ClientConnInterface

本身這個(gè)問(wèn)題，只需要升級(jí) grpc >= 1.27 就可以了。但如果你使用了 etcd sdk，又會(huì)前面的 etcd 版本依賴問(wèn)題，程序會(huì)陷入麻煩的升又升不得，降也降不了。

最后還是將 protoc(protoc-gen-go) 降級(jí)為 v1.3.2，grpc 保持在 v1.26，這樣 etcd v3.3 的依賴才能正常使用。

背后緣由

細(xì)心的同學(xué)會(huì)發(fā)現(xiàn)，歸根到底還是和 etcd v3.3 扯上關(guān)系，grpc 就沒(méi)法升級(jí)到 v1.27 以上。其他所有關(guān)聯(lián)的 protoc、grpc-gateway 的版本都沒(méi)法繼續(xù)推進(jìn)。

當(dāng)你想用 go module 來(lái)做各種兼容管理時(shí)，會(huì)發(fā)現(xiàn) etcd v3.3 根本沒(méi)有 go module...

etcd v3.4 雖然有 go.mod，但也無(wú)法拉取和使用（原因詳見(jiàn)：etcd-io/etcd/issues/11154[1]）。

圖片

etcd 官方的響應(yīng)也是不太積極的。猜測(cè)是積重難返，比較難解決。

解決方案

社區(qū)等了許多年，現(xiàn)在終于有了解決辦法。etcd v3.5 已經(jīng)正式支持了 go module！

etcd 將之前的模塊按功能做了領(lǐng)域劃分，把之前各種的低版本依賴、循環(huán)依賴等問(wèn)題都處理了。

如下圖所示：

圖片

圖片

拆分為了 api、client、raft、server、etcdctl、bbolt 等獨(dú)立的 Go 模塊。不會(huì)像老版本一樣交叉影響。

如果你是新項(xiàng)目，建議無(wú)腦使用 etcd v3.5 以上版本。千萬(wàn)別用 v3.3/v3.4 及更低的！

比較無(wú)奈的一點(diǎn)

可能有的同學(xué)以為皆大歡喜了？其實(shí)并不。

他的模塊化改造成功僅限于 etcd v3.5 的版本。而歷史項(xiàng)目，如果你是使用 etcd v2 store，那么很抱歉。

etcd 老版本（v3.3/v3.4 等）是沒(méi)有變動(dòng)的，在 v3.5 的新版本（包含最新的文檔）中都在開(kāi)始在逐步去除 etcd v2 的相關(guān)支持。

圖片

如果仍然在使用 etcd v2 的同學(xué)，建議進(jìn)行數(shù)據(jù)遷移用 v3。這樣可以避免很多技術(shù)上的問(wèn)題。

遷移不方便的話，除了各種 replace 和鎖版本外。如果你使用的 etcd 功能非?；A(chǔ)，也可以自己實(shí)現(xiàn)一個(gè)簡(jiǎn)易版的 SDK。

總結(jié)

etcd 的這個(gè)歷史問(wèn)題已經(jīng)存在了好幾年，一直處理的慢慢吞吞。甚至影響到了 Go 生態(tài)圈的一些技術(shù)選型問(wèn)題。

前幾天有同學(xué)反饋 tidb 里引用了 cloud.google.com/go/pubsub 庫(kù)，而該庫(kù)又依賴了 grpc 的較高的版本。從而導(dǎo)致原有卡在 grpc v1.26 的應(yīng)用又出現(xiàn)了問(wèn)題。才回過(guò)頭來(lái)看看。

在新版本中，etcd 的依賴問(wèn)題終于解決了。真的是，這值得被我們記住！雖然他老版本依然沒(méi)處理...