欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Go gRPC 调试工具

程序员文章站 2022-05-18 20:24:55
概述最近这段时间工作挺忙的,发现已经 3 周没更文了...感谢你们还在,今天给大家分享一款 gRPC 的调试工具。进入正题。当我们在写 HTTP 接口的时候,使用的是 Postman 进行接口调试,那么在写 gRPC 接口的时候,有没有类似于 Postman 的调试工具呢?当然是有的 ~ 咱们一起看 ......

概述

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

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

进入正题。

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

Go gRPC 调试工具
当然是有的 ~

咱们一起看下 grpcui,源码地址:

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 文件:

 

   syntax = "proto3"; // 指定 proto 版本    
    package listen;     // 指定包名    
    // 定义服务    
    service listen {    
        // 定义方法    
        rpc listendata(request) returns (response) {}    
    }    
    // request 请求结构    
    message request {    
        string name = 1;    
    }    
    // response 响应结构    
    message response {    
        string message = 1;    
    }

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

    service name 为 listen.listen

    method name 为 listendata

再看下 listendata 方法:

    func (l *listencontroller) listendata(ctx context.context, in *listen.request) (*listen.response, error) {    
        return &listen.response{message : fmt.sprintf("[%s]", in.name)}, nil    
    }

 


这表示,将 name 直接返回。

源码地址:

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

启动服务

cd listen && go run main.go

 



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

grpcui 使用
安装

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

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

 


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

执行个命令,验证下:

grpcui -help

输出:

    usage:    
        grpcui [flags] [address]    
    ......    

 



表示安装成功了。

运行

    grpcui -plaintext 127.0.0.1:9901    
    failed to compute set of methods to expose: server does not support the reflection api

 



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

reflection.register(s)

在运行一次试试:

    grpcui -plaintext 127.0.0.1:9901    
    grpc web ui available at http://127.0.0.1:63027/

 



表示运行成功了。

在浏览器中访问:http://127.0.0.1:63027/
Go gRPC 调试工具

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

当发起 request "tom",也能获得 response “tom”。

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