乐趣区

关于golang:基于知名微服务框架gomicro开发gRPC应用程序

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/protocolbu…

个别下载最新版本就行,留神要合乎本人以后的操作系统。

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

个别都是把 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,而后再双击运行。理论运行成果如下:


以上就是本文的次要内容了,残缺代码示例曾经上传到 Github:https://github.com/bosima/go-…

播种更多架构常识,请关注微信公众号 萤火架构。原创内容,转载请注明出处。

退出移动版