protobuf: 网络版通讯录

1.客户端

1.协议约定

2..proto文件编写

1. syntax = "proto3";
2. package Add_http_contacts;
4. message AddContactRequest
5. {
6.     string name = 1;
7.     int32 age = 2;
8.     //里面是电话的字段和类型
9.     message Phone
10.     {
11.         string num = 1;
12.         enum PhoneType
13.         {
14.         MP = 0; // 移动电话
15.         TEL = 1; // 固定电话
16.         }
17.         PhoneType type = 2;
18.     }
19.     repeated Phone phone = 3;
20. }
22. message AddContactResponse
23. {
24.   bool success = 1;
25.   string error_desc = 2;
26.   string uuid = 3;
27. }

复制代码

3.Makefile

1. server:*.cc
2.     g++ -o $@ $^ -std=c++11 -lpthread -lprotobuf    //-lpthread是因为引入了第三方 httplib库
3. .PHONY:clean
4. clean:
5.     rm -rf server

复制代码

4.异常类

1. #include <iostream>
2. #include <string>
4. class ContactException
5. {
6. private:
7.     std::string _error;
8. public:
9.     ContactException(std::string err = "a problem")
10.     :_error(err)
11.     {}
12.     std::string What() const
13.     {
14.         return _error;
15.     }
16. };

复制代码

5.client.cc

1. #include <iostream>
2. #include "httplib.h"
3. #include "ContactException.hpp"
4. #include "add_contact.pb.h"
6. using std::cerr;
7. using std::cin;
8. using std::cout;
9. using std::endl;
11. using namespace httplib;
13. #define CONTACT_HOST "82.157.3.118"
14. #define CONTACT_PORT 8888
16. void menu()
17. {
18.     std::cout << "-----------------------------------------------------" << std::endl
19.               << "--------------- 请选择对通讯录的操作 ----------------" << std::endl
20.               << "------------------ 1、新增联系⼈ --------------------" << std::endl
21.               << "------------------ 2、删除联系⼈ --------------------" << std::endl
22.               << "------------------ 3、查看联系⼈列表 ----------------" << std::endl
23.               << "------------------ 4、查看联系⼈详细信息 ------------" << std::endl
24.               << "------------------ 0、退出 --------------------------" << std::endl
25.               << "-----------------------------------------------------" << std::endl;
26. }
28. void BuildAddContactRequest(Add_http_contacts::AddContactRequest *req)
29. {
30.     std::cout << "--------------新增联系人--------------" << std::endl;
31.     std::cout << "请输入联系人的姓名: ";
32.     std::string name;
33.     getline(std::cin, name);
34.     req->set_name(name);
36.     std::cout << "请输入联系人的年龄: ";
37.     int age;
38.     std::cin >> age;
39.     req->set_age(age);
40.     std::cin.ignore(256, '\n'); // 清除缓冲区所有内容，直到'\n'，把'\n'删除后结束，或者清除256个字节直接结束
42.     for (int i = 0;; i++)
43.     {
44.         std::cout << "请输入联系人的电话: " << i + 1 << "(只输入回车完成电话新增): ";
45.         std::string number;
46.         getline(std::cin, number);
47.         if (number.empty())
48.             break;
49.         // 接收add_phone返回的phone对象
50.         Add_http_contacts::AddContactRequest_Phone *phone = req->add_phone();
51.         phone->set_num(number);
53.         std::cout << "请输入联系人的电话类型:(0.移动电话, 1.固定电话): ";
54.         int type;
55.         std::cin >> type;
56.         std::cin.ignore(256, '\n');
57.         switch (type)
58.         {
59.         case 0:
60.             phone->set_type(Add_http_contacts::AddContactRequest_Phone_PhoneType::AddContactRequest_Phone_PhoneType_MP);
61.             break;
62.         case 1:
63.             phone->set_type(Add_http_contacts::AddContactRequest_Phone_PhoneType::AddContactRequest_Phone_PhoneType_TEL);
64.             break;
65.         default:
66.             std::cout << "输入有误, 请重新根据提示输入" << std::endl;
67.             break;
68.         }
69.     }
70. }
71. void AddContact()
72. {
73.     Client client(CONTACT_HOST, CONTACT_PORT);
74.     // 构建req对象
75.     Add_http_contacts::AddContactRequest req;
76.     BuildAddContactRequest(&req);
77.     // 序列化
78.     std::string req_str;
79.     if (!req.SerializeToString(&req_str))
80.     {
81.         std::string errstr = "AddContact时,序列化失败";
82.         throw ContactException(errstr);
83.     }
84.     // 发起post请求
85.     auto post = client.Post("/contacts/add", req_str, "application/protobuf");
86.     if (!post)
87.     {
88.         std::string err_str = "/contacts/add 链接失败,错误原因: ";
89.         err_str.append(httplib::to_string(post.error()));
90.         throw ContactException(err_str);
91.     }
93.     // 反序列化rsp
94.     Add_http_contacts::AddContactResponse resp;
95.     bool parse = resp.ParseFromString(post->body);
96.     if (post->status != 200 && !parse)
97.     {
98.         std::string err_str = "调用 /contact/add 失败 ";
99.         err_str.append(std::to_string(post->status))
100.             .append("(")
101.             .append(post->reason)
102.             .append(")");
103.         throw ContactException(err_str);
104.     }
105.     else if (post->status != 200)
106.     {
107.         std::string err_str = "调用 /contact/add 失败 ";
108.         err_str.append(std::to_string(post->status))
109.             .append("(")
110.             .append(post->reason)
111.             .append(")")
112.             .append("错误原因: ")
113.             .append(resp.error_desc());
114.         throw ContactException(err_str);
115.     }
116.     else if (!resp.success())
117.     {
118.         std::string err_str = "调用 /contact/add 结果异常 ";
119.         err_str.append("异常原因: ")
120.             .append(resp.error_desc());
121.         throw ContactException(err_str);
122.     }
123.     // 打印结果
124.     cout << "新增联系人成功" << "联系人id: " << resp.uuid() << endl;
125. }
127. int main()
128. {
129.     enum Option
130.     {
131.         Quit = 0,
132.         Add,
133.         Del,
134.         Findone,
135.         Findall
136.     };
137.     menu();
138.     cout << "---->请选择: ";
139.     int choose;
140.     cin >> choose;
141.     cin.ignore(256, '\n');
142.     try
143.     {
144.         switch (choose)
145.         {
146.         case Option::Quit:
147.             cout << "---->退出" << endl;
148.             return 1;
149.         case Option::Add:
150.             cout << "---->新增联系人" << endl;
151.             AddContact();
152.             break;
153.         case Option::Del:
154.             cout << "---->暂未实现" << endl;
155.             break;
156.         case Option::Findone:
157.             cout << "---->暂未实现" << endl;
158.             break;
159.         case Option::Findall:
160.             cout << "---->暂未实现" << endl;
161.             break;
162.         default:
163.             cout << "---->选择有误，请重新选择" << endl;
164.             break;
165.         };
166.     }
167.     catch (const ContactException &e)
168.     {
169.         cout << "--->出现错误, 错误原因是: " << e.What() << endl;
170.     }
171. }

复制代码

2.服务端

1.UUIDUtil类

1. #pragma once
2. #include <iostream>
3. #include <sstream>
4. #include <string>
5. #include <random>
6. #include <iomanip>
7. #include <atomic>
9. namespace ns_uuid
10. {
11.     class UUIDUtil
12.     {
13.     public:
14.         static std::string uuid()
15.         {
16.             // 生成机器随机数对象
17.             std::random_device rd;
18.             // 用mt算法，以机器随机数对象为种子生成伪随机数对象
19.             std::mt19937 generator(rd());
20.             // 构造限定数据范围的伪随机数
21.             std::uniform_int_distribution<int> distribution(0, 255);
22.             // ⽣成8个随机数，按照特定格式组织成为16进制数字字符的字符串
23.             std::stringstream ss;
24.             for (int i = 0; i < 8; i++)
25.             {
26.                 if(i == 4 || i == 6) ss << "-";
27.                 ss << std::setw(2) << std::setfill('0') << std::hex << distribution(generator);
28.             }
29.             ss << "-";
30.             // 定义⼀个8字节序号，逐字节组织成为16进制数字字符的字符串
31.             static std::atomic<int> a(0);
32.             // size_t 64个bit位
33.             size_t cur = a.fetch_add(1);
34.             for (int i = 7; i >= 0; i--)
35.             {
36.                 if(i == 5) ss << "-";
37.                 ss << std::setw(2) << std::setfill('0') << std::hex << ((cur >> (i*8)) & 0xFF);
38.             }
40.             return ss.str();
41.         }
42.     };
43. }

复制代码

2.server.cc

1. #include <iostream>
2. #include "add_contact.pb.h"
3. #include "ContactException.hpp"
4. #include <string>
5. #include "httplib.h"
6. #include "UUIDUtil.hpp"
8. using namespace httplib;
9. using namespace ns_uuid;
10. using std::cout;
11. using std::endl;
15. void PrintContacts(Add_http_contacts::AddContactRequest& request)
16. {
17.         std::cout << "联系人姓名：" << request.name() << std::endl;
18.         std::cout << "联系人年龄：" << request.age() << std::endl;
19.         for(int j = 0;j<request.phone_size();j++)
20.         {
21.             const Add_http_contacts::AddContactRequest_Phone phone = request.phone(j);
22.             std::cout << "联系人电话" << j+1  << ": "<< phone.num() << "   ";
23.             std::cout << "电话类型"  << ": ("<< AddContactRequest_Phone_PhoneType_Name(phone.type()) << ")" << std::endl;
24.         }
25. }
26. int main()
27. {
28.     Server server;
29.     server.Post("/contacts/add", [](const Request &req, Response &resp)
30.         {
31.             // 反序列化request : req.body
32.             Add_http_contacts::AddContactRequest request;
33.             Add_http_contacts::AddContactResponse response;
34.             try
35.             {
36.                 if (!request.ParseFromString(req.body))
37.                 {
38.                     throw ContactException("request反序列化失败");
39.                 }
41.                 //新增联系人，持久化存储——————这里只是实现打印
42.                 PrintContacts(request);
44.                 // 序列化response
45.                 response.set_success(true);
46.                
47.                 response.set_uuid(UUIDUtil::uuid());
48.                 std::string resp_str;
49.                 if (!response.SerializeToString(&resp_str))
50.                 {
51.                     throw ContactException("response序列化失败");
52.                 }
53.                 resp.status = 200;
54.                 resp.body = resp_str;
55.                 resp.set_header("Content-Type", "application/protobuf");
56.             }
57.             catch (const ContactException &e)
58.             {
59.                 resp.status = 500;
60.                 response.set_success(false);
61.                 response.set_error_desc(e.What());
62.                 std::string resp_str;
63.                 if (response.SerializeToString(&resp_str))
64.                 {
65.                     resp.body = resp_str;
66.                     resp.set_header("Content-Type", "application/protobuf");
67.                 }
68.             }
69.         });
71.     server.listen("0.0.0.0", 8888);
72.     return 0;
73. }

复制代码

3.总结

序列化协议	通⽤性	格式	可读性	序列化⼤ ⼩	序列化性能
JSON	通⽤（json、 xml已成为多种 ⾏业标准的编 写⼯具	⽂本格式	好	轻量（使 ⽤键值对 ⽅式，压 缩了⼀定 的数据空 间	中
XML	通用	⽂本格式	好	重量（数 据冗余， 因为需要 成对的闭 合标签	低
ProtoBuf	独⽴ （Protobuf只 是Google公司 内部的⼯具）	⼆进制格式	差（只能 反序列化 后得到真 正可读的 数据）	轻量（⽐ JSON更轻 量，传输 起来带宽 和速度会 有优化	高

   ⼩结：   

• XML、JSON、ProtoBuf都具有数据布局化和数据序列化的能⼒。
  
• XML、JSON更注意数据布局化，关注可读性和语义表达能⼒。ProtoBuf更注意数据序列化，关注
  

    服从、空间、速度，可读性差，语义表达能⼒不⾜，为包管极致的服从，会舍弃⼀部门元信息。    3. ProtoBuf的应⽤  场景更为明确，XML、JSON的应⽤  场景更为丰富。     protobuf 和 Json 的实验对比：   

• 编解码性能：ProtoBuf的编码解码性能，⽐JSON⾼出2-4倍。
  
• 内存占⽤：ProtoBuf的内存278，⽽JSON到达567，ProtoBuf的内存占⽤只有JSON的1/2。
  

    注：以上结论的数据只是根据该项实验得出。因为受差别的字段类型、字段个数等影响，测出的数据会有所差别。
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。