
01 介绍
Go Micro 是使用一个分布式系统开发框架。Go Micro 提供了分布式系统开发的发微服务核心需求,包括 RPC 和事件驱动的使用通信。Gin 是发微服务一个用 Golang 编写的 web 框架。本文首先介绍怎么使用 go-micro 和 go-grpc 构建微服务,使用然后再介绍怎么集成 gin 和 go-micro。发微服务我们使用的使用 go-micro 版本是 v1.18.0,golang 版本是发微服务 v1.13,gin 版本是使用 v1.7.2。
02 使用 go-micro 和 go-grpc 构建微服务
在我们开始使用 go-micro 之前,发微服务我们还需要提前做一些准备工作。使用安装 protoc、发微服务protoc-gen-go 和 protoc-gen-micro,使用关于如何安装,发微服务读者朋友们可以参阅官方文档,使用我们在之前的文章中也介绍过,限于篇幅,本文不再赘述。
其实,我们可以使用 Go Micro 工具集以命令的方式快速生成模板文件,但是因为本文我们不准备介绍工具集的相关内容,网站模板所以我们使用手动创建文件的方式。
下面我们正式开始介绍如何构建服务,包括服务端服务和客户端服务。
服务端 服务端代码目录:
├── go.mod ├── go.sum ├── handler │ └── user │ └── user.go ├── main.go └── proto └── user ├── user.pb.go ├── user.pb.micro.go └── user.proto 构建服务端服务,分为以下几个步骤:
编写 protobuf 文件
第一步是编写 protobuf 文件,一般会将不同 package 的 protobuf 文件存放在单独的文件目录中。
文件路径: proto/user/user.proto
syntax = "proto3"; package user; service User { rpc Login(LoginRequest) returns (LoginResponse) { } } message LoginRequest { string email = 1; string password = 2; } message LoginResponse { string username = 1; } 阅读上面这段代码,我们在定义的 user.proto 文件中,创建了一个 rpc 服务。
生成文件
第二步是生成文件,使用命令:
protoc --proto_path=. --micro_out=. --go_out=. user.proto 执行以上命令,将会自动生成两个文件,分别是 user.pb.go 和 user.micro.go 。
阅读 user.micro.go 文件,可以发现在该文件中已经自动生成了客户端和服务端的代码。
编写 handler
第三步是编写服务端的 handler 代码。
文件路径: handler/user/user.go
type User struct{ } func (u *User) Login(ctx context.Context, req *protoUser.LoginRequest, rsp *protoUser.LoginResponse) error { if req.Email != "gopher@88.com" || req.Password != "123456" { rsp.Username = "Sorry " + req.Email return nil } rsp.Username = "Welcome " + req.Email return nil } 定义服务端服务
第四步是定义服务端服务,需要注意的是,这里使用的是亿华云 grpc。在 main.go 文件中编写如下代码:
文件路径: main.go
func main() { // 创建服务 service := grpc.NewService( micro.Name("go.micro.srv.demo"), micro.Version("v0.0.0"), micro.RegisterTTL(time.Second * 10), micro.RegisterInterval(time.Second * 5), ) // 注册处理器 err := protoUser.RegisterUserHandler(service.Server(), new(user.User)) if err !=nil { log.Fatal(err) } // 运行服务 if err = service.Run(); err != nil { log.Fatal(err) } } 完成以上 4 个步骤,我们就已经实现了服务端 rpc 服务,接下来,我们开始编写客户端代码。
客户端 客户端代码目录:
├── go.mod ├── go.sum ├── main.go ├── proto │ └── user │ ├── user.pb.go │ ├── user.pb.micro.go │ └── user.proto └── router ├── router.go └── v1 └── user.go 构建客户端服务,分为以下几个步骤:
拷贝 proto 文件和生成文件
第一步是拷贝服务端的 proto 文件和生成文件,目的是为了保证服务端和客户端的类型一致性。
定义客户端服务
第二步是定义客户端:
文件路径: router/v1/user.go
func NewUserClient() protoUser.UserService { // 创建服务 service := grpc.NewService() // 创建客户端 userClient := protoUser.NewUserService("go.micro.srv.demo", service.Client()) return userClient } rpc 调用远程服务的方法
第三步是 rpc 调用远程服务的方法:
文件路径: router/v1/user.go
client := NewUserClient() // rpc 调用远程服务的方法 resp, err := client.Login(context.TODO(), &protoUser.LoginRequest{ Email: param.Email, Password: param.Password}) if err != nil { fmt.Println(err) } 完成以上 3 步,我们就已经基本编写完客户端的代码。
03 gin 和 go-micro 集成
接下来,我们介绍如何集成 gin 和 go-micro,该部分代码也是在客户端中,共需要两个步骤。
创建路由
文件路径: router/router.go
func NewRouter() *gin.Engine { r := gin.New() userControllerV1 := new(v1.User) // 路由分组 v1 := r.Group("/v1") { v1.Use(gin.Logger(), gin.Recovery()) userV1 := v1.Group("/user") { userV1.POST("/login", userControllerV1.Login) } } return r } 启动(监听)服务
文件路径: main.go
func main() { r := router.NewRouter() server := &http.Server{ Addr: ":8080", Handler: r, ReadTimeout: time.Second * 10, WriteTimeout: time.Second * 10, MaxHeaderBytes: 1 << 20, } if err := server.ListenAndServe(); err != nil { log.Fatal(err) } } 至此,我们已经完成了集成 gin 和 go-micro,启动服务端服务和客户端服务后,我们就可以使用以下命令进行 cURL 测试:
curl --location --request POST http://127.0.0.1:8080/v1/user/login \ --header Content-Type: application/json \ --data-raw { "email": "gopher@88.com", "password": "123456" } 04 总结
本文我们主要介绍怎么使用 go-micro 和 go-grpc 构建微服务,和怎么集成 gin 和 go-micro,并没有介绍 gin 和 go-micro 的使用方法,源码库如果读者朋友们还不了解 gin 和 go-micro,建议先阅读 gin 和 go-micro 官方文档,也可以参考公众号之前推送的关于 gin 的文章。