protobuf c++ API


一、在.proto文件中定義消息格式html

二、使用protobuf編譯器
三、使用c++ api來讀寫消息
 
0、爲什麼使用protobuf?
 
一、原始內存數據結構,能夠以二進制方式sent/saved.這種方式須要相同的內存佈局和字節序。
二、以ad-hoc方式將數據項編碼成一個簡單字符串----好比,將4個int類型編碼成"12:3:-23:67"。這種方式簡靈活。適用於簡單數據。
三、將數據序列化爲XML。這種方式很流行,由於xml可讀性好,編碼解碼方便,性能也好。僅僅XML dom樹比較複雜。
 
protobuf能夠很好的解決上述問題。你編寫一個.proto文件來描述數據結構。protobuf編譯器使用它建立一個類,使用二進制方式自動編碼/解碼該數據結構。生成的類提供getter/setter方法。
 
最重要的是,protobuf支持在此基礎上進行格式擴展。
 
 
一、定義協議格式
 

package tutorial; message Person{
required string name =1;
required int32 id =2;
optional string email =3;

enumPhoneType{
MOBILE =0;
HOME =1;
WORK =2;
}

message PhoneNumber{
required string number =1;
optional PhoneType type =2[default= HOME];
}

repeated PhoneNumber phone =4;
}

message AddressBook{
repeated Person person =1;
}java

 
該結構與c++或java很像.
 
.proto文件以包聲明開始,防止名字衝突。
簡單類型:bool, int32, float, double, string.
其它類型:如上述的Person, PhoneNumber
 
類型能夠嵌套。
「=1」, 「=2」標識惟一「tag」.tag數1-15須要至少一個字節。
 
required: 必須設置它的值
optional: 能夠設置,也能夠不設置它的值
repeated: 能夠認爲是動態分配的數組
google工程師認爲使用required威害更大, 他們更喜歡使用optional, repeated.
 
 
二、編譯你的協議
 
運行protoc 來生成c++文件:
protoc -I=$SRC_DIR --cpp_out=$DST_DIR $SRC_DIR/addressbook.proto
生成的文件爲:
addressbook.pb.h, 
addressbook.pb.cc
 
三、protobuf API
 
生成的文件中有以下方法:
// name
  inlinebool has_name()const;
  inlinevoid clear_name();
  inlineconst::std::string& name()const;
  inlinevoid set_name(const::std::string& value);
  inlinevoid set_name(constchar* value);
  inline::std::string* mutable_name();

  // id
  inlinebool has_id()const;
  inlinevoid clear_id();
  inlineint32_t id()const;
  inlinevoid set_id(int32_t value);

  // email
  inlinebool has_email()const;
  inlinevoid clear_email();
  inlineconst::std::string& email()const;
  inlinevoid set_email(const::std::string& value);
  inlinevoid set_email(constchar* value);
  inline::std::string* mutable_email();

  // phone
  inlineint phone_size()const;
  inlinevoid clear_phone();
  inlineconst::google::protobuf::RepeatedPtrField<::tutorial::Person_PhoneNumber>& phone()const;
  inline::google::protobuf::RepeatedPtrField<::tutorial::Person_PhoneNumber>* mutable_phone();
  inlineconst::tutorial::Person_PhoneNumber& phone(int index)const;
  inline::tutorial::Person_PhoneNumber* mutable_phone(int index);
  inline::tutorial::Person_PhoneNumber* add_phone();

四、枚舉與嵌套類ios

 
生成的代碼包含一個PhoneType枚舉。Person::PhoneType, Person:MOBILE, Person::HOME, Person:WORK.
 
編譯器生成的嵌套類稱爲Person::PhoneNumber. 實際生成類爲Person_PhoneNumber.
 
五、標準方法
 

bool IsInitialized() const:                確認required字段是否被設置c++

string DebugString() const:                返回消息的可讀表示,用於調試json

void CopyFrom(const Person& from):         使用給定消息值copyapi

void Clear():                              清除全部元素爲空狀態數組

六、解析與序列化
 

bool SerializeToString(string* output) const:        序列化消息,將存儲字節的以string方式輸出。注意字節是二進,而非文本;數據結構

bool ParseFromString(const string& data):            解析給定的string     多線程

bool SerializeToOstream(ostream* output) const:      寫消息給定的c++  ostreamdom

bool ParseFromIstream(istream* input):               從給定的c++ istream中解析出消息

七、protobuf和 oo設計
不要繼承生成類並在此基礎上添加相應的行爲
 
八、寫消息
 
示例:它從一個文件中讀取AddressBook,基於io添加一個新的Person,並將新的AddressBook寫回文件。
#include<iostream>
#include<fstream>
#include<string>
#include"addressbook.pb.h"
usingnamespace std;

