go-micro+gRPC

在之前的文章中分別介紹了使用gRPC官方插件和go-micro插件開(kāi)發(fā)gRPC應(yīng)用程序的方式，都能正常走通。不過(guò)當(dāng)兩者混合使用的時(shí)候，互相訪問(wèn)就成了問(wèn)題。比如使用go-micro插件生成的gRPC客戶(hù)端訪問(wèn)基于gRPC官方插件創(chuàng)建的服務(wù)端時(shí)就會(huì)出現(xiàn)如下錯(cuò)誤：

{"id":"go.micro.client","code":501,"status":"Not Implemented"}

經(jīng)過(guò)一番探索，發(fā)現(xiàn)是因?yàn)間o-micro的插件生成代碼時(shí)丟棄了proto定義中的package，客戶(hù)端API和服務(wù)端API都沒(méi)有使用這個(gè)package，所以它自己也能邏輯自洽，但是和其它框架或者語(yǔ)言的gRPC服務(wù)通信時(shí)就出現(xiàn)問(wèn)題了。

這里以 hello.proto 為例：

syntax = "proto3";

option go_package="/proto";

package Business;

service Hello {
  rpc Say (SayRequest) returns (SayResponse);
}

message SayResponse {
  string Message = 1;
}

message SayRequest {
  string Name = 1;
}

對(duì)于客戶(hù)端代理，protoc-gen-go-grpc生成的是：

err := c.cc.Invoke(ctx, "/Business.Hello/Say", in, out, opts...)

protoc-gen-micro生成的是：

req := c.c.NewRequest(c.name, "Hello.Say", in)

可以明顯看到，go-micro生成的gRPC method中缺少package。當(dāng)然這個(gè)method的風(fēng)格也有些差異，不過(guò)這個(gè)不是問(wèn)題，因?yàn)間o-micro還會(huì)它進(jìn)行一些格式化處理，格式化代碼在grpc插件中。

plugins/client/grpc/request.go :

func methodToGRPC(service, method string) string {
    // no method or already grpc method
    if len(method) == 0 || method[0] == '/' {
        return method
    }

    // assume method is Foo.Bar
    mParts := strings.Split(method, ".")
    if len(mParts) != 2 {
        return method
    }

    if len(service) == 0 {
        return fmt.Sprintf("/%s/%s", mParts[0], mParts[1])
    }

    // return /pkg.Foo/Bar
    return fmt.Sprintf("/%s.%s/%s", service, mParts[0], mParts[1])
}

可以看到go-micro直接把服務(wù)名稱(chēng)作為了package名稱(chēng)，這兩者不能等同，不相同時(shí)就會(huì)出現(xiàn)問(wèn)題。

網(wǎng)上也沒(méi)有人提過(guò)這個(gè)問(wèn)題，可能混合使用的人不多吧。于是我研究了一下 go-micro 的源碼，因?yàn)槭巧傻拇a中缺少信息，所以要解決這個(gè)問(wèn)題還是得從protoc-gen-micro入手。

注意這里使用的是go-micro v4版本，其它版本未跟進(jìn)。

客戶(hù)端改造

針對(duì)客戶(hù)端問(wèn)題，我做了如下一些修改：

在生成客戶(hù)端method時(shí)加上package，并直接生成gRPC風(fēng)格method（go-micro內(nèi)部其實(shí)支持這種風(fēng)格），修改文件：cmd/protoc-gen-micro/plugin/micro/micro.go

func (g *micro) generateClientMethod(pkg, reqServ, servName, serviceDescVar string, method *pb.MethodDescriptorProto, descExpr string) {
    reqMethod := fmt.Sprintf("%s.%s", servName, method.GetName())
    useGrpc := g.gen.Param["use_grpc"]
    if useGrpc != "" {
        reqMethod = fmt.Sprintf("/%s.%s/%s", pkg, servName, method.GetName())
    }
...

因?yàn)檫€要向前兼容，不能影響現(xiàn)有用戶(hù)，所以給這個(gè)邏輯加了一個(gè)開(kāi)關(guān)，使用參數(shù) use_grpc 才會(huì)應(yīng)用新的生成方式。generateClientMethod 方法的 pkg 參數(shù)原來(lái)并沒(méi)有，是新加的，從上下文中也比較容易獲取到。具體改動(dòng)可以看這里：https://github.com/asim/go-micro/pull/2474/commits/0d435a690ea21a3f64b0534d1fa244f512601493

