gRPC-Gateway 使用教程

gRPC-Gateway 使用教程

grpc-gatewaygRPC to JSON proxy generator following the gRPC HTTP spec项目地址:https://gitcode.com/gh_mirrors/gr/grpc-gateway

1. 项目目录结构及介绍

gRPC-Gateway 的标准目录结构通常包括以下几个部分：

├── proto           # 存放.proto定义的服务协议文件
│   ├── helloworld  # 示例服务的目录
│   │   └── hello_world.proto
│   └── ...
├── main.go         # 主程序文件，包含gRPC-Gateway的启动逻辑
├── Makefile        # 构建脚本，用于编译和测试项目
└── README.md       # 项目说明文件

• proto: 此目录存放所有的gRPC服务定义。.proto文件描述了服务接口以及消息类型。
• main.go: 这是项目的入口点，它包含了启动gRPC服务器和gRPC-Gateway的代码。
• Makefile: 提供构建和运行项目的命令集合。
• README.md: 项目的基本信息和快速入门指南。

2. 项目的启动文件介绍

main.go 文件是项目的启动文件，其主要任务是设置gRPC服务器并启动gRPC-Gateway的反向代理。例如：

package main

import (
	"net"

	"github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
	"google.golang.org/grpc"
)

func main() {
	// 创建gRPC监听地址
	lis, err := net.Listen("tcp", "localhost:50051")
	if err != nil {
		// 处理错误...
	}

	// 初始化gRPC服务器
	server := grpc.NewServer()
	// 注册你的gRPC服务实现到服务器...
注册服务(server)

	// 创建gRPC-Gateway Mux
	gwmux := runtime.NewServeMux()

	// 启动gRPC Gateway，将REST请求映射到gRPC
	err = RegisterYourService(context.Background(), gwmux, lis)
	if err != nil {
		// 处理错误...
	}

	// 开启HTTP服务器，处理gRPC-Gateway的请求
	go func() {
		http.Handle("/", gwmux)
		if err := http.ListenAndServe(":8080", nil); err != nil {
			// 处理错误...
		}
	}()

	// 开始gRPC服务器
	server.Serve(lis)
}

在上述示例中，RegisterYourService 函数用于将gRPC服务注册到gRPC-Gateway，这样gRPC-Gateway可以处理相应的HTTP请求并将它们转发给gRPC服务。

3. 项目的配置文件介绍

gRPC-Gateway 不依赖于特定的外部配置文件来运行，但可以通过在.proto文件中添加自定义选项来配置其行为。例如，你可以使用option关键字来自定义OpenAPI（Swagger）规范，或者控制哪些HTTP方法映射到gRPC方法：

syntax = "proto3";

import "google/api/annotations.proto";

service HelloWorldService {
  rpc SayHello (HelloRequest) returns (HelloReply) {
    option (google.api.http) = {
      post: "/say_hello"
      body: "*"
    };
  }
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

在这个例子中，SayHello 方法被配置为响应POST请求到 /say_hello 路径，并且请求体将映射到HelloRequest消息的所有字段（body: "*")。

要获取更多关于gRPC-Gateway配置的详细信息，可以查阅官方文档。

grpc-gatewaygRPC to JSON proxy generator following the gRPC HTTP spec项目地址:https://gitcode.com/gh_mirrors/gr/grpc-gateway