标题
c++中如何以服务器为消息转发跳板实现客户之间的TCP通讯
小编我呢最近在学习TCP通讯,作为一个软工人,竟然今天才真正学习了解,╭(╯^╰)╮。大学颓废的故事以后可以给大家讲讲。
具体而言就是利用TCP通讯技术实现了A客户与B客户以服务器为消息转发跳板进行信息通讯。
这里主要涉及到了以下知识点:
- 通讯协议的设计
- 客户端类的设计
- 服务器窗口类的设计
- 服务器类的设计
- 服务器端tcp套接字类的设计
这里需要解释下为什么关于服务器的类有三个。
- 第一个是服务器窗口类,这个类继承的是QWidget,这是个窗口组件,它将包含一个服务器类。
- 服务器类继承的是QTcpServer,这是qt库中关于tcp连接的服务器类。主要目的是管理客户端与自身的tcp连接。
- 服务器端tcp套接字类继承的是QTcpSocket,它主要负责单个TCP连接通路的服务器端的收发信息任务。
- 由于这里的设计是客户端只能与服务器端进行通讯,也就是说,在任意时刻客户端连接上的tcp通路只会有1个。然而服务器端并不是如此,它在任意时刻可以同时连接多个客户端,这就导致服务器端需要管理这些tcp通路。这也是为什么需要将服务器类重新抽象为3个类。
通讯协议的设计
通讯协议的设计分为:
- 协议数据单元的设计
- 数据单元类型的设计
- 创建数据单元的函数方法设计
协议数据单元就是指在tcp连接通路中进行传输的单个单位的数据。这个数据是有格式,一般而言分为数据总长度、数据内容等等,且通过结构体进行组织。以下就是一个协议数据单元的结构体。具体内部设计看业务需要,所以不需要一样。
// 协议数据单元 struct PDU { uint uiPDULen; // 一个协议数据单元的总长度,包括uiPDULen, uiMsgType, caData, uiMsgLen, caMsg的长度 uint uiMsgType; // 数据类型 char caData[64]; // 文件名 uint uiMsgLen; // 实际数据长度 int caMsg[]; // 实际数据 };
数据单元类型的设计,通过用枚举进行声明各式各样的数据单元类型
// 消息类型 enum ENUM_MSG_TYPE { ENUM_MSG_TYPE_MIN = 0x0, ENUM_MSG_TYPE_REGIST_REQUEST, // 注册请求 ENUM_MSG_TYPE_REGIST_RESPOND, // 注册回复 ENUM_MSG_TYPE_LOGIN_REQUEST, // 登录请求 ENUM_MSG_TYPE_LOGIN_RESPOND, // 登录回复 ENUM_MSG_TYPE_ONLINE_REQUEST, // 获取在线好友信息请求 ENUM_MSG_TYPE_ONLINE_RESPOND, // 在线好友信息回复 ENUM_MSG_TYPE_SEARCH_USR_REQUEST, // 搜索好友请求 ENUM_MSG_TYPE_SEARCH_USR_RESPOND, // 搜索好友回复 ENUM_MSG_TYPE_ADD_FRIEND_REQUEST, // 加好友请求 ENUM_MSG_TYPE_ADD_FRIEND_RESPOND, // 加好友回复 ENUM_MSG_TYPE_ADD_FRIEND_AGREE_REQUEST, // 同意加好友请求 ENUM_MSG_TYPE_ADD_FRIEND_AGREE_RESPOND, // 同意加好友回复 ENUM_MSG_TYPE_ADD_FRIEND_REJECT_REQUEST, // 拒绝加好友请求 ENUM_MSG_TYPE_ADD_FRIEND_REJECT_RESPOND, // 拒绝加好友回复 ENUM_MSG_TYPE_MAX = 0x00ffffff };
创建协议数据单元的函数方法设计如下:
PDU *mkPDU(uint uiMsgLen) { uint uiPDULen = sizeof(PDU) + uiMsgLen; PDU* pdu = (PDU*)malloc(uiPDULen); // 开辟一个uiPDULen个字节大小的空间 if (pdu == nullptr) { exit(EXIT_FAILURE); // 程序停止执行所有剩余的代码,释放分配的内存,关闭打开的文件(执行与之关联的清理动作),并通知操作系统进程已结束。 } memset(pdu, 0, uiPDULen); // 初始化从pdu地址开始之后的uiPDULen个字节空间,每个字节空间存放一个int类型的数字0 pdu->uiPDULen = uiPDULen; // PDU长度 pdu->uiMsgLen = uiMsgLen; // 数据实际长度 return pdu; }
客户端类的设计
客户端的功能如下:
- 建立连接
- 发送信息
- 接收信息
建立连接
this->m_tcpSocket.connectToHost(QHostAddress(this->m_strIP), this->m_usPort);
上述代码是用来建立客户端和服务器端的连接的,m_tcpSocket是QTcpSocket类的实例,m_strIP和m_usPort是要与之连接的服务器的ip地址和端口。
当连接建立后,该tcp连接对象m_tcpSocket将会发送一个 connected() 信号。我们可以用写一个通知连接成功的槽函数去和这个信号建立连接。
connect(&m_tcpSocket, SIGNAL(connected()), this, SLOT(showConnect()));
发送消息
m_tcpSocket.write((char*)pdu, pdu->uiPDULen);
上述代码就是用来在tcp连接中发送消息的,其中pdu是一个协议数据单元结构体的指针,pdu->uiPDULen是协议数据单元的数据大小,单位为字节,这句代码的具体含义是:将pdu所指向的uiPUDLen大小的空间中的数据传入tcp连接通路。
接收消息
为了及时捕获到套接字接收缓冲区中的数据,需要将接收数据的槽函数与readyRead()信号进行绑定。
补充下,当自己这边的套接字缓冲区收到对方发来的消息时会自动触发信号 readyRead()。
connect(&m_tcpSocket, SIGNAL(readyRead()), this, SLOT(recvMessage()));
recvMessage槽函数的功能是接收数据以及解析数据,以下述代码为例
qDebug() << m_tcpSocket.bytesAvailable(); // 查询套接字接收缓冲区中的字节数 uint uiPDULen = 0; m_tcpSocket.read((char*)&uiPDULen, sizeof(uint)); // 读取服务端发来的pdu总长度数据 qDebug() << uiPDULen; uint uiMsgLen = uiPDULen - sizeof(PDU); // 获取服务端发来的pdu中数据的实际长度 PDU* pdu = mkPDU(uiMsgLen); // 创建PDU,用来存储服务端发来的pdu中的实际数据 m_tcpSocket.read((char*)pdu + sizeof(uint), uiPDULen - sizeof(uint));
read函数中的第一个参数是保存读取出的数据的地址,第二个参数是要从套接字接收缓冲区中读取的字节数。
此外需要注意的是,当read函数读取一个数据后,读取指针就会前移到该数据的后一个位置。
要想完整无缺地读取出第一个协议数据单元,需要先获取它的长度,如下述代码。
m_tcpSocket.read((char*)&uiPDULen, sizeof(uint));
然后才能根据它的长度计算出实际数据的长度。注意:使用sizeof(PDU)可计算出不含任何实际数据的协议数据单元的大小
uint uiMsgLen = uiPDULen - sizeof(PDU);
接着创建一个PDU,用来存储读取到的协议数据单元中的实际数据
PDU* pdu = mkPDU(uiMsgLen);
接着使用read函数完整的读取一个协议数据单元。
m_tcpSocket.read((char*)pdu + sizeof(uint), uiPDULen - sizeof(uint));
(char*)pdu + sizeof(uint)表示从pdu指针的sizeof(uint)个偏移量开始保存数据,这是因为uiPDULen的数据不需要读取以及进行保存。
uiPDULen - sizeof(uint)表示协议数据单元除去uiPDULen后的字节数。
服务器窗口类的设计
服务器窗口类除了加载窗口这个主要功能以外,还有一个功能是监听tcp连接。
// QTcpServer对象监听是否有客户端正在连接本服务器的指定端口 MyTcpServer::getInstance().listen(QHostAddress(m_strIP), m_usPort);
m_strIP是服务器的ip地址,m_usPort是通讯端口
服务器类的设计
服务器类的主要目的是管理正在连接通讯的多个tcp连接,具体来说就是增加连接和删除连接。
void MyTcpServer::incomingConnection(qintptr socketDescriptor) { qDebug() << "new client connected"; // 客户端连接服务器端后,服务器需要记住该网络连接,而每个网络连接都有一个标识即socketDescriptor MyTcpSocket* pTcpSocket = new MyTcpSocket(); pTcpSocket->setSocketDescriptor(socketDescriptor); // 将服务器的一个套接字对象与网络连接标识进行绑定 m_tcpSocketList.append(pTcpSocket); connect(pTcpSocket, SIGNAL(offline(MyTcpSocket*)), this, SLOT(deleteSocket(MyTcpSocket*))); }
incomingConnection函数是QTcpServer的一个虚函数。当QTcpserver::listen函数有监听到有客户端正在请求连接后,就会自动响应该函数。
上述函数方法的最后一句代码是用来绑定offline信号和deleteSocket槽函数的。绑定之后,当offline的信号发出后,将会执行从m_tcpSocketList移除相关tcpSocket对象操作。
void MyTcpServer::deleteSocket(MyTcpSocket *mySocket) { QList<MyTcpSocket*>::iterator iter = m_tcpSocketList.begin(); for(; iter != m_tcpSocketList.end(); iter++) { if (mySocket == *iter) { (*iter) -> deleteLater(); *iter = nullptr; m_tcpSocketList.erase(iter); break; } } for (int i = 0; i < m_tcpSocketList.size(); i++) { qDebug() << m_tcpSocketList.at(i)->getName(); } }
除了上述管理tcp连接的功能外,服务器类还需要为客户端之间通讯做中转站。举个例子,客户端A发送一个消息给客户端B,需要经历下述过程:
- 客户端A与服务器构建tcp通路,服务器端用QTcpSocket对象socket1去负责接收来自客户端A的消息。
- 客户端B与服务器构建tcp通路,服务器端用QTcpSocket对象socket2去负责接收来自客户端B的消息。
- 消息被socket1接收到,然后消息被socket2发送出去。
void MyTcpServer::resend(const char *friendName, PDU *pdu) { if (friendName == nullptr || pdu == nullptr) { return; } QString strName = friendName; // char* 可通过=直接转QString for (int i = 0; i < m_tcpSocketList.size(); i++) { if (strName == m_tcpSocketList.at(i)->getName()) { m_tcpSocketList.at(i)->write((char*)pdu, pdu->uiPDULen); break; } } }
上述这个函数方法的第一个参数是客户端的名字,由于任意时刻单个客户端只能对应一个tcp连接,故可以用客户端的名字唯一标识一个tcp套接字连接对象。
它将在服务器tcp套接字类中被使用,使用的方式是调用服务器类的单例,然后调用这个方法,转发pdu。
服务器tcp套接字类
它负责的功能如下:
- 消息的接收和发送
- tcp连接断开的收尾操作
消息的接收和发送,依旧使用的是QTcpSocket::write() 和QTcpSocket::read()方法。
tcp连接断开的收尾操作的执行需要依赖对disconnect()信号的响应
connect(this, SIGNAL(disconnected()), this, SLOT(clientOffline()));
void MyTcpSocket::clientOffline() { char name[64] = {"\0"}; strcpy(name, m_name.toStdString().c_str()); OpeDB::getInstance().handleOffline(name); emit offline(this); }
备注:上述内容总结自b站的c++网盘项目