• 十分钟学会Golang开发gRPC服务


    gRPC是Google发起的一个开源RPC框架,使用HTTP/2传输协议,使用Protocol Buffers编码协议,相比RESTful框架的程序性能提高不少,而且当前流行的编程语言基本都已经支持。

    Golang开发gRPC应用程序的套路也已经很清晰,这篇文章就来做一个简单的介绍,算是入门。

    1、安装protoc

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

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

    img

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

    img

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

    2、安装protoc的Golang gRPC插件

    执行如下命令,会在 GOPATH 的 bin 目录下生成两个可执行文件: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/blob/master/Documentation/server-reflection-tutorial.md

    如果直接粘贴这段代码的话,会有很多包没有引用进来,可以通过 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,然后再双击运行。实际运行效果如下:

    img


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

    完整代码示例已经上传到Github:https://github.com/bosima/go-demo/tree/main/grpc-hello

  • 相关阅读:
    bootstrap里的下拉菜单
    bootstrap里的图标
    bootstrap
    maven和svn区别
    maven
    计算机程序的思维逻辑 (20)
    计算机程序的思维逻辑 (19)
    计算机程序的思维逻辑 (18)
    计算机程序的思维逻辑 (17)
    计算机程序的思维逻辑 (15)
  • 原文地址:https://www.cnblogs.com/xyou/p/16169885.html
Copyright © 2020-2023  润新知