Golang 语言编写 gRPC 实战项目

简介: Golang 语言编写 gRPC 实战项目

介绍

在之前的几篇文章中,我们介绍了 protobuf 和 grpc,本文我们介绍怎么使用 grpc 开发“分布式系统”。这里使用引号是因为分布式系统是一个大概念,本文我们先介绍使用 grpc 开发分布式系统中的 service。

grpc 是 google 开源的 rpc 框架,使用 grpc 可以方便开发 rpc service;protobuf 是一种接口设计语言(IDL),grpc 框架使用的 IDL 是 protobuf。如果有读者朋友还不了解 protobuf 和 grpc,建议先翻阅之前的几篇文章。

本文是介绍使用 grpc 开发一个实战项目 - ToDoList,目标是帮助读者朋友们熟悉项目开发流程,该实战项目包含 server service 和 client service。server 主要负责数据操作,client 主要负责业务逻辑处理。

server

首先,我们创建 proto 目录,并创建 proto 文件,编写 protobuf,设计项目的 service,接着创建 pb 目录,使用 protoc 编译我们编写好的 proto 文件,生成 pb 文件。然后,我们创建 service 目录,编写生成的 pb 文件中接口定义的方法。最后,我们创建 grpc 服务器。

server 目录

.
├── dao
│   ├── mysql.go
│   └── toDoList.go
├── main.go
├── pb
│   ├── todoPb
│   │   ├── toDoList.pb.go
│   │   └── toDoList_grpc.pb.go
│   └── userPb
│       ├── user.pb.go
│       └── user_grpc.pb.go
├── proto
│   ├── toDoList.proto
│   └── user.proto
└── service
    └── toDoList.go

编写 proto 文件

读者朋友们如果还不熟悉 protobuf,建议翻阅之前介绍 protobuf 的文章,限于篇幅,本文不再赘述。示例代码如下:

syntax = "proto3";
option go_package = "./todoPb";
service ToDoList {
  rpc CreateToDoList (ToDoListDetail) returns (CreateToDoListResult) {}
  rpc ReadToDoList (ToDoListPage) returns (ReadToDoListByPage) {}
}
message ToDoListDetail {
  // @inject_tag: form:"id" xorm:"'id' not null pk autoincr"
  int64 id = 1;
...

完整代码,请查阅 github。

生成 pb 文件

接着,我们使用 protoc 编译 proto 文件,生成 pb 文件,关于怎么使用 protoc 编译 proto 文件,在之前的文章已经详细介绍,限于篇幅,本文不再赘述,编译命令如下:

protoc --go_out=./pb --go-grpc_out=./pb proto/* && protoc-go-inject-tag -XXX_skip=xorm -input=./pb/todoPb/toDoList.pb.go

执行以上命令,将在 pb 目录中自动生成 pb 文件。

编写接口定义的方法

至此,我们开始编写 golang 代码,在 service 目录中创建 go 文件,实现生成的 pb 文件中接口定义的方法。

...
type ToDoList struct {
 pb.UnimplementedToDoListServer
}
func (t *ToDoList) CreateToDoList(ctx context.Context, in *pb.ToDoListDetail) (*pb.CreateToDoListResult, error) {
 log.Printf("id: %d content:%v datetime:%d\n", in.GetId(), in.GetContent(), in.GetDatetime())
 record, err := dao.Add(ctx, in)
 data := &pb.CreateToDoListResult{Record: record}
 return data, err
}
...

阅读上面这段代码,可以发现我们把数据库操作相关代码设计在 dao 包中。service 中通过调用 dao 包的方法操作数据库,另外,其他数据操作组件也可以在 service 中调用。

完整代码,请查阅 github。

创建 gRPC 服务器

在完成 service 代码编写之后,我们创建 grpc server,然后注册服务。

...
server := grpc.NewServer()
 pb.RegisterToDoListServer(server, new(service.ToDoList))
...

完整代码,请查阅 github。

以上就是使用 grpc 创建 rpc service 的一般流程,在生产环境项目中,还需要完善一些公共方法,比如配置文件读取、错误码定义、参数验证等。为了读者朋友们容易理解,该实战项目中未涉及这部分内容,感兴趣的读者朋友们可以尝试自己实现该部分内容。

03

client

client 主要负责业务逻辑,本文介绍的实战项目使用 gin 框架实现路由。通常,client service 的 pb 文件拷贝 server service 生成的 pb 文件。

首先,我们创建 controller 目录,调用 server service 的方法,然后,使用 gin 框架设计路由。

client 目录

.
├── controller
│   └── toDoList.go
├── main.go
├── pb
│   ├── todoPb
│   │   ├── toDoList.pb.go
│   │   └── toDoList_grpc.pb.go
│   └── userPb
│       ├── user.pb.go
│       └── user_grpc.pb.go
└── router
    └── router.go

拷贝 server service 生成的 pb 文件

client 直接拷贝 server service 生成的 pb 文件,不需要编写 proto 文件,然后使用 protoc 编译 proto 文件,生成 pb 文件。

编写 controller 代码,调用 server service 的方法

在 controller 目录中创建 go 文件,编写 controller 方法,并创建客户端,使用创建的客户端调用 server service 的方法。

func CreateToDoList(ctx *gin.Context) {
...
cc := NewToDoListClient()
 defer func() {
  err := cc.Close()
  if err != nil {
   log.Fatalf("conn close error=%v", err)
  }
 }()
 cli := pb.NewToDoListClient(cc)
 ctx1, cancel := context.WithTimeout(context.Background(), time.Second)
 defer cancel()
 res, err := cli.CreateToDoList(ctx1, param)
...

完整代码,请查阅 github。

创建 gin 路由

编写完 controller 之后,创建 router 目录,在 router 目录中创建 gin 路由,用于访问 controller 中的方法。

...
r := gin.Default()
 apiV1 := r.Group("/v1")
 todolist := apiV1.Group("/todolist")
 {
  todolist.POST("/add", controller.CreateToDoList)
...

完整代码,请查阅 github。

04

总结

本文我们介绍了怎么使用 grpc 开发 service。读者朋友们阅读完本文,可以了解使用 grpc 开发 service 的一般开发流程,建议感兴趣的读者朋友们,实现项目中 user service 的代码编写。

推荐阅读:

Golang 语言怎么处理错误?

参考资料:

https://developers.google.com/protocol-buffers/docs/proto3 

https://grpc.io/docs/languages/go/quickstart/ 

https://gin-gonic.com/ 

https://gobook.io/read/gitea.com/xorm/manual-zh-CN/ 

目录
相关文章
|
3天前
|
安全 Go
Golang深入浅出之-Go语言模板(text/template):动态生成HTML
【4月更文挑战第24天】Go语言标准库中的`text/template`包用于动态生成HTML和文本,但不熟悉其用法可能导致错误。本文探讨了三个常见问题:1) 忽视模板执行错误,应确保正确处理错误;2) 忽视模板安全,应使用`html/template`包防止XSS攻击;3) 模板结构不合理,应合理组织模板以提高可维护性。理解并运用这些最佳实践,能提升Go语言模板编程的效率和安全性,助力构建稳健的Web应用。
15 0
|
14小时前
|
安全 测试技术 Go
Golang深入浅出之-Go语言单元测试与基准测试:testing包详解
【4月更文挑战第27天】Go语言的`testing`包是单元测试和基准测试的核心,简化了测试流程并鼓励编写高质量测试代码。本文介绍了测试文件命名规范、常用断言方法,以及如何进行基准测试。同时,讨论了测试中常见的问题,如状态干扰、并发同步、依赖外部服务和测试覆盖率低,并提出了相应的避免策略,包括使用`t.Cleanup`、`t.Parallel()`、模拟对象和检查覆盖率。良好的测试实践能提升代码质量和项目稳定性。
6 1
|
14小时前
|
运维 监控 Go
Golang深入浅出之-Go语言中的日志记录:log与logrus库
【4月更文挑战第27天】本文比较了Go语言中标准库`log`与第三方库`logrus`的日志功能。`log`简单但不支持日志级别配置和多样化格式,而`logrus`提供更丰富的功能,如日志级别控制、自定义格式和钩子。文章指出了使用`logrus`时可能遇到的问题,如全局logger滥用、日志级别设置不当和过度依赖字段,并给出了避免错误的建议,强调理解日志级别、合理利用结构化日志、模块化日志管理和定期审查日志配置的重要性。通过这些实践,开发者能提高应用监控和故障排查能力。
8 1
|
14小时前
|
安全 Go
Golang深入浅出之-Go语言标准库中的文件读写:io/ioutil包
【4月更文挑战第27天】Go语言的`io/ioutil`包提供简单文件读写,适合小文件操作。本文聚焦`ReadFile`和`WriteFile`函数,讨论错误处理、文件权限、大文件处理和编码问题。避免错误的关键在于检查错误、设置合适权限、采用流式读写及处理编码。遵循这些最佳实践能提升代码稳定性。
5 0
|
1天前
|
安全 Unix Go
Golang深入浅出之-Go语言中的时间与日期处理:time包详解
【4月更文挑战第26天】Go语言的`time`包提供处理日期和时间的功能,包括`time.Time`类型、时间戳、格式化与解析。本文讨论了核心概念、常见问题(如时区处理、格式字符串混淆、超时控制和并发安全)及解决方法。推荐使用`time.LoadLocation`管理时区,熟悉时间格式规则,用`context`精确控制超时,并注意并发安全。文中通过代码示例展示了如何获取格式化时间、计算时间差以及创建定时任务。学习和应用这些知识可提高程序的健壮性和准确性。
15 2
|
1天前
|
XML JSON Go
Golang深入浅出之-XML处理在Go语言中的实现:encoding/xml包
【4月更文挑战第26天】Go语言的`encoding/xml`库提供XML处理,包括序列化和反序列化。本文讨论了XML处理的基础,如`xml.Marshal`和`xml.Unmarshal`函数,以及常见问题和易错点,如标签命名、结构体嵌套、omitempty标签和命名空间。建议遵循标签命名规则,正确处理嵌套和属性,谨慎使用omitempty,以及理解并有效利用命名空间。文中还给出了基础示例和处理XML属性的代码示例,帮助读者掌握XML处理技巧。
12 1
Golang深入浅出之-XML处理在Go语言中的实现:encoding/xml包
|
1天前
|
JSON JavaScript 前端开发
Golang深入浅出之-Go语言JSON处理:编码与解码实战
【4月更文挑战第26天】本文探讨了Go语言中处理JSON的常见问题及解决策略。通过`json.Marshal`和`json.Unmarshal`进行编码和解码,同时指出结构体标签、时间处理、omitempty使用及数组/切片区别等易错点。建议正确使用结构体标签,自定义处理`time.Time`,明智选择omitempty,并理解数组与切片差异。文中提供基础示例及时间类型处理的实战代码,帮助读者掌握JSON操作。
12 1
Golang深入浅出之-Go语言JSON处理:编码与解码实战
|
1天前
|
安全 Go 开发者
Golang深入浅出之-Go语言模板(text/template):动态生成HTML
【4月更文挑战第25天】Go语言的`text/template`和`html/template`库提供动态HTML生成。本文介绍了模板基础,如基本语法和数据绑定,以及常见问题和易错点,如忘记转义、未初始化变量、复杂逻辑处理和错误处理。建议使用`html/template`防止XSS攻击,初始化数据结构,分离业务逻辑,并严谨处理错误。示例展示了条件判断和循环结构。通过遵循最佳实践,开发者能更安全、高效地生成HTML。
7 0
|
2天前
|
中间件 Go API
Golang深入浅出之-Go语言标准库net/http:构建Web服务器
【4月更文挑战第25天】Go语言的`net/http`包是构建高性能Web服务器的核心,提供创建服务器和发起请求的功能。本文讨论了使用中的常见问题和解决方案,包括:使用第三方路由库改进路由设计、引入中间件处理通用逻辑、设置合适的超时和连接管理以防止资源泄露。通过基础服务器和中间件的代码示例,展示了如何有效运用`net/http`包。掌握这些最佳实践,有助于开发出高效、易维护的Web服务。
15 1
|
2天前
|
数据管理 Go 开发者
Golang深入浅出之-Go语言上下文(context)包:处理取消与超时
【4月更文挑战第25天】Go语言中的`context`包在并发、网络请求和长任务中至关重要,提供取消、截止时间和元数据管理。本文探讨`context`基础,如`Background()`、`TODO()`、`WithCancel()`、`WithDeadline()`和`WithTimeout()`。常见问题包括不当传递、过度使用`Background()`和`TODO()`以及忽略错误处理。通过取消和超时示例,强调正确传递上下文、处理取消错误和设置超时以提高应用健壮性和响应性。正确使用`context`是构建稳定高效Go应用的关键。
12 1