欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

在go语言中安装与使用protobuf的方法详解

程序员文章站 2022-06-16 22:24:53
简介 本文主要给大家介绍了关于go语言安装使用protobuf的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧。 protobuf是googl...

简介

本文主要给大家介绍了关于go语言安装使用protobuf的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧。

protobuf是google开发出来的一个语言无关、平台无关的数据序列化工具,在rpc或tcp通信等很多场景都可以使用。通俗来讲,如果客户端和服务端使用的是不同的语言,那么在服务端定义一个数据结构,通过protobuf转化为字节流,再传送到客户端解码,就可以得到对应的数据结构。这就是protobuf神奇的地方。并且,它的通信效率极高,“一条消息数据,用protobuf序列化后的大小是json的10分之一,xml格式的20分之一,是二进制序列化的10分之一”。

安装

编译安装protobuf的编译器protoc

  wget https://github.com/google/protobuf/releases/download/v2.6.1/protobuf-2.6.1.tar.gz
  tar zxvf protobuf-2.6.1.tar.gz
  cd protobuf-2.6.1./configure
  make
  make install

        执行 protoc  -h 查看安装是否成功

安装插件 protoc-gen-go,它是一个go程序,编译它之后将可执行文件执行路径写入环境变量

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

获取proto包

go get github.com/golang/protobuf/proto

在go中使用

protobuf的使用方法是将数据结构写入到.proto文件中,使用protoc编译器编译(间接使用了插件)得到一个新的go包,里面包含go中可以使用的数据结构和一些辅助方法。

编写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 生成 test.pb.go 文件

    将test.pb.go文件放入example文件夹(对应上面package)中,作为example包

try

 package main

 import (
  "log"

  "github.com/golang/protobuf/proto"
  "example"
 )

 func main() {
  test := &example.test {
   label: proto.string("hello"),
   type: proto.int32(17),
   reps: []int64{1, 2, 3},
   optionalgroup: &example.test_optionalgroup {
    requiredfield: proto.string("good bye"),
   },
  }
  data, err := proto.marshal(test)
  if err != nil {
   log.fatal("marshaling error: ", err)
  }
  newtest := &example.test{}
  err = proto.unmarshal(data, newtest)
  if err != nil {
   log.fatal("unmarshaling error: ", err)
  }
  // now test and newtest contain the same data.
  if test.getlabel() != newtest.getlabel() {
   log.fatalf("data mismatch %q != %q", test.getlabel(), newtest.getlabel())
  }
  //test.getoptionalgroup().getrequiredfield()
  //etc
 }

一些对应关系

  • message test对为 struct 结构,其属性字段有了对应的get方法,在go中可以使用test.getlabel()test.gettype()获取test对象的属性
  • optionalgroup对应为 struct中的内嵌struct
  • proto文件中repeated属性对于slice结构
  • test.reset()可以使其所有属性置为0值
  • 使用marshal和unmarshal可以轻松的编码和解码

这些只是一些特性,想要仔细研究可以查看github上的wiki:

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对的支持。