ubuntu下go语言使用protobuf

2023年2月13日 177次阅读 来源: xiholix

1. 编译安装protobuf(protobuf 没有关于go的release）

   为了从源码安装protobuf，先要安装一些工具：包括autoconf、automake、libtool、curl（用于下载gmock）、make、 g++、 unzip。   
   在ubuntu可以使用如下命令安装这些依赖：

   sudo apt-get install autoconf automake libtool curl make g++ unzip

然后使用 git clone  https://github.com/google/protobuf命令下载protobuf的源码包。
接者使用命令 cd protobuf进入源码库中
然后使用  ./autogen.sh运行脚本生成需要的配置脚本
接着执行如下的一系列命令来编译安装protocol buffer的complier
./configure
make
make check
sudo make install
sudo ldconfig   
最后的一个命令是用于刷新共享库的缓存的。，最后一个命令我的ubuntu无法执行

2. 安装proto-gen-go

 命令如下： go get -u github.com/golang/protobuf/proto
           go get -u github.com/golang/protobuf/protoc-gen-go
然后将环境变量GOPATH定义的目录下的bin目录加入到环境变量PATH中。
命令如下：vi  ~/.bashrc
然后在该文件最后加上：export PATH="$PATH:$GOPATH/bin"即可。
然后调用 source ~/.bashrc

3.定义一个proto文件test.proto如下：

package example;

enum FOO { X = 17; };

message Test {
required string label = 1;
optional int32 type = 2 [default=77];
repeated int64 reps = 3;
optional group OptionalGroup = 4 {
required string RequiredField = 5;
}
}

在该文件对应的文件夹中执行命令：protoc –go_out=. *.proto用于生成.pb.go文件。如果这个命令执行过程中出现 protoc-gen-go: program not found or is not executable 这个错误，表示该protoc-gen-go没有被加入到Path环境变量中，应该把该文件的所在目录加入Path变量中。该文件存放在环境变量GOPATH目录下的bin子目录里。

4.编写测试代码：

 首先要将上一节生成的example包放入GOPATH目录下的src文件夹下:
 然后建立如下的测试代码：

package main

import (
   "fmt"
   "github.com/golang/protobuf/proto"
   // test.pb.go 的路径
   "example"
)

func main() {
   // 创建一个消息 Test
   test := &example.Test{
       // 使用辅助函数设置域的值
       Label: proto.String("hello"),
       Type:  proto.Int32(17),
       Optionalgroup: &example.Test_OptionalGroup{
           RequiredField: proto.String("good bye"),
       },
   }

   // 进行编码
   data, err := proto.Marshal(test)
   if err != nil {
       fmt.Println("marshaling error: ", err)
   }

   // 进行解码
   newTest := &example.Test{}
   err = proto.Unmarshal(data, newTest)
   if err != nil {
       fmt.Println("unmarshaling error: ", err)
   }

   // 测试结果
   if test.GetLabel() != newTest.GetLabel() {
       fmt.Println("data mismatch %q != %q", test.GetLabel(), newTest.GetLabel())
   }
   fmt.Printf("%+v", newTest)
}

5 golang中可用的protobuf的接口：

在使用之前，我们先了解一下每个 Protobuf 消息在 Golang 中有哪一些可用的接口：
    1.  每一个 Protobuf 消息对应一个 Golang 结构体
    2. 消息中域名字为 camel_case 在对应的 Golang 结构体中为 CamelCase
    3. 消息对应的 Golang 结构体中不存在 setter 方法，只需要直接对结构体赋值即可，赋值时可能使用到一些辅助函数，例如：
       msg.Foo = proto.String("hello")
    4. 消息对应的 Golang 结构体中存在 getter 方法，用于返回域的值，如果域未设置值，则返回一个默认值
    5. 消息中非 repeated 的域都被实现为一个指针，指针为 nil 时表示域未设置消息中 repeated 的域被实现为 slice
    6. 访问枚举值时，使用“枚举类型名_枚举名”的格式（更多内容可以直接阅读生成的源码）
    7. 使用 proto.Marshal 函数进行编码，使用 proto.Unmarshal 函数进行解码

参考链接：

  1. 在 Golang 中使用 Protobuf
  2. golang [C++ installation](C++ Installation – Unix)
  3. go语言使用protobuf
    原文作者：xiholix
    原文地址: https://www.jianshu.com/p/561eca06356a
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