GolanggRPC代码生成实战教程
时间:2026-01-23 12:59:35 452浏览 收藏
大家好,我们又见面了啊~本文《Golang gRPC生成客户端服务端代码实践》的内容中将会涉及到等等。如果你正在学习Golang相关知识,欢迎关注我,以后会给大家带来更多Golang相关文章,希望我们能一起进步!下面就开始本文的正式内容~
首先安装protoc编译器及Go插件,然后编写helloworld.proto定义服务接口和消息类型,接着运行protoc命令生成helloworld.pb.go和helloworld_grpc.pb.go两个文件,最后在Go代码中实现服务端GreeterServer接口和客户端调用逻辑,启动服务并通信。

在Go语言中使用gRPC进行服务通信,需要通过Protocol Buffers(简称protobuf)定义接口和服务结构,再利用protoc编译器和插件生成客户端与服务端的Go代码。下面详细介绍从定义proto文件到生成gRPC代码的完整流程。
1. 安装必要的工具和依赖
要生成gRPC代码,必须先安装以下组件:
- protoc编译器:用于解析.proto文件并生成基础代码。
- Go插件:
protoc-gen-go和protoc-gen-go-grpc,分别用于生成Go结构体和gRPC服务代码。
执行以下命令安装Go相关插件:
go install google.golang.org/protobuf/cmd/protoc-gen-go@latestgo install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
确保$GOPATH/bin已加入系统PATH,否则protoc无法找到这些插件。
2. 编写.proto文件定义服务
创建一个helloworld.proto文件,定义简单的问候服务:
option go_package = "./;pb";
package helloworld;
// 定义服务
service Greeter {
rpc SayHello (HelloRequest) returns (HelloReply);
}
// 请求消息
message HelloRequest {
string name = 1;
}
// 响应消息
message HelloReply {
string message = 1;
}
go_package指定生成代码的包路径和包名,这里设为当前目录,包名为pb。
3. 使用protoc生成Go代码
在.proto文件所在目录运行以下命令:
protoc --go_out=. --go_opt=paths=source_relative \--go-grpc_out=. --go-grpc_opt=paths=source_relative \
helloworld.proto
执行后会生成两个文件:
helloworld.pb.go:包含消息类型的Go结构体和序列化方法。helloworld_grpc.pb.go:包含客户端接口和服务端抽象接口。
生成的代码中,服务端需实现GreeterServer接口,客户端可直接调用GreeterClient接口。
4. 实现服务端与客户端逻辑
服务端示例:
package mainimport (
"context"
"log"
"net"
"google.golang.org/grpc"
pb "your-module/pb"
)
type server struct {
pb.UnimplementedGreeterServer
}
func (s *server) SayHello(ctx context.Context, req *pb.HelloRequest) (*pb.HelloReply, error) {
return &pb.HelloReply{Message: "Hello " + req.Name}, nil
}
func main() {
lis, err := net.Listen("tcp", ":50051")
if err != nil {
log.Fatalf("failed to listen: %v", err)
}
s := grpc.NewServer()
pb.RegisterGreeterServer(s, &server{})
log.Println("gRPC server running on :50051")
s.Serve(lis)
}
客户端示例:
package mainimport (
"context"
"log"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
pb "your-module/pb"
)
func main() {
conn, err := grpc.Dial("localhost:50051", grpc.WithTransportCredentials(insecure.NewCredentials()))
if err != nil {
log.Fatal(err)
}
defer conn.Close()
client := pb.NewGreeterClient(conn)
resp, err := client.SayHello(context.Background(), &pb.HelloRequest{Name: "Alice"})
if err != nil {
log.Fatal(err)
}
log.Println(resp.Message)
}
运行服务端后,执行客户端即可看到输出:Hello Alice。
基本上就这些。只要定义好proto文件,gRPC能自动生成高效、类型安全的通信代码,极大简化远程调用开发。注意保持proto与生成代码同步,并合理组织模块路径。
今天关于《GolanggRPC代码生成实战教程》的内容介绍就到此结束,如果有什么疑问或者建议,可以在golang学习网公众号下多多回复交流;文中若有不正之处,也希望回复留言以告知!
-
505 收藏
-
503 收藏
-
502 收藏
-
502 收藏
-
502 收藏
-
485 收藏
-
453 收藏
-
303 收藏
-
489 收藏
-
366 收藏
-
231 收藏
-
222 收藏
-
227 收藏
-
214 收藏
-
402 收藏
-
168 收藏
-
154 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习