[iOS] Socket & CocoaAsyncSocket介紹與使用

介紹

網路上的兩個程式通過一個雙向的通訊連線實現資料的交換，這個連線的一端稱為一個套接字socket。
實際上socket是對TCP/IP協議的封裝，它的出現只是使得程式設計師更方便地使用TCP/IP協議棧而已。socket本身並不是協議，它是應用層與TCP/IP協議族通訊的中間軟體抽象層，是一組呼叫介面（TCP/IP網路的API函式）

TCP/IP

TCP/IP（Transmission Control Protocol/Internet Protocol）即傳輸控制協議/網間協議，是一個工業標準的協議集，它是為廣域網（WANs）設計的。
UDP（User Data Protocol，使用者資料包協議）是與TCP相對應的協議，它是屬於TCP/IP協議族中的一種
TCP/IP協議族包括運輸層、網路層、鏈路層。socket是一個介面，在使用者程式與TCP/IP協議之間充當中間人，完成TCP/IP協議的書寫，關係如下圖：

Socket 工作流程

我們來看下 Socket 是如何進行工作以及連線的

通過上面圖片，可以明白，伺服器端先初始化Socket，然後與埠繫結(bind)，對埠進行監聽(listen)，呼叫accept阻塞，等待客戶端連線。在這時如果有個客戶端初始化一個Socket，然後連線伺服器(connect)，如果連線成功，這時客戶端與伺服器端的連線就建立了。客戶端傳送資料請求，伺服器端接收請求並處理請求，然後把迴應資料傳送給客戶端，客戶端讀取資料，最後關閉連線，一次互動結束。

瞭解到 Socket 的概念以及工作原理，socket 的原生介面本文不做詳細使用說明了，本文主要對 CocoaAsyncSocket進行介紹與使用

CocoaAsyncSocket介紹

CocoaAsyncSocket為Mac和iOS提供了易於使用和功能強大的非同步套接字型檔，主要包含兩個類:

• GCDAsyncSocket
  用GCD搭建的基於TCP/IP協議的socket網路庫
• GCDAsyncUdpSocket
  用GCD搭建的基於UDP/IP協議的socket網路庫.

本文主要介紹 GCDAsyncSocket的使用，他是一個TCP庫，建在Grand Central Dispatch上面的

客戶端

1. 初始化

@property (nonatomic, strong) GCDAsyncSocket *clientSocket;

 self.clientSocket = [[GCDAsyncSocket alloc] initWithDelegate:self delegateQueue:dispatch_get_main_queue()];

需要delegate和delegate_queue才能使GCDAsyncSocket呼叫您的委託方法。提供delegateQueue是一個新概念。delegateQueue要求必須是一個序列佇列，使得委託方法在delegateQueue佇列中執行。

2.連線伺服器

NSError *err = nil;
if (![self.clientSocket connectToHost:@"ip地址" onPort: "埠號" error:&err])  //非同步！
{
    //  如果有錯誤，很可能是"已經連線"或"沒有委託集"
    NSLog(@"I goofed: %@", err);
}

連線方法是非同步的。這意味著當您呼叫connect方法時，它們會啟動後臺操作以連線到所需的主機/埠。

3.傳送資料

//  傳送資料
- (void)sendData:(NSData *)data{
     // -1表示超時時間無限大
     // tag:訊息標記
     [self.clientSocket writeData:data withTimeout:-1 tag:0];
}

通過呼叫writeData: withTimeout: tag:方法，即可傳送資料給伺服器。

4.委託方法

4.1連線成功會是執行的委託方法

// socket連線成功會執行該方法
- (void)socket:(GCDAsyncSocket*)sock didConnectToHost:(NSString*)host port:(UInt16)port{
    NSLog(@"--連線成功--");
    [sock readDataWithTimeout:-1 tag:0];
}

4.2讀取到了服務端資料委託方法

// 收到伺服器傳送的資料會執行該方法
- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag{
    NSString *serverStr = [[NSString alloc]initWithData:data encoding:NSUTF8StringEncoding];
    NSLog(@"服務端回包了--回包內容--%@---長度%lu",serverStr,(unsigned long)data.length);
    [sock readDataWithTimeout:-1 tag:0];
}

4.3斷開連線委託方法

// 斷開連線會調取該方法
- (void)socketDidDisconnect:(GCDAsyncSocket*)sock withError:(NSError*)err{
    NSLog(@"--斷開連線--");
    //  sokect斷開連線時,需要清空代理和客戶端本身的socket.
    self.clientSocket.delegate = nil;
    self.clientSocket = nil;
}

以上幾個委託方法，使我們比較使用比較頻繁的委託代理方法。

5 心跳包

心跳包就是在客戶端和伺服器間定時通知對方自己狀態的一個自己定義的命令，按照一定的時間間隔傳送，類似於心跳
用來判斷對方（裝置，程式或其它網元）是否正常執行，採用定時傳送簡單的通訊包，如果在指定時間段內未收到對方響應，則判斷對方已經離線。

@property(nonatomic, strong) NSTimer *heartbeatTimer;

- (void)beginSendHeartbeat{
    // 建立心跳定製器
    self.heartbeatTimer = [NSTimer scheduledTimerWithTimeInterval:5.0 target:self selector:@selector(sendHeartbeat:) userInfo:nil repeats:YES];
    [[NSRunLoop mainRunLoop] addTimer:self.heartbeatTimer forMode:NSRunLoopCommonModes];
}

- (void)sendHeartbeat:(NSTimer *)timer {
    if (timer != nil) {
        char heartbeat[4] = {0xab,0xcd,0x00,0x00}; // 心跳位元組，和伺服器協商
        NSData *heartbeatData = [NSData dataWithBytes:&heartbeat length:sizeof(heartbeat)];
        [self.clientSocket writeData:heartbeatData withTimeout:-1 tag:0];
    }
}

服務端

GCDAsyncSocket還允許您建立伺服器，並接受傳入的連線; 服務端使用基本和客戶類似，只不過需要開啟埠進行監聽客戶端連線。

1. 初始化

@property(nonatomic, strong) GCDAsyncSocket *serverSocket;

// 初始化服務端socket
self.serverSocket = [[GCDAsyncSocket alloc]initWithDelegate:self delegateQueue:dispatch_get_main_queue()];

2.開放服務端的指定埠.

 //  開放服務端的指定埠.
    NSError *error = nil;
    BOOL result = [self.serverSocket acceptOnPort:port error:&error];
    if (result) {
        NSLog(@"埠開啟成功,並監聽客戶端請求連線...");
    }else {
        NSLog(@"埠開啟失...");
    }

3.傳送資料給客戶端

//  傳送資料，和客戶端使用一致
- (void)sendData:(NSData *)data{
     // -1表示超時時間無限大
     // tag:訊息標記
    [self.serverSocket writeData:data withTimeout:-1 tag:0];
}

4.委託方法

4.1 監聽到新的客戶端socket連線委託

/* 儲存所有連線的客戶端 socket*/
@property(nonatomic, strong) NSMutableArray *arrayClient;

//  監聽到新的客戶端socket連線，會執行該方法
- (void)socket:(GCDAsyncSocket *)serveSock didAcceptNewSocket:(GCDAsyncSocket *) newSocket{
    
    NSLog(@"%@ IP: %@: %hu 客戶端請求連線...",newSocket,newSocket.connectedHost,newSocket.localPort);
    // 將客戶端socket儲存起來
    if (![self.arrayClient containsObject:newSocket]) {
        [self.arrayClient addObject:newSocket];
    }
    [newSocket readDataWithTimeout:-1 tag:0];
}

監聽到客戶端連線，將客戶端 socket 儲存起來，因為伺服器可能會收到很多客戶端連線。

4.2 讀取客戶端資料

//  讀取客戶端傳送的資料
- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag {
  //  記錄客戶端心跳
    char heartbeat[4] = {0xab,0xcd,0x00,0x00}; // 心跳
    NSData *heartbeatData = [NSData dataWithBytes:&heartbeat length:sizeof(heartbeat)];
    if ([data isEqualToData:heartbeatData]) {
        NSLog(@"*************心跳**************");
        self.heartbeatDateDict[sock.connectedHost] = [NSDate date];
    }
    [sock readDataWithTimeout:-1 tag:0];
}

4.3斷開連線

//  斷開連線
- (void)socketDidDisconnect:(GCDAsyncSocket *)sock withError:(NSError *)err{    
    NSLog(@"斷開連線");
}

5.監聽心跳包

// 子執行緒用於監聽心跳包
@property(nonatomic, strong) NSThread *checkThread;
// 記錄每個心跳快取
@property (nonatomic, strong) NSMutableDictionary *heartbeatDateDict;
// 初始化子執行緒，並啟動
self.checkThread = [[NSThread alloc]initWithTarget:sharedInstance selector:@selector(checkClientOnline) object:nil];
[self.checkThread start];

#pragma checkTimeThread

//  這裡設定10檢查一次 陣列裡所有的客戶端socket 最後一次通訊時間,這樣的話會有周期差（最多差10s），可以設定為1s檢查一次，這樣頻率快
//  開啟執行緒 啟動runloop 迴圈檢測客戶端socket最新time
- (void)checkClientOnline{
    
    @autoreleasepool {
        [NSTimer scheduledTimerWithTimeInterval:10 target:self selector:@selector(repeatCheckClinetOnline) userInfo:nil repeats:YES];
        [[NSRunLoop currentRunLoop] run];
    }
}

//  移除 超過心跳時差的 client
- (void)repeatCheckClinetOnline{
    
    if (self.arrayClient.count == 0) {
        return;
    }
    NSDate *date = [NSDate date];
    for (GCDAsyncSocket *socket in self.arrayClient ) {
        if ([date timeIntervalSinceDate:self.heartbeatDateDict[socket.connectedHost]]>10) {
            [self.arrayClient removeObject:socket];
        }
    }
}

CocoaAsyncSocket的讀寫操作、粘包處理思路可以看下一篇： Socket & CocoaAsyncSocket 讀/寫操作以及粘包處理

Demo地址：https://github.com/liuchuan-alex/LCSocketDemo

CocoaAsyncSocket 地址:https://github.com/robbiehanson/CocoaAsyncSocket

參考連結:

https://github.com/robbiehanson/CocoaAsyncSocket/wiki/Intro_GCDAsyncSocket
https://blog.csdn.net/weixin_39258979/article/details/80835555
https://www.jianshu.com/p/321bc95d077f