protobuf是一種跨語言協(xié)議账嚎,不同語言之間只需定義同一份proto文件克滴,即可實現(xiàn)不同種類的語言的協(xié)議溝通。由于工作中使用c++解碼較為麻煩熄驼,為了提升工作效率像寒,想通過python達到快速解析pb數(shù)據(jù)的目的(系統(tǒng)為macOS Sierra)。
出自文章 https://segmentfault.com/a/1190000010098194
python版本的protobuf安裝
首先安裝官方protobuf瓜贾,通過執(zhí)行protoc命令诺祸,可以將proto源文件編譯成對應語言的數(shù)據(jù)結構文件和解析代碼,如python對應的文件后綴名通常為.py和.pyc祭芦;官方下載鏈接:https://github.com/google/protobuf/releases序臂,下載全量源碼,然后解壓实束、安裝奥秆,然后確認安裝是否成功。此外可以通過 brew install protobuf 直接安裝咸灿。
cd 對應目錄
./configure
make
make check
make install
protoc --version
其次构订,安裝對應的python protobuf模塊,python引入該模塊即可編寫代碼避矢,實現(xiàn)pb文件的解析悼瘾。安裝python protobuf模塊囊榜,首先安裝pip,mac系統(tǒng)的python自帶easy_install亥宿,因此直接輸入命令:sudo easy_install pip卸勺;再通過pip來安裝protobuf,命令:pip install protobuf烫扼;
遇到的問題:mac下python的six模塊版本較低曙求,且由于系統(tǒng)原因,無法被卸載安裝新版映企,而pip在安裝protobuf時需要悟狱,默認會下載安裝較新版本的six模塊,因此這里出現(xiàn)了沖突堰氓。通過參考該鏈接:https://github.com/pypa/pip/issues/3165挤渐,只需在使用pip安裝python模塊前,執(zhí)行該命令即可:
pip install --ignore-installed six
使用python解析pb數(shù)據(jù)流程
這里使用c++對數(shù)據(jù)進行編碼双絮,并生成pb二進制文件浴麻,再通過python對pb二進制文件解碼,得到c++輸入的數(shù)據(jù)囤攀。使用c++寫的client程序和python寫的server服務器程序通信软免,在cleint端對數(shù)據(jù)編碼,在server端對數(shù)據(jù)解碼抚岗,通信方式采用socket,通信數(shù)據(jù)格式采用protobuf哪怔。
遇到的問題:當c++客戶端-c++服務器宣蔚,數(shù)據(jù)能正常編碼和解析,而c++客戶端-python服務器時认境,服務端python的recv函數(shù)接收的數(shù)據(jù)是null胚委,無法正常接收。
解決方案:懷疑是python接收二進制數(shù)據(jù)問題叉信,具體原因后續(xù)探究亩冬。因此把c++編碼的protobuf數(shù)據(jù)再進行base64編碼,將二進制proto數(shù)據(jù)變?yōu)樽址鹕恚攑ython服務端收到數(shù)據(jù)后硅急,先進行base64解碼,再對protobuf數(shù)據(jù)解碼佳遂。
people.proto源文件:
package demo;
message People {
required string name = 1;
required int32 id = 2;
required string email = 3;
}
切換到對應的proto源文件目錄营袜,執(zhí)行命令,將產(chǎn)出兩個文件people.pb.cc 和people.pb.h
protoc -I . --c++_out=. people.proto
切換到對應的proto源文件目錄丑罪,執(zhí)行以下命令荚板,將產(chǎn)出文件people_pb2.pyc
protoc -I . --python_out=. people.proto
c++客戶端代碼:
#include <stdio.h>
#include <stdlib.h>
#include <strings.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <string>
#include <iostream>
#include "people.pb.h"http://引入c++對應的proto文件
#include "base64.h"
#define MYPORT 8080
#define BUFFER_SIZE 1024
int main()
{
///定義sockfd
int sock_cli = socket(AF_INET,SOCK_STREAM, 0);
///定義sockaddr_in
struct sockaddr_in servaddr;
memset(&servaddr, 0, sizeof(servaddr));
servaddr.sin_family = AF_INET;
servaddr.sin_port = htons(MYPORT); ///服務器端口
servaddr.sin_addr.s_addr = inet_addr("127.0.0.1"); ///服務器ip
///連接服務器凤壁,成功返回0,錯誤返回-1
if (connect(sock_cli, (struct sockaddr *)&servaddr, sizeof(servaddr)) < 0)
{
perror("connect");
exit(1);
}
char recvbuf[BUFFER_SIZE];
char sendbuf[BUFFER_SIZE];
int numbytes = (int)recv(sock_cli, recvbuf, BUFFER_SIZE, 0);
recvbuf[numbytes] = '\0';
std::string strbuf = recvbuf;
std::cout << "Client Message: " << strbuf << std::endl;
if(strbuf == "GET PEOPLE")
{
std::string data;
demo::People p;
p.set_name("xionghengheng");
p.set_id(1881409);
p.set_email("xionghengheng@gmail.com");
p.SerializeToString(&data);//protobuf數(shù)據(jù)編碼
char bts[data.length()];
strcpy(bts, data.c_str());
Base64 *base64 = new Base64();
std::string encode = base64->Encode((unsigned char*)bts, data.length());//base64編碼
memset(sendbuf, 0, sizeof(sendbuf));
strcpy(sendbuf, encode.c_str());
send(sock_cli, sendbuf, strlen(sendbuf), 0);
}
else
{
send(sock_cli, "Fucking client!\n", 16, 0);
}
memset(recvbuf, 0, sizeof(recvbuf));
close(sock_cli);
return 0;
}
python2.7服務端程序:
# -*- coding: UTF-8 -*-
import os
import socket
import time
import threading
import people_pb2 as people#引入python proto對應的文件
import base64
def tcplink(sock, addr):
print('Accept new connection from %s:%s...' % addr)
sock.send('GET PEOPLE'.encode())
while True:
data = sock.recv(2048)
time.sleep(1)
if data == 'exit' or not data:
print("no data")
break
else:
data = base64.b64decode(data)#base64解碼
peopleItem = people.People()
peopleItem.ParseFromString(data)#protobuf數(shù)據(jù)解碼
print(peopleItem.name)
print(peopleItem.id)
print(peopleItem.email)
sock.close()
print('Connection from %s:%s closed.' % addr)
# 開啟ip和端口
ip_port = ('127.0.0.1', 8080)
# 生成句柄
web = socket.socket()
# 綁定端口
web.bind(ip_port)
# 最多連接數(shù)
web.listen(5)
# 等待信息
print ('nginx waiting...')
# 開啟死循環(huán)
while True:
# 接受一個新連接:
sock,addr = web.accept()
# 創(chuàng)建新線程來處理TCP連接:
t = threading.Thread(target=tcplink, args=(sock, addr))
t.start()
服務端輸出結果:
nginx waiting...
Accept new connection from 127.0.0.1:50828...
xionghengheng
1881409
xionghengheng@gmail.com
no data
Connection from 127.0.0.1:50828 closed.