grpcurl通過命令列存取gRPC服務

2022-06-15 18:02:04

前言

一般情況下測試 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, &amp;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 := &amp;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 -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"
}

可能遇到的錯誤

可能會遇到兩個報錯：

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、引數格式錯誤：

報錯資訊：

Error invoking method "greet.Greeter/SayHello": error getting request data: invalid character 'n' looking for beginning of object key string

解決：

-d 後面引數為 json 格式，並且需要使用 '' 包裹起來。

總結

用這個工具做一些簡單的測試還是相當方便的，上手也簡單。只要掌握文中提到的幾條命令，基本可以涵蓋大部分的測試需求了

擴充套件閱讀：

https://appimage.github.io/BloomRPC/

https://github.com/fullstorydev/grpcurl

原始碼下載地址：https://github.com/yongxinz/gopher/tree/main/blog

以上就是grpcurl通過命令列存取gRPC服務的詳細內容，更多關於grpcurl命令列存取gRPC服務的資料請關注it145.com其它相關文章！