谷歌protobuf的使用

• 一、概述
• 二、安裝
• 三、protobuf中的限定符
• 四、protobuf支持的數據類型
• 五、編譯
• • 1. 將proto文件編譯成 C++ 文件
  • 2. 將編譯好的文件與代碼一起編譯執行
• 六、應用
• • 1. proto 文件的編寫(文件后綴名：proto)
  • 2. 基礎應用
  • 3. 嵌套應用(即message內嵌套message)
  • 4. libevent 和 protobuf 協作

一、概述

Protocol buffers 是 Google 的語言中立、平臺中立、可擴展的結構化數據序列化機制——像 XML，但更小、更快、更簡單。您可以定義一次數據的結構化方式，然后您可以使用特殊生成的源代碼輕松地使用各種語言在各種數據流中寫入和讀取結構化數據。

Photocol buffers 是一種比json和xml等序列化工具更加輕量和高效的結構化數據存儲格式，性能比json和xml真的強很多。

原理圖：

二、安裝

# 如果在解壓或安裝時出現問題，執行 apt-get install autoconf automake libtool curl make g++ unzip # 1. 從github上克隆protobuf git clone https://github.com/protocolbuffers/protobuf # 2. 解壓下載好的文件 unzip protobuf-master.zip # 3. 進入 protobuf-master 目錄 cd protobuf-master/ # 4. 執行如下命令 ./autogen.sh ./configure make make check make install ldconfig # 5. 在 shell 下輸入protoc ，如果出現 Usage: protoc [OPTION] PROTO_FILES 則成功。

三、protobuf中的限定符

限定符含義

required	必填字段
optional	可選字段
repeated	可重復字段

四、protobuf支持的數據類型

protobuf數據類型代表C++數據類型描述

float	float	無
double	double	無
int32	__int32	使用變長編碼，對于負值的效率很低，如果你的域有可能有負值，請使用sint64替代
uint32	unsigned __int32	使用變長編碼
int64	__int64	使用變長編碼
uint64	unsigned __int64	使用變長編碼
sint32	__int32	使用變長編碼，這些編碼在負值時比int32高效的多
sint64	__int64	使用變長編碼，有符號的整型值。編碼時比通常的int64高效。
fixed32	unsigned __int32	總是4個字節，如果數值總是比228大的話，這個類型會比uint32高效。
fixed64	unsigned __int64	總是8個字節，如果數值總是比總是比256大的話，這個類型會比uint64高效。
sfixed32	__int32	總是4個字節
sfixed64	__int64	總是8個字節
bool	bool
string	std::string	一個字符串必須是UTF-8編碼或者7-bit ASCII編碼的文本。
bytes	std::string	可能包含任意順序的字節數據。
enum	enum	枚舉類型。如果要將兩個枚舉變量的值設為相等，那么需要添加如下代碼，否則會報錯：option allow_alias = true;

五、編譯

1. 將proto文件編譯成 C++ 文件

# SRC_DIR: proto文件(example.proto)所在目錄 # cpp_out(DST_DIR): 制定了生成代碼的路徑 # example.proto: 指proto文件名 protoc -I=$SRC_DIR --cpp_out=$DST_DIR example.proto# 示例： protoc -I=./ --cpp_out=./ example.proto # 說明：在當前目錄中查找 example.proto 并將生成的文件放在當前目錄下

2. 將編譯好的文件與代碼一起編譯執行

g++ -std=c++11 example.cc example.pb.cc -lprotobuf

六、應用

1. proto 文件的編寫(文件后綴名：proto)

syntax = "proto2";package example;// 使用手機號登錄獲取驗證碼(請求端) message get_code_requset {required string mobile = 1; }// 使用手機號登錄獲取驗證碼(響應端) message get_code_response {required int32 code = 1; // 響應代號required int32 icode = 2; // 驗證碼optional string reason = 3; // 失敗原因 }// 使用手機號登錄(請求端) message login_request {required string mobile = 1; // 手機號碼required int32 icode = 2; // 驗證碼 }// 使用手機號登錄(響應端) message login_response {required int32 code = 1; // 響應代號optional string reason = 2; // 失敗原因 }// 查詢登錄記錄(請求端) message login_record_request {required string mobile = 1; // 手機號碼 }// 查詢登錄記錄(響應端) message login_record_response {required int32 code = 1; // 響應代號optional string reason = 2; // 失敗原因message login_record {required int32 timestamp = 1; // 時間戳required string device_name = 2; // 設備名}repeated login_record records = 3; }// 將以上代碼編譯成 C++ 文件 // protoc -I=./ --cpp_out=./ example.proto

