grpcurl如何通過(guò)命令行訪問(wèn)gRPC服務(wù)

本篇內(nèi)容主要講解“grpcurl如何通過(guò)命令行訪問(wèn)gRPC服務(wù)”，感興趣的朋友不妨來(lái)看看。本文介紹的方法操作簡(jiǎn)單快捷，實(shí)用性強(qiáng)。下面就讓小編來(lái)帶大家學(xué)習(xí)“grpcurl如何通過(guò)命令行訪問(wèn)gRPC服務(wù)”吧!

gRPC Server

首先來(lái)寫一個(gè)簡(jiǎn)單的 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()
    // 注冊(cè) grpcurl 所需的 reflection 服務(wù)
    reflection.Register(server)
    // 注冊(cè)業(yè)務(wù)服務(wù)
    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
}

運(yùn)行服務(wù)：

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 環(huán)境的話，可以通過(guò) go tool 來(lái)安裝：

go install github.com/fullstorydev/grpcurl/cmd/grpcurl@latest

grpcurl 使用

查看服務(wù)列表：

grpcurl -plaintext 127.0.0.1:50051 list

輸出：

grpc.reflection.v1alpha.ServerReflection
proto.Greeter

查看某個(gè)服務(wù)的方法列表：

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 );

查看請(qǐng)求參數(shù)：

grpcurl -plaintext 127.0.0.1:50051 describe proto.HelloRequest

輸出：

proto.HelloRequest is a message:
message HelloRequest {
  string name = 1;
}

請(qǐng)求服務(wù)：

grpcurl -d '{"name": "zhangsan"}' -plaintext 127.0.0.1:50051 proto.Greeter.SayHello

輸出：

{
  "message": "hello"
}

可能遇到的錯(cuò)誤

可能會(huì)遇到兩個(gè)報(bào)錯(cuò)：

1、gRPC Server 未啟用 TLS：

報(bào)錯(cuò)信息：

Failed to dial target host "127.0.0.1:50051": tls: first record does not look like a TLS handshake

解決：

請(qǐng)求時(shí)增加參數(shù)：-plaintext，參考上面的命令。

2、參數(shù)格式錯(cuò)誤：

報(bào)錯(cuò)信息：

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

解決：

-d 后面參數(shù)為 json 格式，并且需要使用 '' 包裹起來(lái)。

到此，相信大家對(duì)“grpcurl如何通過(guò)命令行訪問(wèn)gRPC服務(wù)”有了更深的了解，不妨來(lái)實(shí)際操作一番吧！這里是億速云網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！