iOS基础之GCDAsyncSocket

蔚弘量

2023-12-01

前言

最近工作需要接触了iOS网络通信这一块内容，用的是github上的一个第三方库：GCDAsyncSocket。这篇文章记录了我在学习这个第三方库过程中的一些理解和体会

正文

服务器

服务器所需的socket

需要一个服务器的socket，用来监听客户端
还需要一个记录客户端socket的集合，使用这个集合中的socket能够实现与客户端通信（下面只用一个clientSocket表示这个集合）

important note :客户端发起连接请求并3次握手以后，ServerSocketManager自动回调服务器端的- (void)socket:(GCDAsyncSocket )sock didAcceptNewSocket:(GCDAsyncSocket )newSocket 方法， clientSocket就是这里的newSocket

@interface ServerSocketManager() <GCDAsyncSocketDelegate>
@property(strong,nonatomic) GCDAsyncSocket* serverSocket;
@property(strong,nonatomic) GCDAsyncSocket* clientSocket;
@end

- (void)socket:(GCDAsyncSocket *)sock didAcceptNewSocket:(GCDAsyncSocket *)newSocket {
    [self.clientSocket disconnect];
    self.clientSocket = newSocket; //使用这个newSocket和client通信，客户端方自己也有一个socket与服务器通信，这俩你个socket的建立通信通道是同一个的
    self.display.text = [self.display.text stringByAppendingString:@"成功和一个客户端建立连接\n"];

}

监听端口

服务器监听端口以后，就可以随时等待客户端连接了。一旦有客户端成功连接进来，那么会触发委托GCDAsyncSocketDelegate里面的didAcceptNewSocket 方法

 - (IBAction)listening:(id)sender {
    //[self disconnect]; 如果使用这行代码，那么导致下面监听失败，因为serverSocket为nil
    [self.serverSocket disconnect];
    NSError *error = nil;
    BOOL result = [self.serverSocket acceptOnPort:[self.serverPort.text intValue] error:&error];
    if(result && !error) {
        self.display.text = [self.display.text stringByAppendingFormat:@"%@端口正在监听\n",self.serverPort.text];
    }else {
        self.display.text = [self.display.text stringByAppendingFormat:@"%@端口监听失败，错误为:%@\n",self.serverPort.text,error];
    }
}

important note: 一定有这样的疑问：

客户端如何和服务器通信？客户端需要一个socketA，并且做操作[self.clientSocket connectToHost:self.serverIp.text onPort:[self.serverPort.text intValue] error:&err]。这时候会经历3次握手，如果成功以后，会在服务器端触发委托GCDAsyncSocketDelegate里面的didAcceptNewSocket 方法，客户端A与服务器通信只需要这个socketA就可以了

服务器端如何和客户端通信？ client A 使用connectToHost: onPort:error连接到服务器以后，服务器会保留这里的newSocket（如保存到self.clientSocket，以后需要和A通信，那么从内存获取这个newSocket，然后使用[self.clientSocket writeData:sendContent withTimeout:-1 tag:1];发消息给客户端。

向客户端写数据

使用 writeData:withTimeout:tag 方法向客户端写数据，这里的clientSocket是监听到客户端连进来时产生的socket

- (IBAction)sendMsgToServer:(id)sender {
    NSData* sendContent = [_content.text dataUsingEncoding:NSUTF8StringEncoding];
    [self.clientSocket writeData:sendContent withTimeout:-1 tag:1];
}

读取客户端数据

在后面着重介绍一下socket读数据以及GCDAsyncSocketDelegate委托中的方法，它们真的真的很容易让人迷惑

- (IBAction)obtainInfo:(id)sender {
    [self.clientSocket readDataWithTimeout:-1 tag:0];
}

客户端

客户端所需的socket

只需要一个socket,用来与服务器通信

- (void)viewDidLoad {
    self.clientSocket = [[GCDAsyncSocket alloc] initWithDelegate:self delegateQueue:dispatch_get_main_queue()];
}

连接服务器

这里需要指明服务器的iP和服务器所开发监听的端口

- (IBAction)connectToServer:(id)sender {
    [self.clientSocket disconnect];
    NSError *err = nil;
    if (![self.clientSocket connectToHost:self.serverIp.text onPort:[self.serverPort.text intValue] error:&err]) 
    {
        self.display.text = self.display.text = [self.display.text stringByAppendingFormat:@"%@\n",@"连接服务器失败"];
       return;
    }
}

给服务器发消息

- (IBAction)sendMsgToServer:(id)sender {
    NSData* sendContent = [_content.text dataUsingEncoding:NSUTF8StringEncoding];
    [self.clientSocket writeData:sendContent withTimeout:-1 tag:1];
}

读取服务器传递的消息

- (IBAction)obtainInfo:(id)sender {
    [self.clientSocket readDataWithTimeout:-1 tag:0];
}

