iOS學習之Socket使用簡明教程－ AsyncSocket

標籤：

如果需要在項目中像QQ一樣做到即時通訊，必須使用socket通訊，本人也是剛學習，分享一下，有什麼不對的地方希望大家指正

ios原生的socket用起來不是很直觀，所以我用的是AsyncSocket這個第三方庫，對socket的封裝比較好，只是好像沒有帶外傳輸（out—of-band） 如果你的伺服器需要發送帶外資料，可能得想下別的辦法

環境

下載AsyncSockethttps://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>

使用

1. socket 串連

即時通訊最大的特點就是即時性，基本感覺不到延時或是掉線，所以必須對socket的串連進行監視與檢測，在斷線時進行重新串連，如果使用者退出登入，要將socket手動關閉，否則對伺服器會造成一定的負荷。

一般來說，一個使用者（對於ios來說也就是我們的項目中）只能有一個正在串連的socket，所以這個socket變數必須是全域的，這裡可以考慮使用單例或是AppDelegate進行資料共用，本文使用單例。如果對一個已經串連的socket對象再次進行串連操作，會拋出異常（不可對已經串連的socket進行串連）程式崩潰，所以在串連socket之前要對socket對象的串連狀態進行判斷

使用socket進行即時通訊還有一個必須的操作，即對伺服器發送心跳包，每隔一段時間對伺服器發送長串連指令（指令不唯一，由伺服器端指定，包括使用socket發送訊息，發送的資料和格式都是由伺服器指定），如果沒有收到伺服器的返回訊息，AsyncSocket會得到失去串連的訊息，我們可以在失去串連的回調方法裡進行重新串連。

先建立一個單例，命名為Singleton

Singleton.h

// Singleton.h#import "AsyncSocket.h"#define DEFINE_SHARED_INSTANCE_USING_BLOCK(block) \static dispatch_once_t onceToken = 0; __strong static id sharedInstance = nil; \dispatch_once(&onceToken, ^{ sharedInstance = block(); }); \return sharedInstance; \@interface Singleton : NSObject+ (Singleton *)sharedInstance;@end

Singleton.m

+(Singleton *) sharedInstance{static Singleton *sharedInstace = nil;static dispatch_once_t onceToken;dispatch_once(&onceToken, ^{    sharedInstace = [[self alloc] init];});return sharedInstace;}

這樣一個單例就建立好了

在.h檔案中生命socket變數

@property (nonatomic, strong) AsyncSocket    *socket;       // [email protected] (nonatomic, copy  ) NSString       *socketHost;   // socket的[email protected] (nonatomic, assign) UInt16         socketPort;    // socket的prot

下面是串連，心跳，失去串連後重連

串連(長串連)

在.h檔案中聲明方法，並聲明代理<AsyncSocketDelegate>

-(void)socketConnectHost;// socket串連

在.m中實現，串連時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];}

心跳

心跳通過計時器來實現 
在singleton.h中聲明一個定時器

@property (nonatomic, retain) NSTimer        *connectTimer; // 計時器

在.m中實現串連成功回調方法，並在此方法中初始化定時器，發送心跳在後文向伺服器發送資料時說明

#pragma mark  - 串連成功回調-(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];}

2. socket 中斷連線與重連

中斷連線

失去串連有幾種情況，伺服器斷開，使用者主動cut，還可能有如QQ其他裝置登入被掉線的情況，不管那種情況，我們都能收到socket回調方法返回給我們的訊息，如果是使用者退出登入或是程式退出而需要手動cut，我們在cut前對socket的userData賦予一個值來標記為使用者退出，這樣我們可以在收到斷開資訊時判斷究竟是什麼原因導致的掉線

在.h檔案中聲明一個枚舉類型

enum{    SocketOfflineByServer,// 伺服器掉線，預設為0    SocketOfflineByUser,  // 使用者主動cut};

聲明中斷連線方法

-(void)cutOffSocket; // 斷開socket串連

.m

// 切斷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;    }}

3. socket 發送與接收資料

發送資料 
我們補充上文心跳串連未完成的方法

// 心跳串連-(void)longConnectToSocket{    // 根據伺服器要求發送固定格式的資料，假設為指令@"longConnect"，但是一般不會是這麼簡單的指令    NSString *longConnect = @"longConnect";    NSData   *dataStream  = [longConnect dataUsingEncoding:NSUTF8StringEncoding];    [self.socket writeData:dataStream withTimeout:1 tag:1];}

socket發送資料是以棧的形式存放，所有資料放在一個棧中，存取時會出現粘包的現象，所以很多時候伺服器在收發資料時是以先發送內容位元組長度，再發送內容的形式，得到資料時也是先得到一個長度，再根據這個長度在棧中讀取這個長度的位元組流，如果是這種情況，發送資料時只需在發送內容前發送一個長度，發送方法與發送內容一樣，假設長度為8

NSData   *dataStream  = [@8 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:30 tag:0];}

4. 簡單使用說明

我們在使用者登入後的第一個介面進行socket的初始化串連操作，在得到資料後，將所需要顯示的資料放在singleton中，對變數進行監聽後做出相應的操作即可，延伸起來比較複雜，沒有真實資料也不太方便說明，大家自己進行探索吧，有問題請在下方留言

    [Singleton sharedInstance].socketHost = @"192.186.100.21";// host設定    [Singleton sharedInstance].socketPort = 10045;// port設定    // 在串連前先進行手動斷開    [Singleton sharedInstance].socket.userData = SocketOfflineByUser;    [[Singleton sharedInstance] cutOffSocket];    // 確保斷開後再連，如果對一個正處於串連狀態的socket進行串連，會出現崩潰    [Singleton sharedInstance].socket.userData = SocketOfflineByServer;    [[Singleton sharedInstance] socketConnectHost];

全部代碼在這裡，只是對本文的整合，運行出來為空白

iOS學習之Socket使用簡明教程－ AsyncSocket