ProtoBuf安装及使用

安装

1、安装 protoc ：protoc下载地址，可以根据自己的系统下载相应的 protoc，推荐下载编译好的二进制文件包压缩包；

2、配置 protoc 到系统的环境变量中，执行如下命令查看是否安装成功：

protoc --version

3、安装 ProtoBuf 相关的 golang 依赖库

 go get -u github.com/golang/protobuf/protoc-gen-go
 go get -u github.com/golang/protobuf/proto

编写pb文件

在example目录下建立person.proto文件

syntax = "proto3";

package example;

message person {
    int32 id = 1;
    string name = 2;
}

message all_person {
    repeated person Per = 1;
}

编译

protoc --proto_path=IMPORT_PATH  --go_out=DST_DIR person.proto

IMPORT_PATH：指定 proto 文件的路径，如果没有指定， protoc 会从当前目录搜索对应的 proto 文件，如果有多个路径，那么可以指定多次–proto_path
指定各语言代码的输出路径，”.”表示当前路径
–cpp_out：生成c++代码
java_out ：生成java代码
python_out ：生成python代码
go_out ：生成go代码
ruby_out ：生成ruby代码
javanano_out ：适合运行在有资源限制的平台（如Android）的java代码
objc_out ：生成 Objective-C代码
csharp_out ：生成C#代码
php_out ：生成PHP代码

编译后生成person.pb.go文件

测试protobuf的序列化与反序列化

package main

import (
    "github.com/golang/protobuf/proto"
    ex "hello/hello_test/protocTest/example"
    "log"
)

func main() {
    p1 := ex.Person{
        Id: 1,
        Name: "hehe",
    }

    p2 := ex.Person{
        Id: 2,
        Name: "aaa",
    }

    allPerson := ex.AllPerson{
        Per: []*ex.Person{&p1,&p2},
    }

    data, err := proto.Marshal(&allPerson)
    if err != nil {
        log.Fatalln("marshal error. ", err)
    }

    var dst ex.AllPerson

    err = proto.Unmarshal(data, &dst)
    if err != nil {
        log.Fatalln("unmarshal error.", err)
    }

    log.Println(dst.Per[0])
    log.Println(dst.Per[1])

    log.Println(dst.String())
    log.Println(dst.GetPer()[0])

}

输出

2018/08/10 16:36:18 id:1 name:"hehe"
2018/08/10 16:36:18 id:2 name:"aaa"
2018/08/10 16:36:18 Per:<id:1 name:"hehe" > Per:<id:2 name:"aaa" >
2018/08/10 16:36:18 id:1 name:"hehe"

包含service的定义

如果proto文件中包含service的定义，那么就不能使用

protoc --proto_path=IMPORT_PATH  --go_out=DST_DIR person.proto

这种格式命令来编译了，应该使用

protoc --proto_path=IMPORT_PATH  --go_out=plugins=grpc:DST_DIR person.proto

这2种命令生成的proto文件的区别是，第一个命令生成的proto文件只包含序列化与反序列化的方法。
第二个命令生成的proto文件除了包含序列化与反序列化的文件，还包含grpc的服务端与客户端的方法。
原文章链接