在go语言中grpc-gateway项目的初始化流程步骤

2023-06-01 00:00:00 grpc 语言

在go语言中初始化一个grpc-gateway项目的步骤:

1.确保您已经安装了 gRPC 和 Protocol Buffers,您可以从官方网站上下载和安装它们。

2.创建一个新的项目文件夹,例如 myproject,并进入该文件夹。

3.在该文件夹中创建一个新的 Go 模块,使用以下命令:

go mod init myproject

然后,安装必要的依赖项,使用以下命令:

go get -u github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway
go get -u github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2
go get -u google.golang.org/grpc/cmd/protoc-gen-go-grpc
go get -u google.golang.org/protobuf/cmd/protoc-gen-go

这些依赖项将安装必要的 gRPC 和 grpc-gateway 代码生成工具。


创建一个名为proto的文件夹,并在其中创建一个名为 myapi.proto 的文件。

在该文件中定义您的 API 服务。

编写myapi.proto文件后,使用以下命令生成 gRPC 和 grpc-gateway 的 Go 代码:

protoc -I/usr/local/include -I. \
-I $GOPATH/src \
-I $GOPATH/pkg/mod/github.com/grpc-ecosystem/grpc-gateway/[email protected]/third_party/googleapis \
--go_out=. --go-grpc_out=. \
--grpc-gateway_out=. \
myapi.proto

这将生成 myapi.pb.go 和 myapi_grpc.pb.go 文件以及一个 myapi.pb.gw.go 文件。


创建一个名为 cmd 的文件夹,并在其中创建一个名为 main.go 的文件。

在该文件中编写您的主要应用程序逻辑。

在main.go文件中,使用以下代码将 grpc-gateway 添加到您的应用程序中:

mux := runtime.NewServeMux()
opts := []grpc.DialOption{grpc.WithInsecure()}
err := myapi.RegisterMyAPIServiceHandlerFromEndpoint(ctx, mux, "localhost:9090", opts)
if err != nil {
log.Fatalf("failed to start grpc-gateway server: %v", err)
}
http.ListenAndServe(":8080", mux)

这将创建一个新的 ServeMux,并将其用作grpc-gateway的代理。

然后,使用

RegisterMyAPIServiceHandlerFromEndpoint 

函数将您的 gRPC 服务绑定到代理上。


运行您的应用程序,使用以下命令:

go run cmd/main.go

这将启动您的应用程序,并使您的gRPC服务可以通过grpc-gateway 代理访问。

这些步骤应该可以帮助您初始化一个grpc-gateway项目。

相关文章