protobuf简介

Protocol Buffers（简称 Protobuf）是一种轻便高效的序列化数据结构的协议，由 Google 开发。它可以用于将结构化数据序列化到二进制格式，并广泛用于数据存储、通信协议、配置文件等领域。我们的逻辑是有类等抽象数据构成的，而tcp是面向字节流的，我们需要将类结构序列化为字符串来传输。

下载protobuf安装包

官方下载地址 https://github.com/protocolbuffers/protobuf/releases

选择zip文件下载即可

因为官网下载速度较慢，我把下载好的protobuf存在网盘里了 https://pan.baidu.com/s/1Yg9Usdc3T-CYhyr9GiePCw?pwd=ng6x

验证码ng6x

下载完后解压即可，我放在D盘cppsoft文件夹下

下载cmake

CMake是一个跨平台的开源构建工具，可以用于自动化构建、测试和打包C++代码。与其他构建工具相比，CMake的优点之一是它的配置文件具有可读性和可维护性，而且支持多种编译器、操作系统和构建工具。

使用CMake，您可以将C++项目的配置和生成分离开来，从而使其更加可重复，并且可以在不同的平台上进行构建和测试。CMake使用类似于脚本语言的语法来描述构建过程，并生成适用于各种构建系统的构建文件（例如Makefile、Visual Studio解决方案等）。

以下是CMake的一些功能：

自动生成包含目录、库和源文件列表的Makefile
支持多种编译器和操作系统
可以自动生成安装程序和打包文件
跨平台支持
CMakeLists.txt 配置文件编写简单，易于维护

总之，CMake是一个强大的构建工具，可以大大简化C++项目的构建过程，并提高可移植性和可重复性。如果您正在寻找一个跨平台的自动构建工具来构建您的C++代码，请考虑使用CMake。

我们要在windows上生成protobuf对应的库，就需要用到cmake。官方下载地址https://cmake.org/download/，选择Windows Source下载。由于官方下载较慢，可以去我的网盘下载 https://pan.baidu.com/s/1Yg9Usdc3T-CYhyr9GiePCw?pwd=ng6x

编译protobuf

在protobuf中创建一个文件夹，名字叫做visualstudio，你可以叫其他的名字,如下图然后我们打开刚才下载的cmake桌面程序,点击后 source code 选择protobuf源码路径下的cmake目录 build binaries目录选择我们刚刚创建的visualstudio目录生成选项可以依据自己要求生成。点击config，再点击generate就可以生成了。生成后我们可以看到protobuf的visualstudio文件夹内生成了.sln文件。双击.sln文件，我的是默认用visual studio2019打开可以单独选择libprotobuf编译，也可以选择All Build编译编译时可以选择debug和release，建议每一个都编译一遍，这样就有debug和release两个版本的库了。我选择的是X64位的debug模式编译，生成的库在visualstudio目录下的Debug文件夹里。可以看到我们生成了protobuf相关的lib库和dll库，一个是静态类型的，一个是动态类型的。接下来我创建一个新的文件夹D:\cppsoft\protoc 然后在该文件夹内创建一个bin文件夹(用来存储刚才protobuf生成的库)和include文件夹(用来存储protobuf的头文件) 将libprotobufd.lib和libprotocd.lib，以及protoc.exe拷贝到bin目录下，当然为了偷懒，可以将刚才Debug目录下的所有内容都拷贝到bin目录也可以。将protobuf文件夹下src文件夹里的google文件夹及其内容拷贝到protoc的include文件夹将编译目录的google文件夹拷贝到protoc的include文件夹到此为止，我们protobuf的库生成工作就完成了。因为我们要用到protoc命令，所以要将该命令配置到环境变量，在系统环境变量里添加一个环境变量PROTOBUF_HOME, 设置它的值为D:\cppsoft\protoc\bin 然后将该值添加到系统的path路径即可,格式为%PROTOBUF_HOME% 这样我们就可以直接使用protoc.exe了。

visual stuido配置protobuf

我们新建一个控制台项目，在项目属性中，配置选择Debug，平台选择X64，选择VC++目录，在包含目录中添加 D:\cppsoft\protoc\include 在库目录中添加 D:\cppsoft\protoc\bin

在链接器的输入选项中添加protobuf用到的lib库

libprotobufd.lib
libprotocd.lib

到此，visual studio 的protobuf配置完毕。

生成pb文件

要想使用protobuf的序列化功能，需要生成pb文件，pb文件包含了我们要序列化的类信息。我们先创建一个msg.proto，该文件用来定义我们要发送的类信息

syntax = "proto3";
message Book
{
   string name = 1;
   int32 pages = 2;
   float price = 3;
}

这个文件定义了一个名为Book的消息类型，包含三个字段：name、pages和price。其中每个字段都有一个数字标识符，用于标识该字段在二进制流中的位置。我们使用protoc.exe 基于msg.proto生成我们要用的C++类在proto所在文件夹执行如下命令

protoc --cpp_out=. ./msg.proto

--cpp_out= 表示指定要生成的pb文件所在的位置 ./msg.proto 表示msg.proto所在的位置，因为我们是在msg.proto所在文件夹中执行的protoc命令,所以是当前路径即可。执行后，会看到当前目录生成了msg.pb.h和msg.pb.cc两个文件，这两个文件就是我们要用到的头文件和cpp文件。我们将这两个文件添加到项目里，然后在主函数中包含msg.pb.h，做如下测试

#include <iostream>
#include "msg.pb.h"
int main()
{
    Book book;
    book.set_name("CPP programing");
    book.set_pages(100);
    book.set_price(200);
    std::string bookstr;
    book.SerializeToString(&bookstr);
    std::cout << "serialize str is " << bookstr << std::endl;
    Book book2;
    book2.ParseFromString(bookstr);
    std::cout << "book2 name is " << book2.name() << " price is " 
        << book2.price() << " pages is " << book2.pages() << std::endl;
    getchar();
}

上面的demo中将book对象先序列化为字符串，再将字符串反序列化为book2对象。这样就是visual studio 配置和使用protobuf的方法。

在网络中的应用

先为服务器定义一个用来通信的proto

syntax = "proto3";
message MsgData
{
   int32  id = 1;
   string data = 2;
}

id代表消息id，data代表消息内容我们用protoc生成对应的pb.h和pb.cc文件将proto,pb.cc,pb.h三个文件复制到我们之前的服务器项目里并且配置。

我们修改服务器接收数据和发送数据的逻辑当服务器收到数据后，完成切包处理后，将信息反序列化为具体要使用的结构,打印相关的信息，然后再发送给客户端

    MsgData msgdata;
    std::string receive_data;
    msgdata.ParseFromString(std::string(_recv_msg_node->_data, _recv_msg_node->_total_len));
    std::cout << "recevie msg id  is " << msgdata.id() << " msg data is " << msgdata.data() << endl;
    std::string return_str = "server has received msg, msg data is " + msgdata.data();
    MsgData msgreturn;
    msgreturn.set_id(msgdata.id());
    msgreturn.set_data(return_str);
    msgreturn.SerializeToString(&return_str);
    Send(return_str);

同样的道理，客户端在发送的时候也利用protobuf进行消息的序列化，然后发给服务器

    MsgData msgdata;
    msgdata.set_id(1001);
    msgdata.set_data("hello world");
    std::string request;
    msgdata.SerializeToString(&request);

总结

本文介绍了visual studio如何配置并使用protobuf，以及在服务器通信中的使用源码链接https://gitee.com/secondtonone1/boostasio-learn

visual studio配置protobuf