当前位置：首页 > 文章列表 > Golang > Go教程 > Golang搭建gRPC服务：proto定义与生成教程

Golang搭建gRPC服务：proto定义与生成教程

2025-10-27 16:50:28 0浏览收藏

本文详细介绍了如何使用 Golang 构建 gRPC 服务，并针对百度 SEO 进行了优化。首先，通过 Protocol Buffers 定义接口和消息结构，编写 `.proto` 文件，例如定义 `UserService` 服务和 `GetUser` 方法。接着，安装 `protoc` 编译器及 Go 插件，并执行 `protoc` 命令生成 `service.pb.go` 和 `service_grpc.pb.go` 文件，这两个文件包含了消息结构的 Go 类型、序列化方法以及客户端和服务端接口。随后，文章指导如何编写服务端代码实现 `GetUser` 逻辑，并启动 gRPC 服务器监听 50051 端口。最后，演示了客户端代码如何连接服务器并调用 `GetUser` 方法获取用户信息，从而完整地展示了 gRPC 服务的构建流程。掌握这些步骤，你就能轻松构建高效的 gRPC 服务。

第一步是定义proto文件，使用Protocol Buffers编写接口和消息结构，如定义UserService服务和GetUser方法；接着安装protoc编译器及Go插件，执行protoc命令生成service.pb.go和service_grpc.pb.go文件；然后编写服务端代码实现GetUser逻辑，并启动gRPC服务器监听50051端口；最后编写客户端代码连接服务器并调用GetUser方法获取用户信息，完成整个gRPC服务构建流程。

如何用Golang构建gRPC服务定义proto文件与生成代码

要用Golang构建gRPC服务，第一步是定义接口和消息结构，这通过Protocol Buffers（简称protobuf）完成。整个流程包括：编写.proto文件、使用protoc生成Go代码、编写服务端和客户端逻辑。下面一步步说明如何操作。

定义proto文件

在项目目录中创建一个proto文件夹，然后编写一个service.proto文件。例如，定义一个简单的用户信息服务：

syntax = "proto3"; package user; // 生成的Go包名 option go_package = "./userpb"; // 请求消息 message GetUserRequest { int32 id = 1; } // 响应消息 message User { int32 id = 1; string name = 2; string email = 3; } // 定义gRPC服务 service UserService { rpc GetUser(GetUserRequest) returns (User); }

说明：

syntax = "proto3"：使用proto3语法。
package user：避免命名冲突，对应生成代码的包名。
option go_package：指定生成的Go代码的导入路径。
service UserService：定义一个gRPC服务，包含一个方法GetUser。

安装工具与生成Go代码

要生成Go代码，需要安装以下工具：

protoc编译器：Protocol Buffers的编译器。
Go插件：protoc-gen-go 和 protoc-gen-go-grpc。

安装Go相关插件：

go install google.golang.org/protobuf/cmd/protoc-gen-go@latest go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

确保$GOPATH/bin在PATH中，否则protoc找不到插件。

在proto目录下执行命令生成代码：

protoc --go_out=. --go-grpc_out=. service.proto

生成两个文件：

service.pb.go：包含消息结构的Go类型和序列化方法。
service_grpc.pb.go：包含客户端和服务端接口。

编写gRPC服务端

创建server/main.go，实现UserService服务：

package main import ( "context" "log" "net" pb "your-module/proto/userpb" "google.golang.org/grpc" ) type server struct { pb.UnimplementedUserServiceServer } func (s *server) GetUser(ctx context.Context, req *pb.GetUserRequest) (*pb.User, error) { // 模拟查询用户 return &pb.User{ Id: req.Id, Name: "Alice", Email: "alice@example.com", }, nil } func main() { lis, err := net.Listen("tcp", ":50051") if err != nil { log.Fatalf("failed to listen: %v", err) } s := grpc.NewServer() pb.RegisterUserServiceServer(s, &server{}) log.Println("gRPC server running on :50051") if err := s.Serve(lis); err != nil { log.Fatalf("failed to serve: %v", err) } }

编写gRPC客户端

创建client/main.go，调用远程服务：

package main import ( "context" "log" "time" pb "your-module/proto/userpb" "google.golang.org/grpc" "google.golang.org/grpc/credentials/insecure" ) func main() { conn, err := grpc.Dial("localhost:50051", grpc.WithTransportCredentials(insecure.NewCredentials())) if err != nil { log.Fatalf("did not connect: %v", err) } defer conn.Close() client := pb.NewUserServiceClient(conn) ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() resp, err := client.GetUser(ctx, &pb.GetUserRequest{Id: 1}) if err != nil { log.Fatalf("could not get user: %v", err) } log.Printf("User: %v", resp) }

运行服务端后，执行客户端，将输出获取到的用户信息。

基本上就这些。定义proto、生成代码、实现服务和调用，是gRPC开发的核心流程。只要proto文件清晰，后续代码生成和调用都很自动化。注意保持proto与Go包路径一致，避免导入问题。

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于Golang的相关知识，也可关注golang学习网公众号。