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 -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服务的资料请关注脚本之家其它相关文章！
相关文章
这篇文章主要为大家介绍了GO语言基本类型String和Slice,Map操作示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-08-08
在Kafka中无论是生产者发送消息到Kafka集群还是消费者从Kafka集群中拉取消息,都是容易出现问题的,比较典型的就是消费端的重复消费问题、生产端和消费端产生的消息丢失问题,下面将对这两个问题出现的场景以及常见的解决方案进行讲解2023-08-08
Golang中urlencode与urldecode编码解码详解
这篇文章主要给大家介绍了关于Golang中urlencode与urldecode编码解码的相关资料,在Go语言中转码操作非常方便,可以使用内置的encoding包来快速完成转码操作,Go语言中的encoding包提供了许多常用的编码解码方式,需要的朋友可以参考下2023-09-09
本文主要介绍了golang实现数组分割的示例代码，要求把数组分割成多个正整数大小的数组，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2021-12-12
这篇文章主要介绍了Go语言中接口组合的实现方法,实例分析了接口中包含接口的实现技巧,需要的朋友可以参考下2015-02-02
errgroup和sync.WaitGroup类似,都可以发起执行并等待一组协程直到所有协程运行结束,本文主要为大家整理了一些errgroup的常见误用,有需要的可以参考下2024-01-01
关于golang监听rabbitmq消息队列任务断线自动重连接的问题
这篇文章主要介绍了golang监听rabbitmq消息队列任务断线自动重连接,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2022-03-03
平常我们在开发API的时候，前端传递过来的大批数据需要经过后端处理，如果后端处理的速度快，前端响应就快，反之则很慢，影响用户体验，为了解决这一问题，需要我们自己实现后台任务调度系统，本文将介绍如何用Go语言实现后台任务调度系统,需要的朋友可以参考下2023-06-06
本文主要介绍了go map搬迁的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-04-04
这篇文章主要介绍了golang动态创建类的实例代码，本文通过实例代码给大家讲解的非常详细，需要的朋友可以参考下2023-06-06
最新评论