2. 基礎應用

#include <string> #include <iostream> #include "example.pb.h"int main(int argc, char *argv[]) {std::string data; // 存儲序列化之后的數據// 客戶端發送請求{example::get_code_requset getCodeRequest;getCodeRequest.set_mobile("19912341234");getCodeRequest.SerializeToString(&data);std::cout << "serial[" << data.length() << "]:" << data << std::endl;}// 服務器端解析數據{example::get_code_requset parse;parse.ParseFromString(data);std::cout << "mobile: " << parse.mobile() << std::endl;}return 0; }/********************************************************************************************** 使用如下語句在shell下編譯：g++ -std=c++11 example.cc example.pb.cc -o example.exe -lprotobuf **********************************************************************************************/

3. 嵌套應用(即message內嵌套message)

#include <time.h> #include <string> #include <iostream> #include "example.pb.h"int main(int argc, char *argv[]) {std::string data; // 存儲序列化之后的數據// 客戶端發送請求{example::login_record_response response;response.set_code(200);response.set_reason("OK");// 插入登錄數據time_t now = time(NULL);for (int i = 0; i < 5; ++i) {example::login_record_response_login_record* login = response.add_records();login->set_timestamp(now + i);login->set_device_name(std::string("phone-") + std::to_string(i));}std::cout << "record size: " << response.records_size() << std::endl;// 序列化response.SerializeToString(&data);}// 服務器端解析數據{example::login_record_response response;response.ParseFromString(data);std::cout << "code: " << response.code()<< " reason:" << response.reason()<< " parse size : " << response.records_size() << std::endl;for (int i = 0; i < response.records_size(); ++i) {const example::login_record_response_login_record& login = response.records(i);std::cout << "timestamp: " << login.timestamp()<< " device_name: " << login.device_name() << std::endl;}}return 0; }/********************************************************************************************** 使用如下語句在shell下編譯：g++ -std=c++11 example.cc example.pb.cc -o example.exe -lprotobuf **********************************************************************************************/

4. libevent 和 protobuf 協作

客戶端

// 函數 cmd_read_data() 和 socket_read_data() #include <stdio.h> #include <errno.h> #include <string.h> #include <stdlib.h> #include <unistd.h> #include <assert.h> #include <sys/types.h> #include <sys/socket.h> #include <netinet/in.h> #include <arpa/inet.h> #include <event.h> #include <event2/event.h>#include <string> #include "example.pb.h"typedef struct sockaddr sockaddr_t; typedef struct sockaddr_in sockaddr_in_t;int connect_server(const char* server_ip, int port);void cmd_read_data(int fd, short events, void* arg); void socket_read_data(int fd, short events, void* arg);int main(int argc, char* argv[]) {if (argc < 3) {fprintf(stderr, "please input [ipaddr][ipport]\n");return -1;}int sockfd = connect_server(argv[1], atoi(argv[2]));if (sockfd < 0) {fprintf(stderr, "connect_server(): failed!\n");return -2;}printf("connect server success!\n");struct event_base* base = event_base_new();struct event* ev_sockfd = event_new(base, sockfd, EV_READ | EV_PERSIST, socket_read_data, NULL);event_add(ev_sockfd, NULL);// 監聽終端輸入事件struct event* ev_cmd = event_new(base, STDIN_FILENO, EV_READ | EV_PERSIST, cmd_read_data, (void*)(&sockfd));event_add(ev_cmd, NULL);printf("event add finished!\n");event_base_dispatch(base);printf("finished!\n");return 0; }int connect_server(const char* server_ip, int port) {int sockfd, status, save_errno;sockaddr_in_t server_addr;memset(&server_addr, 0, sizeof(sockaddr_in_t));server_addr.sin_family = AF_INET;server_addr.sin_port = htons(port);status = inet_aton(server_ip, &server_addr.sin_addr);if (!status) {errno = EINVAL;fprintf(stderr, "inet_aton() failed!\n");return -1;}sockfd = socket(PF_INET, SOCK_STREAM, 0);if (sockfd < 0) {fprintf(stderr, "socket() failed! reason: %s\n", strerror(errno));return sockfd;}status = connect(sockfd, (sockaddr_t*)(&server_addr), sizeof(server_addr));if (status < 0) {fprintf(stderr, "connect() failed! reason: %s\n", strerror(errno));save_errno = errno;close(sockfd);errno = save_errno;return -1;}// 不用設置非阻塞//evutil_make_socket_nonblocking(sockfd);return sockfd; }void cmd_read_data(int fd, short events, void* arg) {std::string data;char msg[1024] = { 0 };read(fd, msg, sizeof(msg) - 1);// 向服務器發送手機號example::get_code_requset request;request.set_mobile("19912344321");request.SerializeToString(&data);int sockfd = *((int*)arg);// 把終端消息發送給服務器端，客戶端忽略性能考慮，直接使用阻塞發送write(sockfd, data.c_str(), data.length()); }void socket_read_data(int fd, short events, void* arg) {char msg[1024];// 不考慮數據讀了一半的情況int len = read(fd, msg, sizeof(msg) - 1);if (len == 0) {fprintf(stderr, "connection close!\n");exit(2);}else if (len < 0) {fprintf(stderr, "read failed!\n");exit(3);}msg[len] = '\0';example::get_code_response response;response.ParseFromString(std::string(msg));printf("code: %d, icode: %d, reason: %s\n", response.code(), response.icode(), response.reason().c_str()); }

