grpc-go使用记录

本文作于2022.02.10，请注意版本

0x00 服务端

0.服务端文件结构

├── go.mod
├── go.sum
├── main.go
└── protos
    ├── chat
    │   ├── chat.go
    │   ├── chat_grpc.pb.go
    │   └── chat.pb.go
    └── chat.proto

2 directories, 7 files

1.安装proto生成指定语言代码的exe

• 下载地址，此次使用的是protoc-3.19.4-linux-x86_64.zip
• 下载完毕后进行解压，并将解压出的bin文件夹设置到环境变量中，以在后续操作在命令行可以使用proto指令
• 安装go需要的生成grpc文件的包:
  go get github.com/golang/protobuf/protoc-gen-go
  此包需要在gopath下可以找到，否则在proto文件生成go代码时会报错:
  protoc-gen-go: program not found or is not executable

2.编写proto文件

syntax="proto3";// 指定proto语法版本
package chat;//指定proto包名
option go_package="./chat;chat";// 若没有此项会报错,格式为<生成的文件存放位置;生成文件的go package包名>
message Message{ //message标签指定参数格式
  string body=1; //格式:<类型 参数名=唯一编码> 唯一编码的含义参见官方文档
}
message AddParams{
  int32 firstNum=1;
  int32 secondNum=2;
}
message AddRes{
  int32 addRet=1;
}
service ChatService{ //定义服务名及其方法
  rpc SayHello(Message) returns (Message){} //这个函数将在服务端把客户端调用时传入的string参数打印出来
  rpc DoAdd(AddParams) returns (AddRes){} //这个函数将把客户端传入的数字加起来
}

3.执行proto.exe生成go文件

protoc --go_out=. --go-grpc_out=. chat.proto

生成完后会在本文件夹下(因为–go_out和–go-grpc_out指定的都是本文件夹)创建一个chat目录(因为在go_package中配置的是./chat;)，其下放着生成的chat.pb.go和chat_grpc.pb.go

4.编写proto文件中的函数细节

package chat

import (
	"golang.org/x/net/context"
	"log"
)
type Server struct {
}

func (s *Server) SayHello(ctx context.Context, message *Message) (*Message, error) {
	log.Printf("Receive message body from client: %s", message.Body)
	return &Message{Body: "Hello From the Server!"}, nil
}

func (s *Server) DoAdd(ctx context.Context, params *AddParams) (*AddRes, error) {
	log.Printf("Add nums: <%d> and <%d>", params.FirstNum,params.SecondNum)
	return &AddRes{AddRet: params.FirstNum+params.SecondNum},nil
}

//注意要在现版本中的grpc包(1.44.0)使用Register*ServiceServer方法,其第二个参数要求的interface必须有此方法
func (s *Server) mustEmbedUnimplementedChatServiceServer() {
	panic("implement me")
}

注意mustEmbedUnimplementedChatServiceServer函数，源码中说其是为了向前兼容

5.编写service的main方法

package main

import (
	"fmt"
	"google.golang.org/grpc"
	"gstudy/protos/chat" // 这里我在go mod init时起的名字叫gstudy，其实这个chat就是刚才生成proto的go文件的chat包
	"log"
	"net"
)

func main()  {
	lis, err := net.Listen("tcp", fmt.Sprintf(":%d", 9000))
	if err != nil {
		log.Fatalf("failed to listen: %v", err)
	}
	s := chat.Server{}
	grpcServer := grpc.NewServer()
	chat.RegisterChatServiceServer(grpcServer, &s)

	if err := grpcServer.Serve(lis); err != nil {
		log.Fatalf("failed to serve: %s", err)
	}
}

6.运行服务端

0x01 客户端

0.客户端项目结构

├── go.mod
├── go.sum
├── main.go
└── protos
    └── chat
        ├── chat.go
        ├── chat_grpc.pb.go
        └── chat.pb.go

2 directories, 6 files

1.proto文件

由于服务端已经将服务的方法都定义好了，并且客户端调用时我也用的go做的调用，所以直接将生成好的文件复制过来即可。如果是别的语言需要根据服务端的proto文件重新生成对应的文件

2.编写客户端main方法

package main

import (
	"gcli/protos/chat"
	"golang.org/x/net/context"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials/insecure"
	"log"
)

func main() {

	var conn *grpc.ClientConn
	conn, err := grpc.Dial(":9000", grpc.WithTransportCredentials(insecure.NewCredentials()))
	if err != nil {
		log.Fatalf("did not connect: %s", err)
	}
	defer conn.Close()

	c := chat.NewChatServiceClient(conn)

	response, err := c.SayHello(context.Background(), &chat.Message{Body: "我说Hello你听得到吗"})
	if err != nil {
		log.Fatalf("Error when calling SayHello: %s", err)
	}
	log.Printf("Response from server: %s", response.Body)
	var (
		firstNum int32  = 1
		secondNum int32  = 2
	)
	added,err:=c.DoAdd(context.Background(), &chat.AddParams{FirstNum: firstNum, SecondNum: secondNum})
	if err!=nil{
		log.Fatalf("Error when calling DoAdd: %s", err)
	}
	log.Printf("%d add %d equals %d",firstNum,secondNum,added.AddRet)
}

运行客户端程序

服务端打印

2022/02/10 14:29:16 Receive message body from client: 我说Hello你听得到吗
2022/02/10 14:29:16 Add nums: <1> and <2>

客户端打印

2022/02/10 14:29:16 Response from server: Hello From the Server!
2022/02/10 14:29:16 1 add 2 equals 3

即成功