important note: 上面的介绍服务端、客户端的写法不会让人迷惑，只要有文档，有例子就能很好的理解。想要全面了解，就去github上看详细文档GCDAsyncSocket在gitHub上的文档，我在学习过程中，让我非常迷惑的是它的代理方法，下面的部分开始详细介绍一下这些方法

GCDAsyncSocketDelegate代理方法

No1.- (void)socket:(GCDAsyncSocket )sock didReadData:(NSData )data withTag:(long)tag
这个代理方法什么时候触发？我最开始以为只要服务器传递过来的数据到本机了就会调用，然而不是这样的。GCDAsyncSocket有两个读取数据的方法，readDataToLength 、readDataToData。只有调用他们了，才会去内存的栈中读取服务器发送的数据，并且触发调用didReadData方法
important note:gitHub上的文档也有说明这点，socket发送数据的时候，会分成很多piece数据然后传送给指定目标，送达时这些内容会放到目标内存的一个栈里面（tcp：自己会解决传递顺序，重传，如何避免堵塞问题）。数据达到目标主机以后是不会提醒的，也不会回调别的方法，开发人员需要使用readDataToLength或者readDataToData才会从这个栈里面读取数据

No2.readDataToLength
这个方法也是比较难理解，上面提到了服务器到达本机的数据存放内存中的栈里面，那么一下子全部获取栈内容很有可能会出现粘包（first send: hello 、second send : Sun，期望是分开显示hello 和Sun，但是有可能会出现heloS 、 un 这样的内容），如何避免呢？使用readDataToLength读取指定长度的数据。

important note: readDataToLength读取指定长度的数据，如果栈里面没有指定长度的数据，就会在队列里面一直等待，当有新的数据到达，并满足这个长度的数据时，就会触发didReadData回调方法，并完成内容读取。读取几次栈里面的数据，就调用几次readDataToLength，如果没有使用readDataToLength，那么虽然服务器数据已经在栈里面了，但是我永远获取不到

//点击"获取"按钮触发obtainInfo方法，在客户端发出请求之后第一次使用readDataWithTimeout方法进入队列等待服务器数据到来（或者已经到了，就直接获取），进而自动回调didReadData方法
- (IBAction)obtainInfo:(id)sender {
    [self.clientSocket readDataWithTimeout:-1 tag:0];
}
//没错在这里也有个readDataWithTimeout方法，这个方法又会触发didReadData，这样形成一个循环，只要socket不断开，服务器一发送内容，就会读取显示。如果方法中没有这个readDataWithTimeout话，要不停的点击“获取”按钮才能获取服务器消息
- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag {
    NSString* obtainContent = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
    self.display.text = [self.display.text stringByAppendingFormat:@"%@\n",obtainContent];
    [self.clientSocket readDataWithTimeout:-1 tag:0]; //一直排队读取读栈内容，直到socket断开
}

No3.readDataToData
这个方法和No2差不多的，只不过它会读取整个栈里面的内容，调用一次读取一次（不管多少），不调用，就读取不到服务器传递过来存放到本机栈中的数据

No4.- (void)socket:(GCDAsyncSocket )sock didConnectToHost:(NSString )host port:(uint16_t)port

这个方法，在[self.clientSocket connectToHost:self.serverIp.text onPort:[self.serverPort.text intValue]发出连接请求，并连接服务器成功后调用，可以在这个方法里面加入心跳包

No5.- (void)socket:(GCDAsyncSocket *)sock didWriteDataWithTag:(long)tag
在方法[self.clientSocket readDataWithTimeout:-1 tag:0];执行以后如果写出成功就会触发调用这个didWriteDataWithTag方法，这里的tag标签也是难理解的，下面介绍

No6.- (void)socketDidDisconnect:(GCDAsyncSocket )sock withError:(nullable NSError )err
这个方法很头疼，当我的socket的delegate不为nil，但是socket又断开了，就会回调这个socketDidDisconnect方法，在这个方法里面可以实现重连，我也理解不多，不敢多写

Tag标签

一、readDataWithTimeout 的tag 就是didWriteDataWithTag中的tag

[self.clientSocket readDataWithTimeout:-1 tag:0]; 这里的tag，其实使用在下面方法里面的，上面讲过readDataWithTimeout方法写出成功就会回调didWriteDataWithTag方法，通过指定readDataWithTimeout方法的tag，根据不同tag，在didWriteDataWithTag方法里面使用if else 做不同操作

- (void)socket:(GCDAsyncSocket *)sock didWriteDataWithTag:(long)tag {

}

二、readDataWithTimeout中的tag就是didReadData的tag

同理[self.clientSocket readDataWithTimeout:-1 tag:0];执行后会回调下面方法，通过指定readDataWithTimeout的不同的tag，在didReadData中使用if else做不同操作（解决粘包）

- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag {
    NSString* obtainContent = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
    self.display.text = [self.display.text stringByAppendingFormat:@"%@\n",obtainContent];
    [self.clientSocket readDataWithTimeout:-1 tag:0]; //一直排队读取读栈内容，直到socket断开
}

例子下载