// This function fills in a Person message based on user input.
voidPromptForAddress(tutorial::Person* person){
  cout <<"Enter person ID number: ";
  int id;
  cin >> id;
  person->set_id(id);
  cin.ignore(256,'\n');

  cout <<"Enter name: ";
  getline(cin,*person->mutable_name());

  cout <<"Enter email address (blank for none): ";
  string email;
  getline(cin, email);
  if(!email.empty()){
    person->set_email(email);
  }

  while(true){
    cout <<"Enter a phone number (or leave blank to finish): ";
    string number;
    getline(cin, number);
    if(number.empty()){
      break;
    }

    tutorial::Person::PhoneNumber* phone_number = person->add_phone();
    phone_number->set_number(number);

    cout <<"Is this a mobile, home, or work phone? ";
    string type;
    getline(cin, type);
    if(type =="mobile"){
      phone_number->set_type(tutorial::Person::MOBILE);
    }elseif(type =="home"){
      phone_number->set_type(tutorial::Person::HOME);
    }elseif(type =="work"){
      phone_number->set_type(tutorial::Person::WORK);
    }else{
      cout <<"Unknown phone type.  Using default."<< endl;
    }
  }
}

// Main function:  Reads the entire address book from a file,
//   adds one person based on user input, then writes it back out to the same
//   file.
int main(int argc,char* argv[]){
  // Verify that the version of the library that we linked against is
  // compatible with the version of the headers we compiled against.
  GOOGLE_PROTOBUF_VERIFY_VERSION;

  if(argc !=2){
    cerr <<"Usage:  "<< argv[0]<<" ADDRESS_BOOK_FILE"<< endl;
    return-1;
  }

  tutorial::AddressBook address_book;

  {
    // Read the existing address book.
    fstream input(argv[1], ios::in| ios::binary);
    if(!input){
      cout << argv[1]<<": File not found.  Creating a new file."<< endl;
    }elseif(!address_book.ParseFromIstream(&input)){
      cerr <<"Failed to parse address book."<< endl;
      return-1;
    }
  }

  // Add an address.
  PromptForAddress(address_book.add_person());

  {
    // Write the new address book back to disk.
    fstream output(argv[1], ios::out| ios::trunc | ios::binary);
    if(!address_book.SerializeToOstream(&output)){
      cerr <<"Failed to write address book."<< endl;
      return-1;
    }
  }

  // Optional:  Delete all global objects allocated by libprotobuf.
  google::protobuf::ShutdownProtobufLibrary();

  return0;
}
注意使用GOOGLE_PROTOBUF_VERIFY_VERSION宏。每個.pb.cc文件在啓動時都將自動調用該宏。
 
注意在程序結尾處調用ShutdownProtobufLibrary()。
 
九、讀消息 
#include<iostream>
#include<fstream>
#include<string>
#include"addressbook.pb.h"
usingnamespace std;

// Iterates though all people in the AddressBook and prints info about them.
voidListPeople(const tutorial::AddressBook& address_book){
  for(int i =0; i <address_book.person_size(); i++){
    const tutorial::Person& person = address_book.person(i);

    cout <<"Person ID: "<<person.id()<< endl;
    cout <<"  Name: "<<person.name()<< endl;
    if(person.has_email()){
      cout <<"  E-mail address: "<<person.email()<< endl;
    }

    for(int j =0; j <person.phone_size(); j++){
      const tutorial::Person::PhoneNumber& phone_number = person.phone(j);

      switch(phone_number.type()){
        casetutorial::Person::MOBILE:
          cout <<"  Mobile phone #: ";
          break;
        casetutorial::Person::HOME:
          cout <<"  Home phone #: ";
          break;
        casetutorial::Person::WORK:
          cout <<"  Work phone #: ";
          break;
      }
      cout <<phone_number.number()<< endl;
    }
  }
}

// Main function:  Reads the entire address book from a file and prints all
//   the information inside.
int main(int argc,char* argv[]){
  // Verify that the version of the library that we linked against is
  // compatible with the version of the headers we compiled against.
  GOOGLE_PROTOBUF_VERIFY_VERSION;

  if(argc !=2){
    cerr <<"Usage:  "<< argv[0]<<" ADDRESS_BOOK_FILE"<< endl;
    return-1;
  }

  tutorial::AddressBook address_book;

  {
    // Read the existing address book.
    fstream input(argv[1], ios::in| ios::binary);
    if(!address_book.ParseFromIstream(&input)){
      cerr <<"Failed to parse address book."<< endl;
      return-1;
    }
  }

  ListPeople(address_book);

  // Optional:  Delete all global objects allocated by libprotobuf.
  google::protobuf::ShutdownProtobufLibrary();

  return0;
}
十、擴展protobuf
 
若是但願向後兼容,必須遵循:
a、沒必要更改tag數
b、沒必要添加或刪除任何required字段
c、能夠刪除optional或repeated字段
d、能夠添加新的optional或repeated字段,但你必須使用新的tag數。
 
十一、優化
c++的protobuf庫,已經極大地優化了。合理使用能夠改善性能。
a、若是可能,複用message對象。
b、關於多線程的內存分配器
 
十二、高級用法
 
protobuf的消息類的一個關鍵特性是,反射(reflection)。可使用xml或json來實現。 參考
 
 
================================================================
常見問題:
一、undefined reference to `pthread_once' 
使用-lpthread:
 
二、error while loading shared libraries: libprotobuf.so.7: cannot open shared object file: No such file or directory
使用-Wl,-Bstatic -lprotobuf -Wl,-Bdynamic -lpthread


相關文章
相關標籤/搜索