Protocol Buffer技術詳解(C++實例)
這篇Blog仍然是以Google的官方文檔爲主線，代碼實例則徹底取自於咱們正在開發的一個Demo項目，經過前一段時間的嘗試，感受這種結合的方式比較有利於培訓和內部的技術交流。仍是那句話，沒有最好的，只有最適合的。我想寫Blog也是這一道理吧，不一樣的技術主題可能須要採用不一樣的風格。好了，仍是讓咱們儘早切入主題吧。
1、生成目標語言代碼。
下面的命令幫助咱們將MyMessage.proto文件中定義的一組Protocol Buffer格式的消息編譯成目標語言（C++）的代碼。至於消息的內容，咱們會在後面以分段的形式逐一列出，同時也會在附件中給出全部源代碼。
protoc -I=./message --cpp_out=./src ./MyMessage.proto
從上面的命令行參數中能夠看出，待編譯的文件爲MyMessage.proto，他存放在當前目錄的message子目錄下。--cpp_out參數則指示編譯工具咱們須要生成目標語言是C++，輸出目錄是當前目錄的src子目錄。在本例中，生成的目標代碼文件名是MyMessage.pb.h和MyMessage.pb.cc。
2、簡單message生成的C++代碼。
這裏先定義一個最簡單的message，其中只是包含原始類型的字段。
option optimize_for = LITE_RUNTIME;
message LogonReqMessage {
required int64 acctID = 1;
required string passwd = 2;
}
因爲咱們在MyMessage文件中定義選項optimize_for的值爲LITE_RUNTIME，所以由該.proto文件生成的全部C++類的父類均爲::google::protobuf::MessageLite，而非::google::protobuf::Message。在上一篇博客中已經給出了一些簡要的說明，MessageLite類是Message的父類，在MessageLite中將缺乏Protocol Buffer對反射的支持，而此類功能均在Message類中提供了具體的實現。對於咱們的項目而言，整個系統相對比較封閉，不會和更多的外部程序進行交互，與此同時，咱們的客戶端部分又是運行在Android平臺，有鑑於此，咱們考慮使用LITE版本的Protocol Buffer。這樣不只能夠獲得更高編碼效率，並且生成代碼編譯後所佔用的資源也會更少，至於反射所能帶來的靈活性和極易擴展性，對於該項目而言徹底能夠忽略。下面咱們來看一下由message LogonReqMessage生成的C++類的部分聲明，以及經常使用方法的說明性註釋。數組
class LogonReqMessage : public ::google::protobuf::MessageLite {
public:
LogonReqMessage();
virtual ~LogonReqMessage();
// implements Message ----------------------------------------------
//下面的成員函數均實現自MessageLite中的虛函數。
//建立一個新的LogonReqMessage對象，等同於clone。
LogonReqMessage* New() const;
//用另一個LogonReqMessage對象初始化當前對象，等同於賦值操做符重載（operator=）
void CopyFrom(const LogonReqMessage& from);
//清空當前對象中的全部數據，既將全部成員變量置爲未初始化狀態。
void Clear();
//判斷當前狀態是否已經初始化。
bool IsInitialized() const;
//在給當前對象的全部變量賦值以後，獲取該對象序列化後所須要的字節數。
int ByteSize() const;
//獲取當前對象的類型名稱。
::std::string GetTypeName() const;
// required int64 acctID = 1;
//下面的成員函數都是因message中定義的acctID字段而生成。
//這個靜態成員表示AcctID的標籤值。命名規則是k + FieldName(駝峯規則) + FieldNumber。
static const int kAcctIDFieldNumber = 1;
//若是acctID字段已經被設置返回true，不然false。
inline bool has_acctid() const;
//執行該函數後has_acctid函數將返回false，而下面的acctid函數則返回acctID的缺省值。
inline void clear_acctid();
//返回acctid字段的當前值，若是沒有設置則返回int64類型的缺省值。
inline ::google::protobuf::int64 acctid() const;
//爲acctid字段設置新值，調用該函數後has_acctid函數將返回true。
inline void set_acctid(::google::protobuf::int64 value);
// required string passwd = 2;
//下面的成員函數都是因message中定義的passwd字段而生成。這裏生成的函數和上面acctid
//生成的那組函數基本類似。所以這裏只是列出差別部分。
static const int kPasswdFieldNumber = 2;
inline bool has_passwd() const;
inline void clear_passwd();
inline const ::std::string& passwd() const;
inline void set_passwd(const ::std::string& value);
//對於字符串類型字段設置const char*類型的變量值。
inline void set_passwd(const char* value);
inline void set_passwd(const char* value, size_t size);
//能夠經過返回值直接給passwd對象賦值。在調用該函數以後has_passwd將返回true。
inline ::std::string* mutable_passwd();
//釋放當前對象對passwd字段的全部權，同時返回passwd字段對象指針。調用此函數以後，passwd字段對象
//的全部權將移交給調用者。此後再調用has_passwd函數時將返回false。
inline ::std::string* release_passwd();
private:
... ...
};
下面是讀寫LogonReqMessage對象的C++測試代碼和說明性註釋。函數
void testSimpleMessage()
{
printf("==================This is simple message.================\n");
//序列化LogonReqMessage對象到指定的內存區域。
LogonReqMessage logonReq;
logonReq.set_acctid(20);
logonReq.set_passwd("Hello World");
//提早獲取對象序列化所佔用的空間並進行一次性分配，從而避免屢次分配
//而形成的性能開銷。經過該種方式，還能夠將序列化後的數據進行加密。
//以後再進行持久化，或是發送到遠端。
int length = logonReq.ByteSize();
char* buf = new char[length];
logonReq.SerializeToArray(buf,length);
//從內存中讀取並反序列化LogonReqMessage對象，同時將結果打印出來。
LogonReqMessage logonReq2;
logonReq2.ParseFromArray(buf,length);
printf("acctID = %I64d, password = %s\n",logonReq2.acctid(),logonReq2.passwd().c_str());
delete [] buf;
}
3、嵌套message生成的C++代碼。
enum UserStatus {
OFFLINE = 0;
ONLINE = 1;
}
enum LoginResult {
LOGON_RESULT_SUCCESS = 0;
LOGON_RESULT_NOTEXIST = 1;
LOGON_RESULT_ERROR_PASSWD = 2;
LOGON_RESULT_ALREADY_LOGON = 3;
LOGON_RESULT_SERVER_ERROR = 4;
}
message UserInfo {
required int64 acctID = 1;
required string name = 2;
required UserStatus status = 3;
}
message LogonRespMessage {
required LoginResult logonResult = 1;
required UserInfo userInfo = 2; //這裏嵌套了UserInfo消息。
}
對於上述消息生成的C++代碼，UserInfo由於只是包含了原始類型字段，所以和上例中的LogonReqMessage沒有太多的差異，這裏也就不在重複列出了。因爲LogonRespMessage消息中嵌套了UserInfo類型的字段，在這裏咱們將僅僅給出該消息生成的C++代碼和關鍵性註釋。工具
class LogonRespMessage : public ::google::protobuf::MessageLite {
public:
LogonRespMessage();
virtual ~LogonRespMessage();
// implements Message ----------------------------------------------
... ... //這部分函數和以前的例子同樣。
// required .LoginResult logonResult = 1;
//下面的成員函數都是因message中定義的logonResult字段而生成。
//這一點和前面的例子基本相同，只是類型換作了枚舉類型LoginResult。
static const int kLogonResultFieldNumber = 1;
inline bool has_logonresult() const;
inline void clear_logonresult();
inline LoginResult logonresult() const;
inline void set_logonresult(LoginResult value);
// required .UserInfo userInfo = 2;
//下面的成員函數都是因message中定義的UserInfo字段而生成。
//這裏只是列出和非消息類型字段差別的部分。
static const int kUserInfoFieldNumber = 2;
inline bool has_userinfo() const;
inline void clear_userinfo();
inline const ::UserInfo& userinfo() const;
//能夠看到該類並無生成用於設置和修改userInfo字段set_userinfo函數，而是將該工做
//交給了下面的mutable_userinfo函數。所以每當調用函數以後，Protocol Buffer都會認爲
//該字段的值已經被設置了，同時has_userinfo函數亦將返回true。在實際編碼中，咱們能夠
//經過該函數返回userInfo字段的內部指針，並基於該指針完成userInfo成員變量的初始化工做。
inline ::UserInfo* mutable_userinfo();
inline ::UserInfo* release_userinfo();
private:
... ...
};
下面是讀寫LogonRespMessage對象的C++測試代碼和說明性註釋。性能
void testNestedMessage()
{
printf("==================This is nested message.================\n");
LogonRespMessage logonResp;
logonResp.set_logonresult(LOGON_RESULT_SUCCESS);
//如上所述，經過mutable_userinfo函數返回userInfo字段的指針，以後再初始化該對象指針。
UserInfo* userInfo = logonResp.mutable_userinfo();
userInfo->set_acctid(200);
userInfo->set_name("Tester");
userInfo->set_status(OFFLINE);
int length = logonResp.ByteSize();
char* buf = new char[length];
logonResp.SerializeToArray(buf,length);
LogonRespMessage logonResp2;
logonResp2.ParseFromArray(buf,length);
printf("LogonResult = %d, UserInfo->acctID = %I64d, UserInfo->name = %s, UserInfo->status = %d\n"
,logonResp2.logonresult(),logonResp2.userinfo().acctid(),logonResp2.userinfo().name().c_str(),logonResp2.userinfo().status());
delete [] buf;
}
4、repeated嵌套message生成的C++代碼。
message BuddyInfo {
required UserInfo userInfo = 1;
required int32 groupID = 2;
}
message RetrieveBuddiesResp {
required int32 buddiesCnt = 1;
repeated BuddyInfo buddiesInfo = 2;
}
對於上述消息生成的代碼，咱們將只是針對RetrieveBuddiesResp消息所對應的C++代碼進行詳細說明，其他部分和前面小節的例子基本相同，可直接參照。而對於RetrieveBuddiesResp類中的代碼，咱們也僅僅是對buddiesInfo字段生成的代碼進行更爲詳細的解釋。測試
class RetrieveBuddiesResp : public ::google::protobuf::MessageLite {
public:
RetrieveBuddiesResp();
virtual ~RetrieveBuddiesResp();
... ... //其他代碼的功能性註釋都可參照前面的例子。
// repeated .BuddyInfo buddiesInfo = 2;
static const int kBuddiesInfoFieldNumber = 2;
//返回數組中成員的數量。
inline int buddiesinfo_size() const;
//清空數組中的全部已初始化成員，調用該函數後，buddiesinfo_size函數將返回0。
inline void clear_buddiesinfo();
//返回數組中指定下標所包含元素的引用。
inline const ::BuddyInfo& buddiesinfo(int index) const;
//返回數組中指定下標所包含元素的指針，經過該方式可直接修改元素的值信息。
inline ::BuddyInfo* mutable_buddiesinfo(int index);
//像數組中添加一個新元素。返回值即爲新增的元素，可直接對其進行初始化。
inline ::BuddyInfo* add_buddiesinfo();
//獲取buddiesInfo字段所表示的容器，該函數返回的容器僅用於遍歷並讀取，不能直接修改。
inline const ::google::protobuf::RepeatedPtrField< ::BuddyInfo >&
buddiesinfo() const;
//獲取buddiesInfo字段所表示的容器指針，該函數返回的容器指針可用於遍歷和直接修改。
inline ::google::protobuf::RepeatedPtrField< ::BuddyInfo >*
mutable_buddiesinfo();
private:
... ...
};
下面是讀寫RetrieveBuddiesResp對象的C++測試代碼和說明性註釋。ui
void testRepeatedMessage()
{
printf("==================This is repeated message.================\n");
RetrieveBuddiesResp retrieveResp;
retrieveResp.set_buddiescnt(2);
BuddyInfo* buddyInfo = retrieveResp.add_buddiesinfo();
buddyInfo->set_groupid(20);
UserInfo* userInfo = buddyInfo->mutable_userinfo();
userInfo->set_acctid(200);
userInfo->set_name("user1");
userInfo->set_status(OFFLINE);
buddyInfo = retrieveResp.add_buddiesinfo();
buddyInfo->set_groupid(21);
userInfo = buddyInfo->mutable_userinfo();
userInfo->set_acctid(201);
userInfo->set_name("user2");
userInfo->set_status(ONLINE);
int length = retrieveResp.ByteSize();
char* buf = new char[length];
retrieveResp.SerializeToArray(buf,length);
RetrieveBuddiesResp retrieveResp2;
retrieveResp2.ParseFromArray(buf,length);
printf("BuddiesCount = %d\n",retrieveResp2.buddiescnt());
printf("Repeated Size = %d\n",retrieveResp2.buddiesinfo_size());
//這裏僅提供了經過容器迭代器的方式遍歷數組元素的測試代碼。
//事實上，經過buddiesinfo_size和buddiesinfo函數亦可循環遍歷。
RepeatedPtrField<BuddyInfo>* buddiesInfo = retrieveResp2.mutable_buddiesinfo();
RepeatedPtrField<BuddyInfo>::iterator it = buddiesInfo->begin();
for (; it != buddiesInfo->end(); ++it) {
printf("BuddyInfo->groupID = %d\n", it->groupid());
printf("UserInfo->acctID = %I64d, UserInfo->name = %s, UserInfo->status = %d\n"
, it->userinfo().acctid(), it->userinfo().name().c_str(),it->userinfo().status());
}
delete [] buf;
}
- 1. Protocol Buffer技術詳解(C++實例)
- 2. Protocol Buffer技術詳解(Java實例)
- 3. Protocol Buffer技術
- 4. Protocol Buffer技術詳解(語言規範)
- 5. Protocol Buffer技術詳解(數據編碼)
- 6. Protocol Buffer詳解
- 7. windows10 Protocol buffer配置詳解
- 8. 詳解 Google Protocol Buffer 協議
- 9. grpc和protocol buffer介紹&實例
- 10. Protocol Buffer搭建及示例
- 更多相關文章...
- • XML 相關技術 - XML 教程
- • Hibernate的快照技術 - Hibernate教程
- • 三篇文章瞭解 TiDB 技術內幕 —— 說計算
- • Docker容器實戰(一) - 封神Server端技術
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. 「插件」Runner更新Pro版，幫助設計師遠離996
- 2. 錯誤 707 Could not load file or assembly ‘Newtonsoft.Json, Version=12.0.0.0, Culture=neutral, PublicKe
- 3. Jenkins 2018 報告速覽，Kubernetes使用率躍升235%！
- 4. TVI-Android技術篇之註解Annotation
- 5. android studio啓動項目
- 6. Android的ADIL
- 7. Android卡頓的檢測及優化方法彙總（線下+線上）
- 8. 登錄註冊的業務邏輯流程梳理
- 9. NDK(1)創建自己的C/C++文件
- 10. 小菜的系統框架界面設計-你的評估是我的決策