轉 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;       // socket@property (nonatomic, copy  ) NSString       *socketHost;   // socket的Host@property (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];