Socket —>AsyncSocket(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];

全部代碼在這裏,只是對本文的整合,運行出來爲空白(http://www.oschina.net/code/snippet_735123_36974)

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章