現(xiàn)在如果明確只使用gRPC進(jìn)行通信，或者需要和其它框架或者語(yǔ)言的gRPC應(yīng)用程序通信，生成代碼時(shí)可以這樣做：

protoc --go_out=. --micro_out=. --micro_opt=use_grpc=1 xxx.proto

關(guān)鍵就是 --micro_opt=use_grpc=1，use_grpc這個(gè)參數(shù)會(huì)傳遞給 protoc-gen-micro，然后就可以在上邊修改過(guò)的代碼中獲取到，不管這個(gè)參數(shù)的值是什么，只要使用了它，就會(huì)生成gRPC風(fēng)格的帶package的method。現(xiàn)在生成的代碼是這樣的：

req := c.c.NewRequest(c.name, "/Business.Hello/Say", in)

用這個(gè)客戶(hù)端代理訪問(wèn)其它框架或者語(yǔ)言開(kāi)發(fā)的gRPC服務(wù)就沒(méi)有問(wèn)題了，當(dāng)然訪問(wèn)go-micro的gRPC服務(wù)也沒(méi)有問(wèn)題。

怎么獲取到這個(gè)最新版的 protoc-gen-micro 呢？這個(gè)修改提了PR之后，目前已經(jīng)合并到官方的Github倉(cāng)庫(kù)中，但是還沒(méi)有打tag，可以這樣安裝：

go install go-micro.dev/v4/cmd/protoc-gen-micro@1919048c8f20

這可能不是一個(gè)好的修改，因?yàn)檫€需要知道有 use_grpc 這么個(gè)參數(shù)。肯定還有別的修改方案，但是因?yàn)閷?duì)go-micro了解的不多，所有只選擇了這個(gè)不會(huì)影響現(xiàn)有通信方式的方案。

服務(wù)端改造

服務(wù)端沒(méi)有問(wèn)題，別的框架或者開(kāi)發(fā)語(yǔ)言的gRPC客戶(hù)端可以調(diào)用基于go-micro的gRPC服務(wù)。

一開(kāi)始我測(cè)試的時(shí)候也遇到了問(wèn)題，先入為主的以為protoc-gen-micro生成的服務(wù)端也有package的問(wèn)題，因此還提交了個(gè)PR，然后被啪啪打臉。然后我又讀了讀源碼，發(fā)現(xiàn)go-micro服務(wù)端特別巧妙的把客戶(hù)端請(qǐng)求中的package信息擦除了，所以客戶(hù)端是否傳遞package都沒(méi)有影響，反正服務(wù)端不需要。

服務(wù)端的注冊(cè)邏輯在 plugins/server/grpc/server.go 中的 register 方法：

s := new(service)
s.typ = reflect.TypeOf(rcvr)
s.rcvr = reflect.ValueOf(rcvr)
sname := reflect.Indirect(s.rcvr).Type().Name()
...
server.serviceMap[s.name] = s

可以看到這里直接用反射獲取的類(lèi)型名稱(chēng)作為服務(wù)名稱(chēng)，沒(méi)有package什么事。

然后接收到客戶(hù)端的gRPC請(qǐng)求時(shí)，go-micro又把請(qǐng)求中的package擦除了。這段邏輯在 plugins/server/grpc/grpc.go 中的 handler 方法中：

serviceName, methodName, err := mgrpc.ServiceMethod(fullMethod)
service := g.rpc.serviceMap[serviceName]

通過(guò) mgrpc.ServiceMethod 獲取服務(wù)名稱(chēng)時(shí)去掉了package名稱(chēng)，所以客戶(hù)端帶不帶package都沒(méi)有問(wèn)題。

運(yùn)行效果

現(xiàn)在把程序跑起來(lái)，試試用 protoc-gen-micro 生成的客戶(hù)端訪問(wèn) 基于 protoc-gen-go-grpc 的服務(wù)端。

go-micro+gRPC

以上就是本文的主要內(nèi)容，示例代碼已經(jīng)上傳到Github，歡迎訪問(wèn)：https://github.com/bosima/go-demo/tree/main/go-micro-grpc-hello-compatible

收獲更多架構(gòu)知識(shí)，請(qǐng)關(guān)注公眾號(hào) 螢火架構(gòu)。原創(chuàng)內(nèi)容，轉(zhuǎn)載請(qǐng)注明出處。