一、模型(生产者-消费者模式)
生产者-消费者模式
- 某个模块负责产生数据,这些数据由另一个模块来负责处理:
- 产生数据的模块,就形象地称为生产者
- 而处理数据的模块,就称为消费者
- 该模式还需要有一个缓冲区处于生产者和消费者之间,作为一个中介。生产者把数据放入缓冲区,而消费者从缓冲区取出数据
- 缓冲区的作用:
- 1.解耦,生产者和消费者只依赖缓冲区,而不相互依赖
- 2.支持并发和异步
二、代码总体介绍
- class EasyTcpServer保持不变:
- 作为生产者,主要用来接收客户端的连接,然后将客户端放入缓冲区中,不做数据的处理
- EasyTcpServer在初始化时,会在内部创建一个数组存储CellServer,用来表示本次会话有多少个消费者线程
- class ClientSocket保持不变:作为一个客户端的结构
- 新增一个class CellServer:
- 作为消费者,从缓冲区中查看是否有新客户端,如果有那么就将新客户端添加到自己的fd_set中进行select监听
- 每一个CellServer在内部保存一个INetEvent对象(见下面INetEvent概述)
- 新增一个class INetEvent:
- 作为一个网络事件接口,里面含有虚函数,让EasyTcpServer继承于该类
- 每一个CellServer在内部保存一个INetEvent对象,在初始化时将其所属的EasyTcpServer赋值给它,当CellServer有相关的网络事件时,调用INetEvent对象的相关网络事件接口
三、代码主要逻辑如下
分离客户端连接与消息处理业务
- 原先的代码是将每个客户端保存在EasyTcpServer的数组中,并且在EasyTcpServer::Onrun()函数中调用select对每个客户端进行数据监听
- 现在的代码为:
- 保持EasyTcpServer不变,作为生产者,其内部创建一个CellServer对象数组
- 但是客户端不在EasyTcpServer内存储了,创建一个新的class CellServer,作为消费者,其保存客户端的连接,并在CellServer::Onrun()函数中调用select对每个客户端进行数据监听
- EasyTcpServer只接收客户端的连接,接收到客户端的连接之后,将其传递给自己CellServer对象数组中的某一个CellServer对象进行管理
为消息处理线程添加新客户端缓冲队列
- class CellServer中有两个vector,一个名为_clients,存储客户端;另一个名为_clientsBuff,也存储客户端,但是其是一个“缓冲队列”
- EasyTcpServer中接收到新客户端之后,不将其保存在EasyTcpServer中,而是将其分配到CellServer的_clientsBuff缓冲队列中
- 之后CellServerCellServer::Onrun()函数中将_clientsBuff缓冲队列中的客户端移动到_clients中去
建立消息处理线程
- EasyTcpServer在EasyTcpServer::Start()函数中创建指定数量的CellServer消费者对象,然后调用CellServer.Start()函数
- 每个CellServer对象的Start()函数创建一个线程,线程的执行函数为自己的Onrun()函数
- Onrun()函数中调用select对每个客户端进行数据监听
将新客户端分配给客户端数量最少的消息线程
- EasyTcpServer::Accept()接收到一个新的客户端之后,调用EasyTcpServer::addClientToCellServer()将新的客户端加入到CellServer的_clientsBuff缓冲队列中
- 放入到CellServer的_clientsBuff缓冲队列中的时候,通过调用每个CellServer对象的getClientCount()函数,如果哪个CellServer对象所管理的客户端最少,那么就将这个新的客户端放入到哪个CellServer对象的_clientsBuff缓冲队列中
消息处理线程在无客户端时休眠1毫秒
- CellServer::Onrun()中如果_clients为空,那么说明无客户端,那么休眠一秒继续运行
为消息处理线程添加每秒收包计数
- 在EasyTcpServer中定义一个_recvCount变量,用来表示服务端接收到客户端数据包的数量
- _recvCount在EasyTcpServer::OnNetMsg()函数中被++
- CellServer::OnNetMessage()函数每收到一次消息,那么调用其绑定的EasyTcpServer对象的OnNetMsg()函数,将_recvCount++
- EasyTcpServer::Onrun()函数每执行一次,调用一次EasyTcpServer::time4msg()函数,EasyTcpServer::time4msg()函数统计_recvCount的信息并打印
事件通知,有客户端退出
- CellServer::Onrun()中调用CellServer::RecvData()与客户端进行数据交互,如果RecvData()返回-1,说明接收消息出错或者与客户端断开连接,那么将这个客户端从自己的_client数组中移除
- 并且调用自己所绑定的EasyTcpServer对象的OnClientLeave()函数,将_recvCount--
四、服务端完整代码如下
- 下面是服务端的完整代码EasyTcpServer.hpp,其包含的CELLTimestamp.hpp、MessageHeader.hpp头文件在前面的文章有定义(无变化)
#ifndef _EasyTcpClient_hpp_
#define _EasyTcpClient_hpp_
#ifdef _WIN32
#define FD_SETSIZE 10240
#define WIN32_LEAN_AND_MEAN
#define _WINSOCK_DEPRECATED_NO_WARNINGS //for inet_pton()
#define _CRT_SECURE_NO_WARNINGS
#include <windows.h>
#include <WinSock2.h>
#pragma comment(lib, "ws2_32.lib")
#else
#include <unistd.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <arpa/inet.h>
#include <netinet/in.h>
#include <sys/select.h>
//在Unix下没有这些宏,为了兼容,自己定义
#define SOCKET int
#define INVALID_SOCKET (SOCKET)(~0)
#define SOCKET_ERROR (-1)
#endif
#ifndef RECV_BUFF_SIZE
#define RECV_BUFF_SIZE 10240 //接收缓冲区的大小
#endif // !RECV_BUFF_SIZE
#include <iostream>
#include <string.h>
#include <stdio.h>
#include <vector>
#include <mutex>
#include <atomic>
#include <functional>
#include "MessageHeader.hpp"
#include "CELLTimestamp.hpp"
//using namespace std;
//客户端数据类型,用来封装一个客户端
class ClientSocket
{
public:
ClientSocket(SOCKET sockfd= INVALID_SOCKET) :_sock(sockfd), _lastPos(0) {
memset(_recvMsgBuff, 0, sizeof(_recvMsgBuff));
}
SOCKET sockfd() { return _sock; }
char *msgBuff() { return _recvMsgBuff; }
int getLastPos() { return _lastPos; }
void setLastPos(int pos) { _lastPos = pos; }
int SendData(DataHeader* header) {
if (header) {
return send(_sock, (const char*)header, header->dataLength, 0);
}
return SOCKET_ERROR;
}
private:
SOCKET _sock; //客户端socket
char _recvMsgBuff[RECV_BUFF_SIZE * 5]; //消息接收缓冲区
int _lastPos; //缓冲区的数据尾部位置
};
//网络事件接口
class INetEvent {
public:
virtual void OnClientJoin(ClientSocket* pClient) = 0; //客户端加入事件
virtual void OnClientLeave(ClientSocket* pClient) = 0; //客户端离开事件
virtual void OnNetMsg(ClientSocket* pClient, DataHeader* header) = 0; //接收到客户端消息事件
};
class CellServer
{
public:
CellServer(SOCKET sock = INVALID_SOCKET) :_sock(sock), maxSock(_sock), _pthread(nullptr), _pNetEvent(nullptr){
memset(_recvBuff, 0, sizeof(_recvBuff));
}
~CellServer() { CloseSocket(); }
public:
bool isRun() { return _sock != INVALID_SOCKET; }
void CloseSocket();
public:
size_t getClientCount() { return _clients.size() + _clientsBuff.size(); } //返回当前客户端的数量
void setEventObj(INetEvent* event) { _pNetEvent = event; } //设置事件对象,此处绑定的是EasyTcpServer
public:
bool Onrun();
void AddClient(ClientSocket* pClient) //讲客户端加入到客户端连接缓冲队列中
{
//自解锁
std::lock_guard<std::mutex> lock(_mutex);
//_mutex.lock(); 当然也可以使用互斥锁
_clientsBuff.push_back(pClient);
//_mutex.unlock();
}
int RecvData(ClientSocket* pClient); //接收数据
void OnNetMessage(ClientSocket* pClient, DataHeader* header);//处理网络消息
void Start() {
//启动当前服务线程
//创建一个线程,线程执行函数为Onrun(),其实可以不传递this,但是为了更安全,可以传递this给Onrun()
_pthread = new std::thread(std::mem_fn(&CellServer::Onrun), this);
}
private:
SOCKET _sock; //服务端的套接字
std::vector<ClientSocket*> _clients; //真正存储客户端
std::vector<ClientSocket*> _clientsBuff; //存储客户端连接缓冲队列,之后会被加入到_clients中去
SOCKET maxSock; //当前最大的文件描述符值,select的参数1要使用
char _recvBuff[RECV_BUFF_SIZE]; //接收缓冲区
std::mutex _mutex; //互斥锁
std::thread* _pthread; //当前子服务端执行的线程
INetEvent* _pNetEvent;
};
class EasyTcpServer:public INetEvent
{
public:
EasyTcpServer() :_sock(INVALID_SOCKET), _recvCount(0), _clientCount(0){}
virtual ~EasyTcpServer() { CloseSocket(); }
public:
void InitSocket(); //初始化socket
int Bind(const char* ip, unsigned short port); //绑定端口号
int Listen(int n); //监听端口号
SOCKET Accept(); //接收客户端连接
void addClientToCellServer(ClientSocket* pClient);//将新客户加入到CellServer的客户端连接缓冲队列中
void Start(int nCellServer); //创建从服务器,并运行所有的从服务器。(参数为从服务器的数量)
void CloseSocket(); //关闭socket
bool isRun() { return _sock != INVALID_SOCKET; } //判断当前服务端是否在运行
bool Onrun(); //处理网络消息
void time4msg(); //每1秒统计一次收到的数据包的数量
public:
//客户端加入事件
//这个是线程安全的,因为其只会被主服务器(自己)调用
virtual void OnClientJoin(ClientSocket* pClient)override { _clientCount++; }
//客户端离开事件,这个里面做的事情比较简单,只是将当前客户端的数量--(如果从服务器不止一个,那么此函数不是线程安全的,因为这个函数会被多个从服务器调用的)
virtual void OnClientLeave(ClientSocket* pClient)override { _clientCount--; }
//接收到客户端消息事件,将数据包的数量增加(如果从服务器不止一个,那么此函数不是线程安全的,因为这个函数会被多个从服务器调用的)
virtual void OnNetMsg(ClientSocket* pClient, DataHeader* header)override { _recvCount++; }
private:
SOCKET _sock; //服务端套接字
std::vector<CellServer*> _cellServers; //存放从服务端对象
CELLTimestamp _tTime; //计时器
std::atomic_int _recvCount; //表示服务端接收到客户端数据包的数量(这里采用一个原子操作,没什么特殊原因,使用玩玩罢了)
std::atomic_int _clientCount; //客户端的数量
};
void EasyTcpServer::InitSocket()
{
#ifdef _WIN32
WORD ver = MAKEWORD(2, 2);
WSADATA dat;
WSAStartup(ver, &dat);
#endif
//建立socket
_sock = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
if (INVALID_SOCKET == _sock) {
std::cout << "Server:创建socket成功" << std::endl;
}
else {
std::cout << "Server:创建socket成功" << std::endl;
}
}
int EasyTcpServer::Bind(const char* ip, unsigned short port)
{
if (!isRun())
InitSocket();
//初始化服务端地址
struct sockaddr_in _sin = {};
#ifdef _WIN32
if (ip)
_sin.sin_addr.S_un.S_addr = inet_addr(ip);
else
_sin.sin_addr.S_un.S_addr = INADDR_ANY;
#else
if (ip)
_sin.sin_addr.s_addr = inet_addr(ip);
else
_sin.sin_addr.s_addr = INADDR_ANY;
#endif
_sin.sin_family = AF_INET;
_sin.sin_port = htons(port);
//绑定服务端地址
int ret = ::bind(_sock, (struct sockaddr*)&_sin, sizeof(_sin));
if (SOCKET_ERROR == ret) {
if (ip)
std::cout << "Server:绑定地址(" << ip << "," << port << ")失败!" << std::endl;
else
std::cout << "Server:绑定地址(INADDR_ANY," << port << ")失败!" << std::endl;
}
else {
if (ip)
std::cout << "Server:绑定地址(" << ip << "," << port << ")成功!" << std::endl;
else
std::cout << "Server:绑定地址(INADDR_ANY," << port << ")成功!" << std::endl;
}
return ret;
}
void EasyTcpServer::CloseSocket()
{
if (_sock != INVALID_SOCKET)
{
#ifdef _WIN32
closesocket(_sock);
WSACleanup();
#else
close(_sock);
#endif
_sock = INVALID_SOCKET;
}
}
int EasyTcpServer::Listen(int n)
{
//监听网络端口
int ret = listen(_sock, n);
if (SOCKET_ERROR == ret)
std::cout << "Server:监听网络端口失败!" << std::endl;
else
std::cout << "Server:监听网络端口成功!" << std::endl;
return ret;
}
SOCKET EasyTcpServer::Accept()
{
//用来保存客户端地址
struct sockaddr_in _clientAddr = {};
int nAddrLen = sizeof(_clientAddr);
SOCKET _cSock = INVALID_SOCKET;
//接收客户端连接
#ifdef _WIN32
_cSock = accept(_sock, (struct sockaddr*)&_clientAddr, &nAddrLen);
#else
_cSock = accept(_sock, (struct sockaddr*)&_clientAddr, (socklen_t*)&nAddrLen);
#endif
if (INVALID_SOCKET == _cSock) {
std::cout << "Server:接收到无效客户端!" << std::endl;
}
else {
//通知其他已存在的所有客户端,有新的客户端加入
//NewUserJoin newUserInfo(static_cast<int>(_cSock));
//SendDataToAll(&newUserInfo);
//将新连接的客户端加入到从服务器的客户端缓冲队列中
ClientSocket* newClient = new ClientSocket(_cSock);
addClientToCellServer(newClient);
OnClientJoin(newClient); //相应客户端加入事件,其函数会将客户端的数量++
//std::cout << "Server:接受到新的客户端(" << _clients.size() << ")连接,IP=" << inet_ntoa(_clientAddr.sin_addr)
// << ",Socket=" << static_cast<int>(_cSock) << std::endl;
}
return _cSock;
}
void EasyTcpServer::addClientToCellServer(ClientSocket* pClient)
{
//在_cellServers中寻找,哪一个CellServer其处理的客户数量最少,那么就将新客户加入到这个CellServer对象中去
auto pMinServer = _cellServers[0];
for (auto pCellServer : _cellServers)
{
if (pMinServer->getClientCount() > pCellServer->getClientCount())
{
pMinServer = pCellServer;
}
}
pMinServer->AddClient(pClient);
}
void EasyTcpServer::Start(int nCellServer)
{
for (int i = 0; i < nCellServer; ++i)
{
auto ser = new CellServer(_sock);
_cellServers.push_back(ser);
ser->setEventObj(this);
ser->Start();
}
}
bool EasyTcpServer::Onrun()
{
if (isRun())
{
time4msg(); //统计当前接收到的数据包的数量
fd_set fdRead;
//fd_set fdWrite;
//fd_set fdExp;
FD_ZERO(&fdRead);
//FD_ZERO(&fdWrite);
//FD_ZERO(&fdExp);
FD_SET(_sock, &fdRead);
//FD_SET(_sock, &fdWrite);
//FD_SET(_sock, &fdExp);
struct timeval t = { 0,0 };
int ret = select(_sock + 1, &fdRead, nullptr, nullptr, &t);
if (ret < 0)
{
std::cout << "Server:select出错!" << std::endl;
//select出错,那么就不能再继续运行select,出错之后,调用CloseSocket(),
//关闭所有服务端、及客所有户端套接字,那么isRun()就会返回false,从而终止server.cpp程序运行
CloseSocket();
return false;
}
if (FD_ISSET(_sock, &fdRead))//如果一个客户端连接进来,那么服务端的socket就会变为可读的,此时我们使用accept来接收这个客户端
{
FD_CLR(_sock, &fdRead);
Accept();
return true;
}
return true;
}
return false;
}
void EasyTcpServer::time4msg()
{
auto t = _tTime.getElapsedSecond();
if (t >= 1.0)
{
//recvCount为什么要除以t1:因为我们要每1秒钟打印一次接收到的数据包,如果这个函数调用的时候时间差大于1秒,那么可以将recvCount/t,获得比较平均的数据包数量
printf("time<%lf>,thread numer<%d>,client number<%d>,recvCount<%d>\n",
t, _cellServers.size(), static_cast<int>(_clientCount), static_cast<int>((_recvCount / t)));
_recvCount = 0;
_tTime.update();
}
}
void CellServer::CloseSocket()
{
if (_sock != INVALID_SOCKET)
{
#ifdef _WIN32
//将所有的客户端套接字关闭
for (int n = (int)_clients.size() - 1; n >= 0; --n)
{
closesocket(_clients[n]->sockfd());
delete _clients[n];
}
//关闭服务端套接字
closesocket(_sock);
//因为这是从服务器,所以就不要清理套接字环境了,放置主服务器的套接字环境被清除
//WSACleanup();
#else
for (int n = (int)_clients.size() - 1; n >= 0; --n)
{
close(_clients[n]->sockfd());
delete _clients[n];
}
close(_sock);
#endif
_clients.clear();
_sock = INVALID_SOCKET;
delete _pthread;
}
}
bool CellServer::Onrun()
{
while (isRun())
{
//如果客户端缓冲队列_clientsBuff中有新客户,那么就将其加入到_clients中
if (_clientsBuff.size() > 0)
{
//自解锁lock_guard,作用域结束后自动释放锁,因此if执行结束之后,_mutex就被释放了
std::lock_guard<std::mutex> lock(_mutex);
for (auto pClient : _clientsBuff)
{
_clients.push_back(pClient);
}
_clientsBuff.clear();
}
//如果没有客户,那么休眠一秒然后继续下一次循环
if (_clients.empty())
{
std::chrono::milliseconds t(1);
std::this_thread::sleep_for(t);
continue;
}
fd_set fdRead;
FD_ZERO(&fdRead);
//在主线程的select中已经对主服务端的_sock进行查询了,所以从服务器就不需要了。否则两个地方同时操作会出错
//FD_SET(_sock, &fdRead);
for (int n = (int)_clients.size() - 1; n >= 0; --n)
{
FD_SET(_clients[n]->sockfd(), &fdRead);
if (maxSock < _clients[n]->sockfd())
maxSock = _clients[n]->sockfd();
}
//从服务器一般只用来收取数据,所以这里设置为阻塞的也可以
//struct timeval t = { 1,0 };
int ret = select(maxSock + 1, &fdRead, nullptr, nullptr, nullptr);
if (ret < 0)
{
std::cout << "Server:select出错!" << std::endl;
CloseSocket();
return false;
}
//遍历vector数组中所有的客户端套接字,如果某个客户端的套接字在读集中,
//那么说明相应的客户端有数据来,那么就执行processor()函数
for (int n = (int)_clients.size() - 1; n >= 0; --n)
{
if (FD_ISSET(_clients[n]->sockfd(), &fdRead))
{
if (-1 == RecvData(_clients[n]))
{
//如果RecvData出错,那么就将该客户端从_client中移除
auto iter = _clients.begin() + n;
if (iter != _clients.end())
{
if (_pNetEvent)
_pNetEvent->OnClientLeave(_clients[n]); //通知主服务器有客户端退出
delete _clients[n];
_clients.erase(iter);
}
}
}
}
}
return false;
}
int CellServer::RecvData(ClientSocket* pClient)
{
int _nLen = recv(pClient->sockfd(), _recvBuff, RECV_BUFF_SIZE, 0);
if (_nLen < 0) {
//std::cout << "recv函数出错!" << std::endl;
return -1;
}
else if (_nLen == 0) {
//std::cout << "客户端<Socket=" << pClient->sockfd() << ">:已退出!" << std::endl;
return -1;
}
memcpy(pClient->msgBuff() + pClient->getLastPos(), _recvBuff, _nLen);
pClient->setLastPos(pClient->getLastPos() + _nLen);
while (pClient->getLastPos() >= sizeof(DataHeader))
{
DataHeader* header = (DataHeader*)pClient->msgBuff();
if (pClient->getLastPos() >= header->dataLength)
{
//剩余未处理消息缓冲区的长度
int nSize = pClient->getLastPos() - header->dataLength;
//处理网络消息
OnNetMessage(pClient, header);
//处理完成之后,将_recvMsgBuff中剩余未处理部分的数据前移
memcpy(pClient->msgBuff(), pClient->msgBuff() + header->dataLength, nSize);
pClient->setLastPos(nSize);
}
else {
//消息缓冲区剩余数据不够一条完整消息
break;
}
}
return 0;
}
void CellServer::OnNetMessage(ClientSocket* pClient, DataHeader* header)
{
//调用主服务OnNetMsg事件
_pNetEvent->OnNetMsg(pClient, header);
switch (header->cmd)
{
case CMD_LOGIN: //如果是登录
{
//Login *login = (Login*)header;
//std::cout << "服务端:收到客户端<Socket=" << pClient->sockfd() << ">的消息CMD_LOGIN,用户名:" << login->userName << ",密码:" << login->PassWord << std::endl;
//此处可以判断用户账户和密码是否正确等等(省略)
//返回登录的结果给客户端
LoginResult ret;
pClient->SendData(&ret);
}
break;
case CMD_LOGOUT: //如果是退出
{
//Logout *logout = (Logout*)header;
//std::cout << "服务端:收到客户端<Socket=" << pClient->sockfd() << ">的消息CMD_LOGOUT,用户名:" << logout->userName << std::endl;
//返回退出的结果给客户端
LogoutResult ret;
pClient->SendData(&ret);
}
break;
default: //如果有错误
{
//std::cout << "服务端:收到客户端<Socket=" << pClient->sockfd() << ">的未知消息消息" << std::endl;
//返回错误给客户端,DataHeader默认为错误消息
DataHeader ret;
pClient->SendData(&ret);
}
break;
}
}
#endif