原文連結： 使用 grpcurl 通過命令列訪問 gRPC 服務
一般情況下測試 gRPC 服務，都是通過客戶端來直接請求服務端。如果客戶端還沒準備好的話，也可以使用 BloomRPC 這樣的 GUI 客戶端。
如果環境不支援安裝這種 GUI 客戶端的話，那麼有沒有一種工具，類似於 curl 這樣的，直接通過終端，在命令列發起請求呢？
答案肯定是有的，就是本文要介紹的 grpcurl。
gRPC Server
首先來寫一個簡單的 gRPC Server：
helloworld.proto：
syntax = "proto3";
package proto;
// The greeting service definition.
service Greeter {
// Sends a greeting
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
// The request message containing the user's name.
message HelloRequest {
string name = 1;
}
// The response message containing the greetings
message HelloReply {
string message = 1;
}
main.go
package main
import (
"context"
"fmt"
"grpc-hello/proto"
"log"
"net"
"google.golang.org/grpc"
"google.golang.org/grpc/reflection"
)
func main() {
lis, err := net.Listen("tcp", ":50051")
if err != nil {
log.Fatalf("failed to listen: %v", err)
}
server := grpc.NewServer()
// 註冊 grpcurl 所需的 reflection 服務
reflection.Register(server)
// 註冊業務服務
proto.RegisterGreeterServer(server, &greeter{})
fmt.Println("grpc server start ...")
if err := server.Serve(lis); err != nil {
log.Fatalf("failed to serve: %v", err)
}
}
type greeter struct {
}
func (*greeter) SayHello(ctx context.Context, req *proto.HelloRequest) (*proto.HelloReply, error) {
fmt.Println(req)
reply := &proto.HelloReply{Message: "hello"}
return reply, nil
}
執行服務：
go run main.go
server start ...
grpcurl 安裝
這裡我介紹三種方式：
Mac
brew install grpcurl
Docker
# Download image
docker pull fullstorydev/grpcurl:latest
# Run the tool
docker run fullstorydev/grpcurl api.grpc.me:443 list
go tool
如果有 Go 環境的話，可以通過 go tool 來安裝：
go install github.com/fullstorydev/grpcurl/cmd/grpcurl@latest
grpcurl 使用
在使用 grpcurl 時，需要通過 -cert 和 -key 引數設定公鑰和私鑰檔案，表示連結啟用了 TLS 協議的服務。
對於沒有啟用 TLS 協議的 gRPC 服務，通過 -plaintext 引數忽略 TLS 證書的驗證過程。
如果是 Unix Socket 協議，則需要指定 -unix 引數。
檢視服務列表：
grpcurl -plaintext 127.0.0.1:50051 list
輸出：
grpc.reflection.v1alpha.ServerReflection
proto.Greeter
檢視某個服務的方法列表：
grpcurl -plaintext 127.0.0.1:50051 list proto.Greeter
輸出：
proto.Greeter.SayHello
檢視方法定義：
grpcurl -plaintext 127.0.0.1:50051 describe proto.Greeter.SayHello
輸出：
proto.Greeter.SayHello is a method:
rpc SayHello ( .proto.HelloRequest ) returns ( .proto.HelloReply );
檢視請求引數：
grpcurl -plaintext 127.0.0.1:50051 describe proto.HelloRequest
輸出：
proto.HelloRequest is a message:
message HelloRequest {
string name = 1;
}
請求服務：
grpcurl -d '{"name": "zhangsan"}' -plaintext 127.0.0.1:50051 proto.Greeter.SayHello
輸出：
{
"message": "hello"
}
-d 引數後面也可以跟 @，表示從標準輸入讀取 json 引數，一般用於輸入比較複雜的 json 資料，也可以用於測試流方法。
grpcurl -d @ -plaintext 127.0.0.1:50051 proto.Greeter.SayHello
可能遇到的錯誤
可能會遇到三個報錯：
1、gRPC Server 未啟用 TLS：
報錯資訊：
Failed to dial target host "127.0.0.1:50051": tls: first record does not look like a TLS handshake
解決：
請求時增加引數：-plaintext，參考上面的命令。
2、服務沒有啟動 reflection 反射服務
報錯資訊：
Failed to list services: server does not support the reflection API
解決：
這行程式碼是關鍵，一定要包含：
// 註冊 grpcurl 所需的 reflection 服務
reflection.Register(server)
3、引數格式錯誤：
報錯資訊：
Error invoking method "greet.Greeter/SayHello": error getting request data: invalid character 'n' looking for beginning of object key string
解決：
-d 後面引數為 json 格式，並且需要使用 '' 包裹起來。
總結
用這個工具做一些簡單的測試還是相當方便的，上手也簡單。只要掌握文中提到的幾條命令，基本可以涵蓋大部分的測試需求了。
擴充套件閱讀：
文章中的腦圖和原始碼都上傳到了 GitHub，有需要的同學可自行下載。
地址： https://github.com/yongxinz/gopher/tree/main/blog
往期文章列表：
Go 專欄文章列表：