关于golang:十分钟学会Golang开发gRPC服务

46次阅读

共计 3618 个字符,预计需要花费 10 分钟才能阅读完成。

gRPC 是 Google 发动的一个开源 RPC 框架,应用 HTTP/ 2 传输协定,应用 Protocol Buffers 编码协定,相比 RESTful 框架的程序性能进步不少,而且以后风行的编程语言根本都曾经反对。

Golang 开发 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 的 Golang gRPC 插件

执行如下命令,会在 GOPATHbin 目录下生成两个可执行文件:protoc-gen-go.exe 和 protoc-gen-go-grpc.exe。这两个插件能够用来生成 Golang 版本的 proto 协定代码和 gRPC 代理代码。

go install google.golang.org/protobuf/cmd/protoc-gen-go
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc

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_grpc.pb.go。

protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative proto/hello.proto

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

也能够将文件生成到别的目录中,比方批改 proto 文件中 go_package 的配置为:

option go_package="/business";

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

protoc --go_out=.  --go-grpc_out=. proto/hello.proto

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

5、编写 gRPC 服务端程序

这里先上代码:

package main

import (
    "context"
    "fmt"
    "grpcdemo/proto"
    "net"

    "google.golang.org/grpc"
)

type server struct {proto.UnimplementedHelloServer}

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

func main() {listen, err := net.Listen("tcp", ":8001")
    if err != nil {fmt.Printf("failed to listen: %v", err)
        return
    }
    s := grpc.NewServer()
    proto.RegisterHelloServer(s, &server{})
    //reflection.Register(s)

    defer func() {s.Stop()
        listen.Close()}()

    fmt.Println("Serving 8001...")
    err = s.Serve(listen)
    if err != nil {fmt.Printf("failed to serve: %v", err)
        return
    }
}

整个过程如下:先定义一个名为 server 的类型,它去实现 hello_grpc.pb.go 中生成的 HelloServer 接口;而后通过 grpc.NewServer 创立一个 gRPC 服务器;而后将 server 类型的实例注册到这个 gRPC 服务器;最初让这个 gRPC 服务器在某个本地网络端口监听上开始承受客户端申请。

代码中正文了一行:reflection.Register(s) 它是注册了一个非凡的 service,能让内部取得 server 中已注册的服务和办法。这对于开发时可能比拟有用,具体细节能够看这里:https://github.com/grpc/grpc-…

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

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

6、编写 gRPC 客户端程序

拜访 gRPC 服务也是通过 hello_grpc.pb.go 中生成的办法,间接上代码:

package main

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

    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials/insecure"
)

func main() {

    var serviceHost = "127.0.0.1:8001"

    conn, err := grpc.Dial(serviceHost, grpc.WithTransportCredentials(insecure.NewCredentials()))
    if err != nil {fmt.Println(err)
    }
    defer conn.Close()

    client := proto.NewHelloClient(conn)
    rsp, err := client.Say(context.TODO(), &proto.SayRequest{Name: "BOSIMA",})

    if err != nil {fmt.Println(err)
    }

    fmt.Println(rsp)

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

上边服务端程序的监听端口指定的 8001,所以这里先创立了一个到 127.0.0.1:8001 的连贯;而后应用这个连贯创立指定服务的客户端 proto.NewHelloClient(conn);而后应用这个客户端调用相应的办法。

hello_grpc.pb.go 曾经生成了创立客户端的函数以及调用办法的函数,开发人员间接调用就好了。

7、运行程序

能够应用 go run xxx.go 来编译并运行程序。这里为了不便测试,先应用 go build 将它们编译为 exe,而后再双击运行。理论运行成果如下:


以上就是本文的次要内容了,protoc-gen-go 和 protoc-gen-go-grpc 这两个插件都是 gPRC 官网提供的,官网也提供了其它多种语言的代理生成插件,其它框架或者语言开发的 gRPC 程序,只有合乎 gRPC 标准,就能实现相互之间的相互拜访。

残缺代码示例曾经上传到 Github:https://github.com/bosima/go-…

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

正文完
 0