bossma

go-micro是golang的一个微服务框架。

go-micro各个版本之间的兼容性问题一直被诟病,前几年go-micro更是分化出了两个分支:

一个延续了go-micro,只不过转到了其公司CEO的个人Github仓库中,访问地址:

asim/go-micro: A Go microservices framework (github.com)

一个转向了云原生方向,名字叫Micro,访问地址:

micro/micro: API first cloud platform (github.com)

不过都还是开源的,当前的许可证都是Apache 2.0,不是某些人说的不能商用了,当然无法保证以后不会改许可证。


回到正文,这篇文章将介绍使用go-micro最新版本v4开发gRPC服务的方式。

1、安装protoc

这个工具也称为proto编译器,可以用来生成各种开发语言使用proto协议的代码。

下载地址:https://github.com/protocolbuffers/protobuf/releases

一般下载最新版本就行,注意要符合自己当前的操作系统。

img

解压后里边有个 protoc.exe ,拷贝到 GOPATH 的 bin 目录下,我这里就是 C:/Users/PC-001/go/bin ,PC-001 是登录当前操作系统的用户名,需要换成你自己的。GOPATH 可以通过执行 go env 查看到。

img

一般都是把 GOPATHbin 目录添加到环境变量的 PATH 变量中,如果没有,请自行添加上。

2、安装protoc的go-micro插件

需要安装两个插件,它们用来生成 Golang 版本的 proto 协议代码和 go-micro 的 gRPC 代理代码。

执行如下命令,会在 GOPATHbin 目录下生成两个可执行文件:protoc-gen-go.exeprotoc-gen-micro.exe

go install google.golang.org/protobuf/cmd/protoc-gen-go
go install go-micro.dev/v4/cmd/protoc-gen-micro@v4

3、编写proto文件

proto文件是符合Protocol Buffers语言规范的数据交换协议文件,就像以前WebService定义服务时使用的XML文件。现在一般都是用proto3了,这里创建一个名为 hello.proto 的文件,放到项目的proto目录下:

syntax = "proto3";

option go_package="/proto";

package Business;

service Hello {
  rpc Say (SayRequest) returns (SayResponse);
}

message SayResponse {
  string Message = 1;
}

message SayRequest {
  string Name = 1;
}

这个协议很简单,有个名字为Hello的服务,提供一个名字为Say的rpc方法,这个方法有输入输出,输入信息中有一个名为Name的参数,输出信息中有一个名为Message的返回值。

4、生成gRPC代理代码

在项目根目录中执行如下命令,会在proto目录下生成两个文件:hello.pb.go 和 hello.pb.micro.go。

protoc --go_out=. --go_opt=paths=source_relative --micro_out=. --micro_opt=paths=source_relative proto/hello.proto

hello.pb.go 中是输入输出数据类型的Golang定义,hello.pb.micro.go 中是go-micro客户端和服务端的gRPC代理程序。

也可以将文件生成到别的目录中,比如修改 proto 文件中 go_package 的配置为:

option go_package="/business";

然后执行下面的命令,会生成到项目下的business目录中:

protoc --go_out=.  --micro_out=. proto/hello.proto

具体这个命令还有哪些参数,可以执行 protoc -help 去探索下,这里就不罗嗦了。

5、编写gRPC服务端程序

这里先上代码:

package main

import (
	"context"
	"fmt"
	"grpchello/proto"
	"log"
	"time"

	"github.com/asim/go-micro/plugins/server/grpc/v4"
	"go-micro.dev/v4"
	"go-micro.dev/v4/server"
)

type Hello struct{}

func (s *Hello) Say(ctx context.Context, req *proto.SayRequest, rsp *proto.SayResponse) error {
	fmt.Println("request:", req.Name)
	rsp.Message = "Hello " + req.Name
	return nil
}

func main() {

	grpcServer := grpc.NewServer()

	service := micro.NewService(
		micro.Server(grpcServer),
		micro.Name("grpchello.service"),
		micro.Address("0.0.0.0:8001"),
		micro.RegisterTTL(time.Second*30),
		micro.RegisterInterval(time.Second*10),
	)

	// optionally setup command line usage
	service.Init()

	// Register Handlers
	proto.RegisterHelloHandler(service.Server(), &Hello{})

	// Run server
	if err := service.Run(); err != nil {
		log.Fatal(err)
	}
}

整个过程如下:

先定义一个名为 Hello 的类型,它去实现hello.pb.micro.go中生成的HelloHandler接口,也就是编写具体的业务实现。

然后通过grpc.NewServer创建一个gRPC服务器,这里决定go-micro底层通信使用gPRC;

然后通过micro.NewService创建一个micro服务,这里需要传入上面创建的grpc server,还要设置服务的名称、监听端口,以及保持服务健康用的TTL和上报周期。go-mico当前默认的服务发现机制是mdns,不用额外部署服务发现工具,不过一般只建议在开发环境使用,生产环境建议使用etcd;

通过上面的步骤对服务进行一些初始化之后,再将Hello类型的实例注册到grpc server;

最后启动服务,就可以开始接客了。

如果直接粘贴这段代码的话,会有很多包没有引用进来,可以通过 go get 获取这些包,也可以执行命令:go mod tidy 来引入需要的包。

这里边还import了一个 grpchello/proto ,这个是我这边项目的mod是 grpchello,gRPC代理程序的package是proto,如果你的不一样,需要修改下。

6、编写gRPC客户端程序

访问gRPC服务也是通过 hello.pb.micro.go 中生成的方法,直接上代码:

package main

import (
	"bufio"
	"context"
	"fmt"
	"grpchello/proto"
	"os"

	"github.com/asim/go-micro/plugins/client/grpc/v4"
	"go-micro.dev/v4"
)

func main() {

	service := micro.NewService(
		micro.Client(grpc.NewClient()),
	)

	service.Init()
	client := proto.NewHelloService("grpchello.service", service.Client())

	rsp, err := client.Say(context.TODO(), &proto.SayRequest{Name: "BOSSMA"})
	if err != nil {
		fmt.Println(err)
	}

	fmt.Println(rsp)

	fmt.Println("按回车键退出程序...")
	in := bufio.NewReader(os.Stdin)
	_, _, _ = in.ReadLine()
}

上面的程序使用了 grpc.NewClient , 这决定了底层通信采用gRPC;然后再使用生成的代码 proto.NewHelloService 创建客户端代理,这里指定的服务名字必须是服务端注册的名字;最后使用这个客户端代理调用相应的方法。

7、运行程序

可以使用 go run xxx.go 来编译并运行程序。这里为了方便测试,先使用 go build 将它们编译为exe,然后再双击运行。实际运行效果如下:

img


以上就是本文的主要内容了,完整代码示例已经上传到 Github:https://github.com/bosima/go-demo/tree/main/go-micro-grpc-hello

收获更多架构知识,请关注微信公众号 萤火架构。原创内容,转载请注明出处。
扫描二维码关注公众号

分类:

技术点:

相关文章: