答案:在Golang中通过gRPC网关将REST转为gRPC调用需定义带google.api.http注解的proto文件,生成gRPC和服务代码后分别启动gRPC服务器和HTTP网关,实现RESTful API到内部gRPC的自动转换。

在Golang中使用gRPC网关将REST请求转换为gRPC调用,是构建现代微服务API的常见做法。它允许你通过HTTP/JSON对外提供RESTful接口,同时内部使用高性能的gRPC进行服务间通信。整个流程依赖于Protocol Buffers定义服务,并借助grpc-gateway生成反向代理代码。
定义Protocol Buffer服务
要启用gRPC网关,首先需要在.proto文件中定义gRPC服务,并添加特定的google.api.http注解来映射REST路径。
安装必要的proto插件:
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latestgo install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
编写service.proto文件:
立即学习“go语言免费学习笔记(深入)”;
syntax = "proto3";package example;
import "google/api/annotations.proto";
message HelloRequest {
string name = 1;
}
message HelloResponse {
string message = 1;
}
service Greeter {
rpc SayHello (HelloRequest) returns (HelloResponse) {
option (google.api.http) = {
get: "/v1/hello/{name}"
};
}
}
这里option (google.api.http)将SayHello方法绑定到GET /v1/hello/{name},URL中的{name}会自动映射到请求字段。
生成gRPC和gRPC-Gateway代码
运行protoc命令生成Go代码:
--go_out=. --go_opt=paths=source_relative \
--go-grpc_out=. --go-grpc_opt=paths=source_relative \
--grpc-gateway_out=. --grpc-gateway_opt=paths=source_relative \
service.proto
这会生成三个文件:
-
service.pb.go:基础结构体和gRPC客户端/服务接口 -
service_grpc.pb.go:gRPC服务实现桩代码 -
service.pb.gw.go:gRPC网关的HTTP处理器,负责将REST转为gRPC调用
启动gRPC服务与HTTP网关
你需要同时运行gRPC服务器和HTTP网关。通常gRPC监听本地端口,而HTTP网关作为前端代理转发请求。
实现gRPC服务:
type server struct{}func (s *server) SayHello(ctx context.Context, req *example.HelloRequest) (*example.HelloResponse, error) {
return &example.HelloResponse{Message: "Hello " + req.Name}, nil
}
启动gRPC服务器:
lis, _ := net.Listen("tcp", ":50051")s := grpc.NewServer()
example.RegisterGreeterServer(s, &server{})
s.Serve(lis)
启动HTTP网关(反向代理):
ctx := context.Background()mux := runtime.NewServeMux()
opts := []grpc.DialOption{grpc.WithInsecure()}
_ = example.RegisterGreeterHandlerFromEndpoint(ctx, mux, "localhost:50051", opts)
http.ListenAndServe(":8080", mux)
现在你可以通过GET /v1/hello/world访问服务,网关会将其转换为gRPC调用并返回JSON响应。
处理复杂路由和方法
除了GET,你还可以映射POST、PUT等方法,并指定body字段:
rpc CreateBook(CreateBookRequest) returns (CreateBookResponse) {option (google.api.http) = {
post: "/v1/shelves/{shelf_id}/books"
body: "book"
};
}
这表示POST数据到/v1/shelves/123/books,请求体中的JSON会被解析到book字段。
确保你的proto文件导入google/api/annotations.proto和google/api/http.proto,可通过buf或手动下载管理依赖。
基本上就这些。只要定义好proto注解,生成代码并正确启动两个服务,gRPC网关就能自动完成REST到gRPC的转换,无需手动写HTTP handler。这种方式统一了API契约,便于维护和文档生成。不复杂但容易忽略的是注解语法和生成命令的参数顺序。










