windows下go安装并使用protobuf

go使用protobuf的过程以及可能出现的问题

  • 1. 下载proto windows版本并安装
  • 2. 安装protoc-gen-go
  • 3. proto文件转go文件报错protoc-gen-go: unable to determine go import path for "xxxx.proto"
  • 4. 生成的go文件中google.golang.org/protobuf/reflect/protoreflect依赖爆红
  • 5. 基本使用

1. 下载proto windows版本并安装

官方地址:protobuf
解压后复制bin目录下的protoc.exeGOPATH\bib目录中
windows下go安装并使用protobuf_第1张图片

2. 安装protoc-gen-go

如果使用go get -u github.com/golang/protobuf/protoc-gen-go 可能会出现如下错误:

go: module github.com/golang/protobuf is deprecated: Use the "google.golang.org/protobuf" module instead.go get: installing executables with 'go get' in module mode is deprecated. Use 'go install pkg@version' instead.For more information, see https://golang.org/doc/go-get-install-deprecation or run 'go help get' or 'go help install'.

使用下面的命令进行下载
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
安装成功后,在GOPATH\bib目录中可以看到proroc-gen-go.exe

两个全部安装成功后,查看下版本号
windows下go安装并使用protobuf_第2张图片

3. proto文件转go文件报错protoc-gen-go: unable to determine go import path for “xxxx.proto”

需要注意的是在proto文件中,记得设置option go_package属性

syntax="proto3"; //版本号
package protobuf;  //包名
option go_package ="./protobuf";

enum ClassName{   //枚举
    class1=0;  //标号 必须从 0开始
    class2=1;
    class3=2;
}

message Student{ //消息,对应于Go的结构体
  string name=1; //1:标号,唯一 即可(相当于数据库中的Id,不一定要从1 ,2的顺序依次排列。)
  int32 age=2;  //必须指定整型的范围,如int32,int64
  string address=3;
  ClassName cn=4;
}
message Students{
   repeated Student person=1;  // repeated 修饰,相当于Go中切片
   string school=2;
}

再使用protoc --go_out=. test.proto命令生成go文件
在这里插入图片描述

windows下go安装并使用protobuf_第3张图片

4. 生成的go文件中google.golang.org/protobuf/reflect/protoreflect依赖爆红

import(
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
)

GOPATH/src目录下新建google.golang.org文件夹,在该文件下使用命令:
git clone https://e.coding.net/robinqiwei/googleprotobuf.git protobuf

windows下go安装并使用protobuf_第4张图片
重新保存生成的xxx.pb.go文件,爆红消失
windows下go安装并使用protobuf_第5张图片

5. 基本使用

  • 创建一个.proto文件(用于定义某些需要传输的message格式)
  • 编译proto文件,可以使用protoc --go_out=. *.proto一次性编译当前文件夹下的多个proto文件
  • 编译完成后,protoc编译器将proto文件编译成.pb.go文件
syntax = "proto3"; // 版本信息,不指定会报错
package pb; //生成go文件的包名
option go_package ="./pb"; // 表示在当前文件夹下的pb包中
// message为关键字 用于定义一种消息类型 1234表示打包时字段封装的先后顺序
message Person {
    string name = 1;
    int32 age=2;
    repeated string email = 3; // repeated表示字段允许重复 => 类似于string[]
    repeated PhoneNumber phones = 4;
}


// enum关键字 定义一种枚举类型
enum PhoneType{
    MOBILE=0;
    HOME=1;
    WORK=2;
} 

// message也可以定义一种可以被其他消息嵌套的消息类型
message PhoneNumber{
    string number=1;
    PhoneType type = 2;
}

测试传输

  • 定义与protobuf对应的结构体
  • data, err := proto.Marshal(person 序列化编码得到结构体的二进制文件
  • err = proto.Unmarshal(data, person) 接收到的数据反序列化得到person结构体
    windows下go安装并使用protobuf_第6张图片
import (
	"fmt"
	"protobuf_test/pb"

	"google.golang.org/protobuf/proto"
)

func main() {
	person := &pb.Person{
		Name:  "Huzhen",
		Age:   27,
		Email: []string{"[email protected]", "[email protected]"},
		Phones: []*pb.PhoneNumber{
			&pb.PhoneNumber{
				Number: "18714859632",
				Type:   pb.PhoneType_MOBILE,
			},
			&pb.PhoneNumber{
				Number: "18714857878",
				Type:   pb.PhoneType_HOME,
			},
			&pb.PhoneNumber{
				Number: "18714854545",
				Type:   pb.PhoneType_WORK,
			},
		},
	}

	fmt.Println("person: ", person)
	// 编码: 将person对象进行序列化,得到二进制文件
	data, err := proto.Marshal(person)
	if err != nil {
		fmt.Println("encode err: ", err)
		return
	}

	fmt.Println("data: ", data)

	// 解码(反序列化)
	person2 := &pb.Person{}
	err = proto.Unmarshal(data, person2)
	if err != nil {
		fmt.Println("decode err: ", err)
		return
	}
	fmt.Println("person2: ", person2)
}

在这里插入图片描述

你可能感兴趣的:(golang,golang,github,prototype)