Go gRPC 调试工具

Posted 新亮笔记

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Go gRPC 调试工具相关的知识,希望对你有一定的参考价值。

概述

最近这段时间工作挺忙的,发现已经 3 周没更文了...

感谢你们还在,今天给大家分享一款 gRPC 的调试工具。

进入正题。


当我们在写 HTTP 接口的时候,使用的是 Postman 进行接口调试,那么在写 gRPC 接口的时候,有没有类似于 Postman 的调试工具呢?

当然是有的 ~ 

https://github.com/fullstorydev/grpcui

看下官方描述:

grpcui is a command-line tool that lets you interact with gRPC servers via a browser. It's sort of like Postman, but for gRPC APIs instead of REST.

下面带大家一起用用...


写一个 gRPC API

我原来写过 Demo,可以直接用原来写的 listen 项目。

端口:9901

.proto 文件:

 
   
   
 
  1. syntax = "proto3"; // 指定 proto 版本


  2. package listen; // 指定包名


  3. // 定义服务

  4. service Listen {


  5. // 定义方法

  6. rpc ListenData(Request) returns (Response) {}


  7. }


  8. // Request 请求结构

  9. message Request {

  10. string name = 1;

  11. }


  12. // Response 响应结构

  13. message Response {

  14. string message = 1;

  15. }

很简单,这个大家一看就知道了。

  • Service name 为 listen.Listen

  • Method name 为 ListenData


再看下 ListenData 方法:

 
   
   
 
  1. func (l *ListenController) ListenData(ctx context.Context, in *listen.Request) (*listen.Response, error) {

  2. return &listen.Response{Message : fmt.Sprintf("[%s]", in.Name)}, nil

  3. }

这表示,将 Name 直接返回。


https://github.com/xinliangnote/go-jaeger-demo/tree/master/listen


启动服务

 
   
   
 
  1. cd listen && go run main.go

服务启动成功后,等待使用。


grpcui 使用

安装

根据官方 README.md 文档安装即可。

 
   
   
 
  1. go get github.com/fullstorydev/grpcui

  2. go install github.com/fullstorydev/grpcui/cmd/grpcui

这时,在 $GOPATH/bin 目录下,生成一个 grpcui 可执行文件。


执行个命令,验证下:

 
   
   
 
  1. grpcui -help

输出:

 
   
   
 
  1. Usage:

  2. grpcui [flags] [address]


  3. ......

表示安装成功了。


运行

 
   
   
 
  1. grpcui -plaintext 127.0.0.1:9901


  2. Failed to compute set of methods to expose: server does not support the reflection API

这种情况下,加个反射就可以了,在 listen 的 main.go 新增如下代码即可:

 
   
   
 
  1. reflection.Register(s)


在运行一次试试:

 
   
   
 
  1. grpcui -plaintext 127.0.0.1:9901

  2. gRPC Web UI available at http://127.0.0.1:63027/

表示运行成功了。


在浏览器中访问:http://127.0.0.1:63027/

到这,我们看到 Service name、Method name 都出来了,传输参数直接在页面上进行操作即可。

当发起 Request "Tom",也能获得 Response “Tom”。

当然,如果这个服务下面有多个 Service name,多个 Method name 也都会显示出来的,去试试吧。


go-gin-api 系列文章


以上是关于Go gRPC 调试工具的主要内容,如果未能解决你的问题,请参考以下文章

Go gRPC 调试工具

Go gRPC 调试工具

微服务实战之 Go gRPC 调试工具

使用 gRPC-UI 调试.NET 5的gPRC服务

如何调试 gRPC-Go 服务?

grpc调试工具