gRPC 入门实战:从 Proto 定义到跨语言服务调用
【摘要】 gRPC 入门实战:从 Proto 定义到跨语言服务调用 一、gRPC 是什么gRPC 是基于 HTTP/2 + Protocol Buffers 的高性能 RPC 框架。相比 REST + JSON,它的接口由 .proto 文件强类型定义,二进制编码体积更小、解析更快,天然支持双向流、超时传递与元数据。对比项REST / JSONgRPC协议HTTP/1.1(多为)HTTP/2(多路复...
gRPC 入门实战:从 Proto 定义到跨语言服务调用
一、gRPC 是什么
gRPC 是基于 HTTP/2 + Protocol Buffers 的高性能 RPC 框架。相比 REST + JSON,它的接口由 .proto 文件强类型定义,二进制编码体积更小、解析更快,天然支持双向流、超时传递与元数据。
| 对比项 | REST / JSON | gRPC |
|---|---|---|
| 协议 | HTTP/1.1(多为) | HTTP/2(多路复用、头部压缩) |
| 载荷 | 文本 JSON | 二进制 Protobuf |
| 契约 | OpenAPI 文档(后置) | .proto(先定义,再生成代码) |
| 流式 | 需 SSE / WebSocket | 原生四种调用方式 |
| 浏览器 | 原生支持 | 需 gRPC-Web 或网关 |
四种调用方式:一元调用(Unary)、服务端流、客户端流、双向流。内部微服务间通信最常用一元调用。
二、定义服务契约
// hello.proto
syntax = "proto3";
package demo;
option go_package = "./pb";
service Greeter {
rpc SayHello (HelloRequest) returns (HelloReply);
rpc BatchHello (stream HelloRequest) returns (HelloReply); // 客户端流
}
message HelloRequest { string name = 1; }
message HelloReply { string message = 1; int32 code = 2; }
字段后的数字是字段编号,一旦上线不可更改(二进制兼容的基础)。1~15 编码只占 1 字节,留给高频字段。
三、生成代码并实现服务端(Python)
pip install grpcio grpcio-tools
python -m grpc_tools.protoc -I. --python_out=. --grpc_python_out=. hello.proto
# 生成 hello_pb2.py(消息类型)与 hello_pb2_grpc.py(桩代码)
# server.py
from concurrent import futures
import grpc
import hello_pb2, hello_pb2_grpc
class Greeter(hello_pb2_grpc.GreeterServicer):
def SayHello(self, request, context):
if not request.name:
context.abort(grpc.StatusCode.INVALID_ARGUMENT, "name 不能为空")
return hello_pb2.HelloReply(message=f"Hello, {request.name}!", code=0)
def BatchHello(self, request_iterator, context):
names = [r.name for r in request_iterator]
return hello_pb2.HelloReply(message=f"共收到 {len(names)} 个名字", code=0)
server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
hello_pb2_grpc.add_GreeterServicer_to_server(Greeter(), server)
server.add_insecure_port("[::]:50051")
server.start()
server.wait_for_termination()
四、客户端调用与调试
import grpc, hello_pb2, hello_pb2_grpc
with grpc.insecure_channel("localhost:50051") as ch:
stub = hello_pb2_grpc.GreeterStub(ch)
resp = stub.SayHello(hello_pb2.HelloRequest(name="华为云"), timeout=3)
print(resp.message, resp.code)
# 客户端流:用生成器持续推送
reqs = (hello_pb2.HelloRequest(name=n) for n in ["A", "B", "C"])
print(stub.BatchHello(reqs, timeout=5).message)
命令行调试推荐 grpcurl(需服务端开启反射):
grpcurl -plaintext localhost:50051 list
grpcurl -plaintext -d '{"name":"华为云"}' localhost:50051 demo.Greeter/SayHello
生产环境用 grpc.secure_channel() + ssl_channel_credentials() 开启 TLS,敏感信息放 metadata 而不是请求体。
五、五个常见坑
- 忘记设置 deadline → 客户端会无限等待;每次调用都显式传
timeout,服务端用context.is_active()及时退出 - 改了字段编号或类型 → 老客户端解析出错;新增字段用新编号,废弃字段用
reserved标记编号与名字 - 异常被吞成
UNKNOWN→ 主动用context.abort(StatusCode.XXX, msg)返回明确状态码,别直接抛 Python 异常 - 流式调用内存暴涨 → 客户端流要边生成边发送,别先构造完整列表;服务端流要控制单条消息大小(默认 4 MB 上限)
- K8s 里负载均衡不生效 → HTTP/2 长连接会粘在单个 Pod 上,需 Headless Service + 客户端负载均衡,或用 L7 代理 / Service Mesh
六、小结
gRPC 的门槛不在语法而在契约管理:.proto 要先评审、先兼容、再生成多语言代码。把「字段编号不可变」「每次调用带 deadline」「明确状态码」这三条守住了,跨语言微服务调用会比手写 REST 客户端省心得多。
【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱:
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
评论(0)