概述
最近這段時間工作挺忙的,發現已經 3 周沒更文了...
感謝你們還在,今天給大家分享一款 gRPC 的調試工具。
進入正題。
當我們在寫 HTTP 接口的時候,使用的是 Postman 進行接口調試,那么在寫 gRPC 接口的時候,有沒有類似於 Postman 的調試工具呢?
這是有的。
咱們一起看下 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/
到這,我們看到 Service name、Method name 都出來了,傳輸參數直接在頁面上進行操作即可。
當發起 Request "Tom",也能獲得 Response “Tom”。
當然,如果這個服務下面有多個 Service name,多個 Method name 也都會顯示出來的,去試試吧。