iOS-GCDAsyncSocket的使用

GCDAsyncSocket是第三方库CocoaAsyncSocket其中的一个类，用于建立可靠的TCP连接。如果想建立UDP连接，可以用GCDAsyncUDPSocket。

用Cocoapods导入GCDAsyncSocket：（Podfile文件中添加下面这句就可以了）

pod 'CocoaAsyncSocket', '7.4.1'

1、创建Socket、并连接

//_connectStatus为socket的连接状态
if (_connectStatus == DDSocketConnectStatusConnected){
        return;
    }
    
    if (self.socket == nil) {
//创建socket
        self.socket = [[GCDAsyncSocket alloc] initWithDelegate:self delegateQueue:dispatch_get_main_queue()];
    }

    NSError *error = nil;
//设置socket的链接地址，并连接服务器（host是主机地址，port是端口号）
    [self.socket connectToHost:host onPort:port withTimeout:timeout error:&error];
    _connectStatus = DDSocketConnectStatusConnecting;

2、连接成功的回调

如果建连成功之后，会收到socket成功的回调，在里面你可以做一些事情，我是做了心跳的处理。

/**
 当成功连接上,该方法会立刻返回
 @param sender socket套接字
 @param host 主机地址
 @param port 端口地址
 */
- (void)socket:(GCDAsyncSocket *)sender didConnectToHost:(nonnull NSString *)host port:(uint16_t)port
{
    DDLog(@"Socket连接成功 host: %@", host);
    _connectStatus = DDSocketConnectStatusConnected;
    _faliedCount = 0;
    //释放重连定时器
    [self invalidateReconnect];
    //初始化发送心跳的定时器
    [self resumeHeartBeat];
    //通信的首个数据包 - 拆包
    [self clientSocketReadData];
    //连接成功回调
    [self onnectedSocketSucess:YES];
}

3、连接失败的回调

如果连接失败，就会回调下面的方法，一般会在里面做重连socket的操作，需要涉及到重连的时间和次数。

/**
 连接失败,该方法会立刻返回
 @param sock socket套接字
 @param err 连接失败的错误回调
 */
- (void)socketDidDisconnect:(GCDAsyncSocket*)sock withError:(nullable NSError *)err
{
//未连接的状态下进行重连
    if (_connectStatus != DDSocketConnectStatusDisconnected || !_socket) {
        return;
    }
    //重连次数判断
    if (_faliedCount < 0 || _faliedCount >= kBeatLimit) {
        [self invalidateReconnect];
        [self resetSocketStatus];
        
        return;
    }
    
    _faliedCount++;
    DDLog(@"重连次数：%ld",(long)_faliedCount);
    
    if (_reconnectTimer == nil) {
        _reconnectTimer =  [NSTimer scheduledTimerWithTimeInterval:3.0 target:self selector:@selector(connectSocket) userInfo:nil repeats:YES];
        _reconnectTimer.fireDate = [NSDate distantPast];  //启动reconnectTimer
    }
}

4、向服务端发送数据

这一步是建立在socket已经建连的基础上，socket连接成功后，你需要向服务端发送数据时，调用下面方法：

[self.socket writeData:requestData withTimeout:-1 tag:0];

下面是你向服务端发送数据成功的回调方法：

/**
 消息发送成功

 @param sock socket套接字
 @param tag
 */
- (void)socket:(GCDAsyncSocket *)sock didWriteDataWithTag:(long)tag {
    DDLog(@"tcp 消息发送成功");
}

5、接受服务端的数据

这一步是建立在socket已经建连的基础上，socket连接成功后，服务器向你发送数据后，会调用下面方法：

/**
 接收消息的回调方法

 @param sock socket套接字
 @param data 接收到的二进制数据
 @param tag 消息任务的类型, 可以自定义 , 根据定义可以判断本次连接的类型
 */
- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag
{
    [self.cachedResponseData appendData:data];
    [self handleReceivedData:self.cachedResponseData];
}

6、断开连接

[self.socket disconnect];

socket开发中需要注意

在开发中前端和后端会约定一个固定的数据（消息）格式，按照这个格式来读取数据，就能把每组数据划分出来，也就较好的解决了 粘包 掉包 的问题，数据不完整时也能获知数据的缺失。

在开发中前端和后端会约定一个固定的数据（消息）格式，按照这个格式来读取数据，就能把每组数据划分出来，也就较好的解决了 粘包 掉包 的问题，数据不完整时也能获知数据的缺失。
比如，下面是一个表格，为规定好的消息格式：

屏幕快照 2018-05-24 下午8.22.12.png

注：以上的消息格式分成3块，数据和校验符在这里称为身体部分
1.消息头部：起始符 + 目标地址 + 原地址 + 数据长度 = 7Byte，（头部包含了那么多信息，并且长度是固定的，所以我们接收消息的时候，要先从头部开始入手）
2.消息体：要发送或者接收到的数据，长度为dataLength
3.校验符：用来检验接收的数据是否完整一致（开发中可能没有）

下面是数据返回，处理粘包 掉包问题：

//包返回状态
typedef NS_ENUM(NSInteger, DDSocketReturnDataStatus) {
    DDSocketReturnDataStatusSucceed              = 1,      // 完美返回一个完整包的数据
    DDSocketReturnDataStatusNoHead               = 2,      // 包头不匹配或者不存在(舍弃操作,不处理)
    DDSocketReturnDataStatusHeadNoFrist          = 3,      // 包头存在但是不在第一个索引位
    DDSocketReturnDataStatusNoComplete           = 4,      // 不满足基础数据长度(需要等待继续返回)
    DDSocketReturnDataStatusLessProtocolBuffers  = 5,      // protocolBuffers数据与长度小于返回长度 (需要等待继续返回)
    DDSocketReturnDataStatusMoreProtocolBuffers  = 6,      // protocolBuffers数据与长度大于返回长度
};

/**
 处理包以及返回的方法，根据宝返回数据的长度，判断状态，做相应处理

 @param indexData 本次连接 接收到的二进制数据
 */
- (void)handleReceivedData:(NSData *)indexData
{
    NSUInteger tempFirstHeaderIndex = 0;
    SInt32 tempFirstDataCount = 0;
    DDSocketReturnDataStatus returnDataStatus = [GCDAsynSocketModel validationDataPacket:self.cachedResponseData firstHeaderIndex:&tempFirstHeaderIndex firstDataLength: &tempFirstDataCount];
    //记录上一次包头位置(粘包时使用)
    self.firstHeaderIndex = tempFirstHeaderIndex;
    //记录上一次数据的长度(粘包时使用)
    self.firstDataCount = tempFirstDataCount;

    switch (returnDataStatus) {
        case DDSocketReturnDataStatusSucceed:
        {
            [self didJustReceivedWholeDataPackage];
        }
            break;
            
        case DDSocketReturnDataStatusLessProtocolBuffers:
        case DDSocketReturnDataStatusNoComplete:
        {
            [self clientSocketReadData];
        }
            break;
        
        case DDSocketReturnDataStatusNoHead:
        {
            [self clientSocketReadData];
        }
            break;
        
        case DDSocketReturnDataStatusHeadNoFrist:
        {
            [self resetPackageHeaderLocation];
        }
            break;
        
        case DDSocketReturnDataStatusMoreProtocolBuffers:
        {
            [self extractWholeDataPackage];
        }
            break;
    
    }
}