iOS CocoaAsyncSocket

环境：

下载AsyncSocket：

https://github.com/robbiehanson/CocoaAsyncSocket类库，将RunLoop文件夹下的AsyncSocket.h、AsyncSocket.m、 AsyncUdpSocket.h、 AsyncUdpSocket.m 文件拷贝到自己的project中

添加CFNetwork.framework, 再使用socket的文件头

#import<sys/socket.h>
#import<netinet/in.h>
#import<arpa/inet.h>
#import<unistd.h>

2、AsyncSocket详解

在实际开发中，主要的任务是开发客户端。所以下面主要详解客户端的整个连接建立过程，以及在说明时候回调哪些函数。

常用方法：

1、建立连接

- (int)connectServer:(NSString *)hostIP port:(int)hostPort

2、连接成功后，会回调的函数

- (void)onSocket:(AsyncSocket *)sock didConnectToHost:(NSString *)host port:(UInt16)port

3、发送数据

- (void)writeData:(NSData *)data withTimeout:(NSTimeInterval)timeout tag:(long)tag;

4、接受数据

-(void)onSocket:(AsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag

5、断开连接

- (void)onSocket:(AsyncSocket *)sock willDisconnectWithError:(NSError *)err
- (void)onSocketDidDisconnect:(AsyncSocket *)sock

主要就是上述的几个方法，只是说在真正开发当中，很可能我们在收发数据的时候，我们收发的数据并不仅仅是一个字符串包装成NSData即可，我们很可能会发送结构体等类型，这个时候我们就需要和服务器端的人员协作来开发：定义怎样的结构体。

3、使用方法详解

即时通讯最大的特点就是实时性，基本感觉不到延时或是掉线，所以必须对socket的连接进行监视与检测，在断线时进行重新连接，如果用户退出登录，要将socket手动关闭，否则对服务器会造成一定的负荷。

一般来说，一个用户（对于ios来说也就是我们的项目中）只能有一个正在连接的socket，所以这个socket变量必须是全局的，这里可以考虑使用单例或是AppDelegate进行数据共享，首选使用单例。如果对一个已经连接的socket对象再次进行连接操作，会抛出异常（不可对已经连接的socket进行连接）程序崩溃，所以在连接socket之前要对socket对象的连接状态进行判断。

使用socket进行即时通讯还有一个必须的操作，即对服务器发送心跳包，每隔一段时间对服务器发送长连接指令（指令不唯一，由服务器端指定，包括使用socket发送消息，发送的数据和格式都是由服务器指定），如果没有收到服务器的返回消息，AsyncSocket会得到失去连接的消息，我们可以在失去连接的回调方法里进行重新连接。

声明socket变量：

@property (nonatomic, strong) AsyncSocket *socket; // socket 
@property (nonatomic, copy ) NSString *socketHost; // socket的Host 
@property (nonatomic, assign) UInt16 socketPort; // socket的Port

//连接(长连接)
-(void)socketConnectHost;// socket连接

连接时host与port都是由服务器指定。

// socket连接
-(void)socketConnectHost{
    
    self.socket = [[AsyncSocket alloc] initWithDelegate:self];
    
    NSError *error = nil;
    
    [self.socket connectToHost:self.socketHost onPort:self.socketPort withTimeout:3 error:&error];
    
}

心跳

心跳通过计时器来实现

@property (nonatomic, retain) NSTimer *connectTimer; // 计时器

实现连接成功回调的方法，并在此方法中初始化定时器，定时向服务器发送一次请求，保持连接

#pragmamark - 连接成功回调
-(void)onSocket:(AsyncSocket *)sock didConnectToHost:(NSString *)host port:(UInt16)port {
    
    NSLog(@"socket连接成功");// 每隔30s像服务器发送心跳包
    
    self.connectTimer = [NSTimer scheduledTimerWithTimeInterval:30 target:self selector:@selector(longConnectToSocket) userInfo:nil repeats:YES];// 在longConnectToSocket方法中进行长连接需要向服务器发送的讯息
    
    [self.connectTimer fire];
    
}

断开连接：

失去连接有几种情况，服务器断开，用户主动cut，还可能有如QQ其他设备登录被掉线的情况，不管那种情况，我们都能收到socket回调方法返回给我们的讯息，如果是用户退出登录或是程序退出而需要手动cut，我们在cut前对socket的userData赋予一个值来标记为用户退出，这样我们可以在收到断开信息时判断究竟是什么原因导致的掉线

在.h文件中声明一个枚举类型

enum{
    SocketOfflineByServer,//服务器掉线，默认为0
    SocketOfflineByUser,//用户主动cut
};

定义并实现断开方法

// 切断socket
-(void)cutOffSocket{
    
    self.socket.userData = SocketOfflineByUser;// 声明是由用户主动切断

    [self.connectTimer invalidate];
    
    [self.socket disconnect];
    
}

重连

实现代理方法

-(void)onSocketDidDisconnect:(AsyncSocket *)sock {
    
    NSLog(@"sorry the connect is failure %ld",sock.userData);
    
    if(sock.userData == SocketOfflineByServer) {
        
        // 服务器掉线，重连

        [self socketConnectHost];
    
    } else if(sock.userData == SocketOfflineByUser) {
        
        // 如果由用户断开，不进行重连return;
        
    }
}

发送数据：

我们补充上文心跳连接未完成的方法

// 心跳连接

-(void)longConnectToSocket{
   
   // 根据服务器要求发送固定格式的数据，假设为指令@"longConnect"，但是一般不会是这么简单的指令NSString *longConnect = @"longConnect";
   
   NSData *dataStream = [longConnect dataUsingEncoding:NSUTF8StringEncoding];

   [self.socket writeData:dataStream withTimeout:1tag:1];
   
}

socket发送数据是以栈的形式存放，所有数据放在一个栈中，存取时会出现粘包的现象，所以很多时候服务器在收发数据时是以先发送内容字节长度，再发送内容的形式，得到数据时也是先得到一个长度，再根据这个长度在栈中读取这个长度的字节流，如果是这种情况，发送数据时只需在发送内容前发送一个长度，发送方法与发送内容一样，假设长度为8

NSData *dataStream = [[@8](http://my.oschina.net/u/147515)dataUsingEncoding:NSUTF8StringEncoding]; [self.socket writeData:dataStream withTimeout:1 tag:1];

接收数据：

为了能时刻接收到socket的消息，我们在长连接方法中进行读取数据

[self.socket readDataWithTimeout:30 tag:0];

如果得到数据，会调用回调方法：

-(void)onSocket:(AsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag {
    
    // 对得到的data值进行解析与转换即可
    
    [self.socket readDataWithTimeout:30tag:0];
    
}

【备注】关于NSData对象

无论SOCKET收发都采用NSData对象。

NSData主要是带一个(id)data指向的数据空间和长度 length。
NSString转换成NSData对象

NSData* xmlData = [@"testdata" dataUsingEncoding:NSUTF8StringEncoding];

NSData转换成NSString对象

NSData * data;
NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];