Golang 语言编写 gRPC 实战项目

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

 [[425759]]

1、介绍

在之前的几篇文章中,我们介绍了 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 主要负责业务逻辑处理。

2、server

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

server 目录

  1. ├── dao 
  2. │   ├── mysql.go 
  3. │   └── toDoList.go 
  4. ├── main.go 
  5. ├── pb 
  6. │   ├── todoPb 
  7. │   │   ├── toDoList.pb.go 
  8. │   │   └── toDoList_grpc.pb.go 
  9. │   └── userPb 
  10. │       ├── user.pb.go 
  11. │       └── user_grpc.pb.go 
  12. ├── proto 
  13. │   ├── toDoList.proto 
  14. │   └── user.proto 
  15. └── service 
  16.     └── toDoList.go 

编写 proto 文件

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

  1. syntax = "proto3"
  2.  
  3. option go_package = "./todoPb"
  4.  
  5. service ToDoList { 
  6.   rpc CreateToDoList (ToDoListDetail) returns (CreateToDoListResult) {} 
  7.   rpc ReadToDoList (ToDoListPage) returns (ReadToDoListByPage) {} 
  8.  
  9. message ToDoListDetail { 
  10.   // @inject_tag: form:"id" xorm:"'id' not null pk autoincr" 
  11.   int64 id = 1
  12.  
  13. ... 

完整代码,请查阅 github。

生成 pb 文件

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

  1. 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 文件中接口定义的方法。

  1. ... 
  2.  
  3. type ToDoList struct { 
  4.  pb.UnimplementedToDoListServer 
  5.  
  6. func (t *ToDoList) CreateToDoList(ctx context.Context, in *pb.ToDoListDetail) (*pb.CreateToDoListResult, error) { 
  7.  log.Printf("id: %d content:%v datetime:%d\n", in.GetId(), in.GetContent(), in.GetDatetime()) 
  8.  record, err := dao.Add(ctx, in) 
  9.  data := &pb.CreateToDoListResult{Record: record} 
  10.  return data, err 
  11.  
  12. ... 

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

完整代码,请查阅 github。

创建 gRPC 服务器

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

  1. ... 
  2.  
  3. server := grpc.NewServer() 
  4.  pb.RegisterToDoListServer(server, new(service.ToDoList)) 
  5.  
  6. ... 

完整代码,请查阅 github。

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

3、client

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

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

client 目录

  1. ├── controller 
  2. │   └── toDoList.go 
  3. ├── main.go 
  4. ├── pb 
  5. │   ├── todoPb 
  6. │   │   ├── toDoList.pb.go 
  7. │   │   └── toDoList_grpc.pb.go 
  8. │   └── userPb 
  9. │       ├── user.pb.go 
  10. │       └── user_grpc.pb.go 
  11. └── router 
  12.     └── router.go 

拷贝 server service 生成的 pb 文件

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

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

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

  1. func CreateToDoList(ctx *gin.Context) { 
  2.  
  3. ... 
  4.  
  5. cc := NewToDoListClient() 
  6.  defer func() { 
  7.   err := cc.Close() 
  8.   if err != nil { 
  9.    log.Fatalf("conn close error=%v", err) 
  10.   } 
  11.  }() 
  12.  cli := pb.NewToDoListClient(cc) 
  13.  ctx1, cancel := context.WithTimeout(context.Background(), time.Second) 
  14.  defer cancel() 
  15.  res, err := cli.CreateToDoList(ctx1, param) 
  16.    
  17. ... 

完整代码,请查阅 github。

创建 gin 路由

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

  1. ... 
  2.  
  3. r := gin.Default() 
  4.  apiV1 := r.Group("/v1"
  5.  todolist := apiV1.Group("/todolist"
  6.  { 
  7.   todolist.POST("/add", controller.CreateToDoList) 
  8.  
  9. ... 

完整代码,请查阅 github。

4、总结

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

 

责任编辑:张燕妮 来源: Golang语言开发栈
相关推荐

2021-09-13 05:02:49

GogRPC语言

2021-09-01 23:29:37

Golang语言gRPC

2021-10-10 23:02:49

Golang语言代码

2022-02-20 23:15:46

gRPCGolang语言

2022-04-29 11:52:02

API代码HTTP

2023-03-01 08:33:37

gRPC健康检查代码

2021-06-09 23:36:46

Golang语言版本

2021-05-28 08:58:41

Golang网卡metrics

2020-11-01 17:13:22

DotNET 5语言gRPC

2021-12-05 23:14:24

微服务GolanggRPC

2021-10-26 09:26:21

编程技能开发

2023-09-06 07:17:57

2021-06-29 23:40:19

Golang语言并发

2021-12-13 01:24:14

语言Golang panic

2018-08-01 15:10:02

GolangPython语言

2021-08-03 09:07:39

GolangGrpc服务

2021-04-28 09:02:48

Golang语言Context

2021-06-07 23:19:44

Golang语言 Defer

2020-10-22 06:59:09

GolangRust语言

2021-11-08 23:09:07

Go排序数据
点赞
收藏

51CTO技术栈公众号