原文链接： 使用 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: