登录
首页 >  Golang >  Go教程

Golang搭建gRPC服务详细教程

时间:2025-08-22 14:42:28 481浏览 收藏

哈喽!大家好,很高兴又见面了,我是golang学习网的一名作者,今天由我给大家带来一篇《Golang构建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-goprotoc-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/binPATH中,否则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搭建gRPC服务详细教程》的详细介绍,大家都掌握了吧!如果想要继续提升自己的能力,那么就来关注golang学习网公众号吧!

相关阅读
更多>
最新阅读
更多>
课程推荐
更多>