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

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

image.png

在之前的文章中分别介绍了使用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 参数原来并没有,是新加的,从上下文中也比较容易获取到。具体改动可以看这里:github.com/asim/go-mic…

现在如果明确只使用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 的服务端。

1689143468949.png

以上就是本文的主要内容,示例代码已经上传到Github,欢迎访问:github.com/bosima/go-d…

相关文章
|
8天前
|
JSON Go API
使用Go语言和Gin框架构建RESTful API:GET与POST请求示例
使用Go语言和Gin框架构建RESTful API:GET与POST请求示例
|
2月前
|
Cloud Native JavaScript API
一文读懂云原生 go-zero 微服务框架
一文读懂云原生 go-zero 微服务框架
|
27天前
|
消息中间件 NoSQL Go
PHP转Go系列 | ThinkPHP与Gin框架之Redis延时消息队列技术实践
【9月更文挑战第7天】在从 PHP 的 ThinkPHP 框架迁移到 Go 的 Gin 框架时,涉及 Redis 延时消息队列的技术实践主要包括:理解延时消息队列概念,其能在特定时间处理消息,适用于定时任务等场景;在 ThinkPHP 中使用 Redis 实现延时队列;在 Gin 中结合 Go 的 Redis 客户端库实现类似功能;Go 具有更高性能和简洁性,适合处理大量消息。迁移过程中需考虑业务需求及系统稳定性。
|
2月前
|
Go API 数据库
[go 面试] 分布式事务框架选择与实践
[go 面试] 分布式事务框架选择与实践
|
2月前
|
SQL JavaScript Go
Go Web 服务框架实现详解
Go Web 服务框架实现详解
|
2月前
|
存储 Prometheus 中间件
2020最佳人气项目之Go Web框架
2020最佳人气项目之Go Web框架
|
2月前
|
缓存 监控 中间件
构建高效的Go语言Web服务器:基于Fiber框架的性能优化实践
在追求极致性能的Web开发领域,Go语言(Golang)凭借其高效的并发处理能力、垃圾回收机制及简洁的语法赢得了广泛的青睐。本文不同于传统的性能优化教程,将深入剖析如何在Go语言环境下,利用Fiber这一高性能Web框架,通过精细化配置、并发策略调整及代码层面的微优化,构建出既快速又稳定的Web服务器。通过实际案例与性能测试数据对比,揭示一系列非直觉但极为有效的优化技巧,助力开发者在快节奏的互联网环境中抢占先机。
|
3月前
|
JSON 中间件 Go
Go语言Web框架Gin介绍
【7月更文挑战第19天】Gin是一个功能强大、高性能且易于使用的Go语言Web框架。它提供了路由、中间件、参数绑定等丰富的功能,帮助开发者快速构建高质量的Web应用。通过本文的介绍,你应该对Gin框架有了初步的了解,并能够使用它来开发简单的Web服务。随着你对Gin的深入学习和实践,你将能够利用它构建更复杂、更强大的Web应用。
|
2月前
|
API Go 数据安全/隐私保护
go-zero微服务框架的静态文件服务
【8月更文挑战第7天】`go-zero` 微服务框架支持多种静态文件服务实现方式。常用方法是利用 `Go` 标准库 `http.FileServer`。通过设置静态文件根目录并使用 `http.StripPrefix` 去除路径前缀,能确保 `/static/` 开头的请求正确返回文件。此外,结合 `go-zero` 的路由机制可更灵活地控制静态文件服务,例如仅在特定 API 路径 `/api/static` 下提供服务,从而实现精细化访问控制。
|
2月前
|
网络协议 Go
下一篇
无影云桌面