服務器端

// 函數：do_recv_msg() #include <string.h> #include <stdlib.h> #include <event.h> #include <event2/event.h> #include <event2/listener.h> #include <event2/bufferevent.h>#include <string> #include <iostream> #include "example.pb.h"#define BUFFER_LENGTH 1024typedef struct event_base event_base_t; typedef struct bufferevent bufferevent_t; typedef struct evconnlistener evconnlistener_t;typedef struct _connect_stat {bufferevent_t* bev;char buffer[BUFFER_LENGTH]; }connect_stat_t;connect_stat_t* stat_new(bufferevent_t* bev);void listener_cb(evconnlistener_t* listener, evutil_socket_t fd, struct sockaddr* addr, int addrlen, void* user_arg);void do_recv_msg(bufferevent_t* bev, void* user_arg); void event_cb(bufferevent_t* bev, short what, void* user_arg);int main(int argc, char* argv[]) {struct sockaddr_in sin;memset(&sin, 0, sizeof(sin));sin.sin_family = AF_INET;sin.sin_port = htons(9696); // 端口為 9696//sin.sin_addr.s_addr = htonl(INADDR_ANY);event_base_t* base = event_base_new();struct evconnlistener* listener = evconnlistener_new_bind(base, listener_cb, base,BEV_OPT_CLOSE_ON_FREE,10, (struct sockaddr*)(&sin), sizeof(sin));event_base_dispatch(base);evconnlistener_free(listener);event_base_free(base);return 0; }connect_stat_t* stat_new(bufferevent_t* bev) {connect_stat_t* p = (connect_stat_t*)malloc(sizeof(connect_stat_t));memset(p, 0, sizeof(connect_stat_t));p->bev = bev;return p; }void listener_cb(evconnlistener_t* listener, evutil_socket_t fd, struct sockaddr* addr, int addrlen, void* user_arg) {event_base_t* base = (event_base_t*)(user_arg);// 為客戶端分配buffereventbufferevent_t* bev = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE);connect_stat_t* stat = stat_new(bev);bufferevent_setcb(bev, do_recv_msg, NULL, event_cb, stat);bufferevent_enable(bev, EV_READ | EV_PERSIST); }void do_recv_msg(bufferevent_t* bev, void* user_arg) {connect_stat_t* stat = (connect_stat_t*)user_arg;char* msg = stat->buffer;size_t len = bufferevent_read(bev, msg, BUFFER_LENGTH - 1);msg[len] = '\0';example::get_code_requset request;request.ParseFromString(std::string(msg));std::cout << "mobile: " << request.mobile() << std::endl;// 響應std::string data;example::get_code_response response;int icode = rand() % 100000 + 100000;response.set_code(200);response.set_icode(icode);response.set_reason("OK");response.SerializeToString(&data);bufferevent_write(bev, data.c_str(), data.length()); }void event_cb(bufferevent_t* bev, short what, void* user_arg) {connect_stat_t* stat = (connect_stat_t*)user_arg;if (what & BEV_EVENT_EOF) {printf("connection closed!\n");}else if (what & BEV_EVENT_ERROR) {printf("some other error!\n");}// 同時 關閉套接字 和 free 讀寫緩沖區bufferevent_free(bev);free(stat); }

總結

以上是生活随笔為你收集整理的谷歌protobuf(Protocol buffers)的使用的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。