這篇Blog仍然是以Google的官方文檔為主線，代碼實例則完全取自于我們正在開發的一個Demo項目，通過前一段時間的嘗試，感覺這種結合的方式比較有利于培訓和內部的技術交流。還是那句話，沒有最好的，只有最適合的。我想寫Blog也是這一道理吧，不同的技術主題可能需要采用不同的風格。好了，還是讓我們盡早切入主題吧。
一、生成目標語言代碼
下面的命令幫助我們將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。
二、簡單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;
}
三、嵌套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;
}
四、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++測試代碼和說明性注釋。
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;
}
最后需要說明的是，Protocol Buffer仍然提供了很多其它非常有用的功能，特別是針對序列化的目的地，比如文件流和網絡流等。與此同時，也提供了完整的官方文檔和規范的命名規則，在很多情況下，可以直接通過函數的名字便可獲悉函數所完成的工作。
本打算將該Blog中使用的示例代碼以附件的方式上傳，但是沒有發現此功能，望諒解。
