proto文件定义及参数说明

一、proto文件名命名规范

包名.服务名.proto

二、proto语法

• 关键字

syntax #协议类型，目前有两套协议 proto3、proto2，推荐使用proto3，必须放在proto文件的第一行
package #包名，必须第二行
service #定义这个proto文件的方法集合，类似于方法接口
message #类似于go语言的结构体，在此定义方法的接收、返回参数
returns #返回响应，结合service使用
rpc #定义方法的关键字，结合service使用

• 变量类型
• 字段序号
• 字段操作选项

optional #结合message使用，表示message字段的内容选填，可以传也可以不传
repeated #结合message使用，表示该字段接收或返回为数组

三、实例

# 创建文件 protos/server.hello.proto
syntax = "proto3";
package user ;

service HelloService {
  rpc SayHello (HelloRequest) returns (HelloResponse){}
}

message HelloRequest {

}

message HelloResponse {
  string msg = 1;
}

编译

# 需要进入到protos文件路径下执行命令，将proto文件翻译成go识别的代码
protoc --go_out=plugins=grpc:. server.hello.proto

服务端实例

# 创建文件 impl/helloServerImpl.go
package impl

import (
	"context"
	user "grpc.zozoo.net/protos"
)

type (
	HelloService struct {
	}
)

func (h *HelloService) SayHello(ctx context.Context, req *user.HelloRequest) (*user.HelloResponse, error) {

	return &user.HelloResponse{
		Msg: "你好，世界",
	}, nil
}

# 创建文件 server.go
package main

import (
	"flag"
	"fmt"
	"google.golang.org/grpc"
	user "grpc.zozoo.net/protos"
	"log"
	"net"
	"grpc.zozoo.net/impl"
)

func main()  {
	flag.Parse()
	lis, err := net.Listen("tcp", fmt.Sprintf(":%d", 9000))
	if err != nil {
		log.Fatalf("failed to listen: %v", err)
	}

	log.Println("端口监听成功：9000")

	grpcServer := grpc.NewServer()
	user.RegisterHelloServiceServer(grpcServer, &impl.HelloService{})
	grpcServer.Serve(lis)
}

客户端代码

# 创建client.go

package main

import (
	"context"
	"google.golang.org/grpc"
	user "grpc.zozoo.net/protos"
	"log"
)

func main() {
	conn, err := grpc.Dial(":9000",grpc.WithInsecure())
	if err != nil {
		log.Fatalf("failed to listen: %v", err)
	}

	//调用rpc方法
	hello := user.NewHelloServiceClient(conn)
	rsp,err := hello.SayHello(context.TODO(),&user.HelloRequest{})
	if err != nil {
		log.Fatalf("方法调用失败 err  %v", err)
	}

	log.Println(rsp.Msg)
	defer conn.Close()
}