探索高效gRPC客户端：grpcui与grpcurl实践

gRPC客户端工具的需求与挑战

在开发和测试grpc服务时，选择一款合适的客户端工具至关重要。与传统的restful api不同，grpc基于http/2和protocol buffers（protobuf），其二进制消息格式和流式通信特性使得通用http客户端（如postman、insomnia的早期版本或curl）难以直接有效支持。开发者常常面临以下挑战：

• Protobuf序列化/反序列化： 需要手动构建复杂的二进制请求体，难以直观地查看响应。
• 服务反射（Server Reflection）： 缺乏对服务器端暴露的服务和方法信息的自动发现能力。
• 流式RPC支持： 难以模拟和测试客户端流、服务端流以及双向流等gRPC特有的通信模式。

为了解决这些问题，我们需要专门为gRPC设计的客户端工具。

grpcurl：强大的命令行gRPC客户端

grpcurl是一个功能强大、跨平台的命令行工具，它允许用户像使用curl测试HTTP服务一样测试gRPC服务。它能够自动发现gRPC服务（通过服务反射），并支持所有四种gRPC RPC类型（一元、客户端流、服务端流、双向流）。

1. 安装 grpcurl

grpcurl是用Go语言编写的。最简单的安装方式是下载预编译的二进制文件，或者如果您已经安装了Go环境，可以通过Go命令安装：

下载预编译二进制文件： 访问grpcurl的GitHub发布页面（https://github.com/fullstorydev/grpcurl/releases），根据您的操作系统下载对应的版本，并将其添加到系统PATH中。

使用Go安装（需要Go环境）：

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

安装完成后，您可以在命令行中运行grpcurl --help来验证安装是否成功。

2. grpcurl 基本使用

grpcurl的核心优势在于其对gRPC服务反射的支持。如果您的gRPC服务启用了服务反射，grpcurl可以自动发现服务、方法和消息定义，无需提供.proto文件。

a. 列出服务和方法：

假设您的gRPC服务运行在localhost:50051：

grpcurl localhost:50051 list

这将列出所有可用的服务。要列出某个服务下的所有方法：

grpcurl localhost:50051 list <service_name>
# 示例：
grpcurl localhost:50051 list helloworld.Greeter

b. 描述服务、方法或消息：

要查看某个方法或消息的详细定义：

grpcurl localhost:50051 describe <service_name>.<method_name>
# 示例：
grpcurl localhost:50051 describe helloworld.Greeter.SayHello

c. 调用一元RPC：

调用一元RPC时，请求数据通常以JSON格式通过-d参数传递。grpcurl会自动将其转换为Protobuf二进制格式。

刺鸟创客

一款专业高效稳定的AI内容创作平台

61

查看详情

grpcurl -d '{"name": "World"}' localhost:50051 helloworld.Greeter.SayHello

d. 调用流式RPC：

对于流式RPC，您可以通过管道或文件提供多条JSON消息。

• 客户端流：

  echo '{"name": "Alice"}' | grpcurl -d @ localhost:50051 helloworld.Greeter.SayHelloClientStream
  echo '{"name": "Bob"}' >> request.json
  echo '{"name": "Charlie"}' >> request.json
  grpcurl -d @ request.json localhost:50051 helloworld.Greeter.SayHelloClientStream

  登录后复制
• 服务端流：

  grpcurl -d '{"count": 3}' localhost:50051 helloworld.Greeter.SayHelloServerStream

  登录后复制
• 双向流：

  echo '{"name": "Alice"}' | grpcurl -d @ localhost:50051 helloworld.Greeter.SayHelloBidiStream
  echo '{"name": "Bob"}' >> request.json
  echo '{"name": "Charlie"}' >> request.json
  grpcurl -d @ request.json localhost:50051 helloworld.Greeter.SayHelloBidiStream

  登录后复制

grpcui：Web界面的grpcurl

grpcui是一个基于grpcurl构建的交互式Web界面工具。它提供了一个直观的用户界面，让您可以更轻松地浏览gRPC服务、构造请求并查看响应，尤其适合那些不习惯命令行操作或需要更可视化调试体验的用户。

1. 安装 grpcui

与grpcurl类似，grpcui也可以通过下载预编译二进制文件或Go命令安装。

下载预编译二进制文件： 访问grpcui的GitHub发布页面（https://github.com/fullstorydev/grpcui/releases），下载对应的版本，并将其添加到系统PATH中。

使用Go安装（需要Go环境）：

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

2. grpcui 基本使用

grpcui启动后会在本地启动一个Web服务器，您可以通过浏览器访问其界面。

a. 启动 grpcui 并连接服务：

假设您的gRPC服务运行在localhost:50051：

grpcui localhost:50051

执行此命令后，grpcui会显示一个URL（通常是http://localhost:8080或随机端口），在浏览器中打开该URL即可。

b. 交互式界面操作：

在grpcui的Web界面中，您可以：

• 选择服务和方法： 左侧导航栏会自动列出通过服务反射发现的所有服务和方法。
• 构造请求： 选中一个方法后，界面会根据Protobuf定义自动生成请求体的JSON模板。您可以直接在文本框中编辑JSON数据。
• 发送请求： 点击“Invoke”按钮发送请求。
• 查看响应： 响应结果会以JSON格式显示在界面下方。
• 支持流式RPC： 界面会提供相应的控件来模拟流式请求和接收流式响应。

总结与注意事项

• 服务反射的重要性： grpcurl和grpcui都高度依赖于gRPC服务的服务反射功能。如果您的gRPC服务没有启用服务反射，您将需要通过-proto或-protoset参数手动提供.proto文件或预编译的.protoset文件来让这些工具理解服务定义。在.NET中，可以通过添加Grpc.AspNetCore.Server.Reflection NuGet包并在Startup.cs中配置来启用服务反射。
• Web-based vs. Windows-based： grpcui本身是一个命令行工具，但它启动了一个本地Web服务器，其交互界面通过浏览器访问，因此可以被视为一种“Web-based”的gRPC客户端，可在任何支持Web浏览器的系统上使用。grpcurl则是一个纯粹的命令行工具，支持Windows、Linux、macOS等多种操作系统。
• 替代方案： 虽然grpcurl和grpcui是非常优秀的工具，但市场上也有其他选择，例如：
  • Postman/Insomnia： 它们近年也增加了对gRPC的支持，但可能在某些高级功能（如复杂流式场景）上不如专门的gRPC工具灵活。
  • BloomRPC： 一款基于Electron的桌面GUI客户端，提供类似Postman的体验。
  • Visual Studio Code 扩展： 如gRPC Client等，直接在IDE中进行测试。

通过掌握grpcurl和grpcui，gRPC开发者可以极大地提高开发和调试效率，确保gRPC服务的质量和稳定性。

以上就是探索高效gRPC客户端：grpcui与grpcurl实践的详细内容，更多请关注php中文网其它相关文章！