好久没写东西,最近在研究服务端框架Firefly和Pomelo,身为菜鸟的我的确花了很大功夫才看懂一些源代码。原来打算玩下Pomelo,不过我不得不说这东西真的是给专业开发者准备的,我搞了半天libpomelo也没顺利链接上服务器,光是链接服务器都那么难搞,更别说通讯了,我还能说什么呢……(真的是网络资料都翻遍了,真不知道其它人是怎么用的),官方示例里并没有简易代码,所以不适合像我这样的超级菜鸟使用,相比之下,Firefly更容易上手,有很多类型的源代码,简易通俗的和系统完整级的都有,认真研究的话真能学到不少东西……
因为官方给出的网络通讯协议示例里只有python的客户端源码,所以对于小白来说,可能不知道如何在cocos2d-x项目中的VC++里实现,这也算是一个添加的教程吧。还和以前一样,把研究出的东西记录下以备后用,希望对初学者也能有所帮助……
Firefly是开源游戏服务器框架,可以直接到九秒社区下载安装,这里不说安装过程了,我使用的是新版的gFirefly,这个也是可以在gitHub上下载到,安装会麻烦些,话说好久没更新了唉……难道最近都在忙CrossAPP项目?
cocos2d-x3.2需要使用VS2012,其具有C++11新特性,在使用线程上已经相当方便了,不再需要依赖于第三方的pthread
通常,在cocos2dx里使用的是http类的短链接通讯,不过我在这里要记录的是使用socket与服务端进行交互,在像linux这样的平台下,一般使用的都是BSD socket,这个当然不是第三方的插件,而是unix / linux系统里自带的,这也使用得跨平台使用也没什么问题,本例只是在windows上测试通过的代码,未在手机真机上测试过,不过应该差不多。
在Firefly的源代码里,一般可以看到都包含一个network的文件夹,里面有网络通讯使用的方法和类,算是一个打了个包,下面只是把里面最核心的代码拿出来修改使用:
socket最核心的三个方法就是:
connect() 用于链接服务器
send() 用于发消息到服务器
recv() 用于接收服务器返回的消息
本身使用上面的东西没什么难的,对于小白来说,真正需要了解的是Firefly的通讯协议,如果你在客户端发送的消息格式与Firefly的消息格式不一样,那Firefly会直接飞出一段英文,意思大概是“接收到一个非法包,没法识别”。所以这里需要了解一下Firefly的通讯协议。
在发送给Firefly服务端的消息中需要包含以下头部信息(这些在官方的教程里是有的):
class Message:public CCObject { public: char HEAD0; char HEAD1; char HEAD2; char HEAD3; char ProtoVersion; byte serverVersion[4]; byte length[4]; byte commandId[4]; /** * 消息的数据 */ char* data; Message(); int datalength(); ~Message(); };
上面一直到commandId的声明定义都是消息头,也就是协议头,这个协议头是用来识别消息的基础信息,像协议版本protoversion,整个消息包的长度length,命令号commandId(可以用来执行指定服务端功能函数的识别号)……data就是我们要传送的消息主体信息内容,上面是在客户端里定义的一个基于CCobject的消息对象。下面再看看服务端的,下面的代码取自游戏《烽烟OL》服务端源码,只要在copy到新建的Firefly项目中即可使用:
from gfirefly.server.globalobject import GlobalObject from gfirefly.netconnect.datapack import DataPackProtoc def callWhenConnLost(conn): dynamicId = conn.transport.sessionno GlobalObject().remote['gate'].callRemote("NetConnLost_2",dynamicId) print('一个链接已经断开') def CreatVersionResult(netversion): return netversion def doConnectionMade(conn): print('已成功建立一个链接') dataprotocl = DataPackProtoc(78,37,38,48,9,0) GlobalObject().netfactory.setDataProtocl(dataprotocl) GlobalObject().netfactory.doConnectionLost = callWhenConnLost GlobalObject().netfactory.doConnectionMade = doConnectionMade from gfirefly.server.globalobject import remoteserviceHandle from gfirefly.server.globalobject import netserviceHandle @netserviceHandle def echo_1(_conn,data): print(data) return data def echo_2(showtext): print(showtext); return showtext
其中下面这段就是用来自定义协议头的代码,分别对应于前面客户端上的定义的前6个参数,如果发送过来的包不是包含相同格式及对应信息时,则不会被服务端解析
dataprotocl = DataPackProtoc(78,0)
上面还定义了一个名为echo_1的函数,后面这个_1是Firefly用识别功能函数的ID,绝对不能重复,当我们从客户端发送消息时,如果指定commandId参数为1,则服务端在接收到这个消息时,会执行echo_1这个函数,执行完后的return用来把返回给客户端相应的数据,服务端的代码就算是这样完成了。
再看看消息构造函数,这个也是取自Firefly官方发布的游戏源代码:
Message* networkManager::constructMessage(const char* data,int commandId) { Message* msg = new Message(); msg->HEAD0=78; msg->HEAD1=37; msg->HEAD2=38; msg->HEAD3=48; msg->ProtoVersion=9; int a=0; msg->serverVersion[3]=(byte)(0xff&a);; msg->serverVersion[2]=(byte)((0xff00&a)>>8); msg->serverVersion[1]=(byte)((0xff0000&a)>>16); msg->serverVersion[0]=(byte)((0xff000000&a)>>24); int b=strlen(data)+4; msg->length[3]=(byte)(0xff&b);; msg->length[2]=(byte)((0xff00&b)>>8); msg->length[1]=(byte)((0xff0000&b)>>16); msg->length[0]=(byte)((0xff000000&b)>>24); int c=commandId; msg->commandId[3]=(byte)(0xff&c);; msg->commandId[2]=(byte)((0xff00&c)>>8); msg->commandId[1]=(byte)((0xff0000&c)>>16); msg->commandId[0]=(byte)((0xff000000&c)>>24); // str.append(msg->HEAD0); printf("%d",msg->datalength()); msg->data = new char[msg->datalength()]; memcpy(msg->data+0,&msg->HEAD0,1); memcpy(msg->data+1,&msg->HEAD1,1); memcpy(msg->data+2,&msg->HEAD2,1); memcpy(msg->data+3,&msg->HEAD3,1); memcpy(msg->data+4,&msg->ProtoVersion,1); memcpy(msg->data+5,&msg->serverVersion,4); memcpy(msg->data+9,&msg->length,4); memcpy(msg->data+13,&msg->commandId,4); memcpy(msg->data+17,data,strlen(data)); //memcpy(msg->data+position,bytes+offset,len); //msg->data = data; return msg; }上面的代码对消息从头到尾按次序进行了一次拼接封装,算是打包进data中,让其成为一个完整的数据包,最后返回消息对象。
bool networkManager::Connect() { mLock.lock(); //判断windows平台下初始链接初始化是否成功 if(Init()==-1){ return false; } //判断套接字是否创建成功 if(Create(AF_INET,SOCK_STREAM,0)==false){ return false; }; //设置socket为非阻塞模式 /*int retVal; unsigned long ul = 1; retVal=ioctlsocket(m_sock,FIONBIO,&ul); if(retVal==SOCKET_ERROR){ CCLOG("设置阻塞参数错误"); closesocket(m_sock); #ifdef WIN32 WSACleanup(); #endif }*/ //使用创建的套接字链接服务器 struct sockaddr_in svraddr; svraddr.sin_family = AF_INET; svraddr.sin_addr.s_addr = inet_addr(IP_ADDRESS); svraddr.sin_port = htons(IP_HOST); int ret = connect(m_sock,(struct sockaddr*) &svraddr,sizeof(svraddr)); if (ret == SOCKET_ERROR) { /*closesocket(m_sock); #ifdef WIN32 WSACleanup(); #endif*/ CCLOG("link Failed"); //链接成功后开始发送数据到服务器 //sendThread(); //recvThread(); return false; } //链接成功后开始发送数据到服务器 sendThread(); CCLOG("link successed"); mLock.unlock(); return true; }
可以看到上面链接代码的尾部已经加入执行了发送数据的函数,发送的实现代码其实很简单,下面是发送了一条"getSendMessage successful!"的信息给服务器,而如果服务器收到这个消息后,也会在log里输出这样一条消息的:
void networkManager::sendThread(){ Message* msg=constructMessage("getSendMessage successful!",1); //发消息 Send(msg->data,msg->datalength(),0); }
发送消息后,则可以开始监听接收服务端返回的数据了,下面只给出了基本代码,不包含数据解析,收到服务端返回的消息后可以看到LOG输出的信息:
void networkManager::RecvFunc(){ char recvBuf[17]; FD_ZERO(&fdRead); FD_SET(m_sock,&fdRead); mLock.lock(); struct timeval aTime; aTime.tv_sec = 5; aTime.tv_usec = 0; int ret = select(m_sock,&fdRead,NULL,&aTime); if (FD_ISSET(m_sock,&fdRead)) { CCLog("socket State=%d",ret); if(ret==1){ //先拿到时协议头数据,根据里面的信息判断应该调用哪些回调函数进行下一步数据处理 //while(true){ int getRevDataLength=recv(m_sock,recvBuf,17,0); if(getRevDataLength==17){ CCLOG("recvThread OK,getDataProcess=%d",getRevDataLength); }else{ CCLOG("The connect has terminated! revData is not completed!"); CCLOG("The ERROR CODE:%d",WSAGetLastError()); //closesocket(m_sock); } } }else{ CCLOG("select sock error"); } mLock.unlock(); } //执行接收线程 void networkManager::recvThread(){ //开启一条t2线程,入口函数为RecvFunc() std::thread t2(&networkManager::RecvFunc,this); t2.join(); }
最后执行代码后,可以在服务端上看到我们发送的消息,如下图
至此就算完成了一次与服务端的通讯会话。
由于我研究代码功能实现时有随意乱写代码的坏习惯,所以,源代码可能会有些多余和不符合标准的东西,请多包涵!VS2012的客户端项目源代码可到下面地址下载: