golang 学习之grpc+ protobuf

Posted 2022-09-08 柳清风09

##rpc
rpc（远程过程调用）是现在微服务中服务之间调用的通用技术，整个Openstack里面组件内部的相互调用也是通过rpc+rabbitmq完成的，也有很多开源的rpc调用框架如dubbo、Zeroc Ice、thrift等。thrift是为了解决facebook系统中各系统间大数据量的传 输通信以及系统之间语言环境不同需要跨平台的特性。所以thrift可以支持多种程序语言；通过Zeroc Ice企业可以轻松构建SOA；Avro是Hadoop的一个子项目，实现hadoop平台内部组件调用。现在说到本次讲解的主角gRPC。
##grpc
gRPC是一个高性能、通用的开源RPC框架，使用HTTP/2协议并用ProtoBuf作为序列化工具。
##protobuf
protobuf也是google开源的，是一个支持多语言的序列化工具，不同语言使用范例：

protoc --proto_path=IMPORT_PATH --cpp_out=DST_DIR --java_out=DST_DIR --python_out=DST_DIR --go_out=DST_DIR --ruby_out=DST_DIR --javanano_out=DST_DIR --objc_out=DST_DIR --csharp_out=DST_DIR path/to/file.proto

从命令可以看出支持Java、Python、Go等通用语言。
先定义一个proto文件，它定义了服务接口以及请求和返回参数，如下：

syntax = "proto3";

option java_multiple_files = true;
option java_package = "io.grpc.examples.helloworld";
option java_outer_classname = "HelloWorldProto";

package helloworld;

// The greeting service definition.
service Greeter 
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) 


// The request message containing the user's name.
message HelloRequest 
  string name = 1;


// The response message containing the greetings
message HelloReply 
  string message = 1;

文件很简单，定义了一个接口service，里面有个方法SayHello，这个方法有一个请求参数HelloRequest和一个返回参数HelloReply。
有了这个文件以后就可以通过protoc命令去生成服务端和客户端使用的grpc代码

 protoc --go_out=plugins=grpc:. *.proto

这里有两点需要注意：
1、在生成代码之前要先安装go get -u github.com/golang/protobuf/proto,protoc-gen-go 并且把GOPATH/bin目录下的protoc-gen-go放到环境变量PATH里面去，否则会报
protoc-gen-go: program not found or is not executable
这个错误。
2、使用的是grpc插件如果多个插件可以叠加，plugins=plugin1+plugin2，如果这里不使用这个参加会生成标准的pb.go文件，但里面不包含RegisterGreeterServer()这个注册服务的方法。
那么现在先编写服务端代码：

package main

import (
	"log"
	"net"

	"golang.org/x/net/context"
	"google.golang.org/grpc"
	pb "google.golang.org/grpc/examples/helloworld/helloworld"
	"google.golang.org/grpc/reflection"
)

const (
	port = ":50051"
)

// server is used to implement helloworld.GreeterServer.
type server struct

// SayHello implements helloworld.GreeterServer
func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) 
	return &pb.HelloReplyMessage: "Hello " + in.Name, nil


func main() 
	lis, err := net.Listen("tcp", port)
	if err != nil 
		log.Fatalf("failed to listen: %v", err)
	
	s := grpc.NewServer()
	pb.RegisterGreeterServer(s, &server)
	// Register reflection service on gRPC server.
	reflection.Register(s)
	if err := s.Serve(lis); err != nil 
		log.Fatalf("failed to serve: %v", err)
	

服务端先启动本地监听，然后将包含SayHello方法的server注册到服务里面。再看看客户端代码：

package main

import (
	"log"
	"os"

	"golang.org/x/net/context"
	"google.golang.org/grpc"
	pb "google.golang.org/grpc/examples/helloworld/helloworld"
)

const (
	address     = "localhost:50051"
	defaultName = "world"
)

func main() 
	// Set up a connection to the server.
	conn, err := grpc.Dial(address, grpc.WithInsecure())
	if err != nil 
		log.Fatalf("did not connect: %v", err)
	
	defer conn.Close()
	c := pb.NewGreeterClient(conn)

	// Contact the server and print out its response.
	name := defaultName
	if len(os.Args) > 1 
		name = os.Args[1]
	
	r, err := c.SayHello(context.Background(), &pb.HelloRequestName: name)
	if err != nil 
		log.Fatalf("could not greet: %v", err)
	
	log.Printf("Greeting: %s", r.Message)

客户端先是亲戚服务端建立连接，然后调用SayHello这个方法。
先启动服务端，然后再启动客户端。输出的结果如下：
2017/04/11 19:21:05 Greeting: Hello world
如果有使用Java dubbo开发经验的可能对此很容了解，只不过dubbo里是通过zk去注册服务的如下图：
服务的提供者把自己注册的zk，服务调用者（消费者）通过服务注册中心（zk）去获取服务提供者地址，当然还有心跳监测、缓存服务等很多有意思的设计，后面再介绍！