解决go-micro与其它gRPC框架之间的通信问题

go-micro+gRPC

在之前的文章中分别介绍了使用gRPC官方插件和go-micro插件开发gRPC应用程序的方式,都能正常走通。不过当两者混合使用的时候,互相访问就成了问题。比如使用go-micro插件生成的gRPC客户端访问基于gRPC官方插件创建的服务端时就会出现如下错误:

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

经过一番探索,发现是因为go-micro的插件生成代码时丢弃了proto定义中的package,客户端API和服务端API都没有使用这个package,所以它自己也能逻辑自洽,但是和其它框架或者语言的gRPC服务通信时就出现问题了。

这里以 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;
}

对于客户端代理,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。当然这个method的风格也有些差异,不过这个不是问题,因为go-micro还会它进行一些格式化处理,格式化代码在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直接把服务名称作为了package名称,这两者不能等同,不相同时就会出现问题。

网上也没有人提过这个问题,可能混合使用的人不多吧。于是我研究了一下 go-micro 的源码,因为是生成的代码中缺少信息,所以要解决这个问题还是得从protoc-gen-micro入手。

注意这里使用的是go-micro v4版本,其它版本未跟进。

客户端改造

针对客户端问题,我做了如下一些修改:

在生成客户端method时加上package,并直接生成gRPC风格method(go-micro内部其实支持这种风格),修改文件: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())
	}
...

因为还要向前兼容,不能影响现有用户,所以给这个逻辑加了一个开关,使用参数 use_grpc 才会应用新的生成方式。generateClientMethod 方法的 pkg 参数原来并没有,是新加的,从上下文中也比较容易获取到。具体改动可以看这里:https://github.com/asim/go-micro/pull/2474/commits/0d435a690ea21a3f64b0534d1fa244f512601493

现在如果明确只使用gRPC进行通信,或者需要和其它框架或者语言的gRPC应用程序通信,生成代码时可以这样做:

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

关键就是 –micro_opt=use_grpc=1use_grpc这个参数会传递给 protoc-gen-micro,然后就可以在上边修改过的代码中获取到,不管这个参数的值是什么,只要使用了它,就会生成gRPC风格的带package的method。现在生成的代码是这样的:

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

用这个客户端代理访问其它框架或者语言开发的gRPC服务就没有问题了,当然访问go-micro的gRPC服务也没有问题。

怎么获取到这个最新版的 protoc-gen-micro 呢?这个修改提了PR之后,目前已经合并到官方的Github仓库中,但是还没有打tag,可以这样安装:

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

这可能不是一个好的修改,因为还需要知道有 use_grpc 这么个参数。肯定还有别的修改方案,但是因为对go-micro了解的不多,所有只选择了这个不会影响现有通信方式的方案。

服务端改造

服务端没有问题,别的框架或者开发语言的gRPC客户端可以调用基于go-micro的gRPC服务。

一开始我测试的时候也遇到了问题,先入为主的以为protoc-gen-micro生成的服务端也有package的问题,因此还提交了个PR,然后被啪啪打脸。然后我又读了读源码,发现go-micro服务端特别巧妙的把客户端请求中的package信息擦除了,所以客户端是否传递package都没有影响,反正服务端不需要。

服务端的注册逻辑在 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

可以看到这里直接用反射获取的类型名称作为服务名称,没有package什么事。

然后接收到客户端的gRPC请求时,go-micro又把请求中的package擦除了。这段逻辑在 plugins/server/grpc/grpc.go 中的 handler 方法中:

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

通过 mgrpc.ServiceMethod 获取服务名称时去掉了package名称,所以客户端带不带package都没有问题。

运行效果

现在把程序跑起来,试试用 protoc-gen-micro 生成的客户端访问 基于 protoc-gen-go-grpc 的服务端。

go-micro+gRPC

以上就是本文的主要内容,示例代码已经上传到Github,欢迎访问:https://github.com/bosima/go-demo/tree/main/go-micro-grpc-hello-compatible

收获更多架构知识,请关注微信公众号 萤火架构。原创内容,转载请注明出处。
扫描二维码关注公众号