摘要
ios socket第三方框架 AsyncSocket使用簡介,連接掸犬,心跳珊楼,斷線通殃,數(shù)據(jù)發(fā)送與接收
如果需要在項目中像QQ微信一樣做到即時通訊,必須使用socket通訊厕宗,本人也是剛學(xué)習(xí)画舌,分享一下,有什么不對的地方希望大家指正
ios原生的socket用起來不是很直觀已慢,所以我用的是AsyncSocket這個第三方庫曲聂,對socket的封裝比較好,只是好像沒有帶外傳輸(out—of-band) 如果你的服務(wù)器需要發(fā)送帶外數(shù)據(jù)佑惠,可能得想下別的辦法
環(huán)境
下載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的連接進行監(jiān)視與檢測旭咽,在斷線時進行重新連接,如果用戶退出登錄赌厅,要將socket手動關(guān)閉穷绵,否則對服務(wù)器會造成一定的負荷。
一般來說特愿,一個用戶(對于ios來說也就是我們的項目中)只能有一個正在連接的socket仲墨,所以這個socket變量必須是全局的,這里可以考慮使用單例或是AppDelegate進行數(shù)據(jù)共享揍障,本文使用單例宗收。如果對一個已經(jīng)連接的socket對象再次進行連接操作,會拋出異常(不可對已經(jīng)連接的socket進行連接)程序崩潰亚兄,所以在連接socket之前要對socket對象的連接狀態(tài)進行判斷
使用socket進行即時通訊還有一個必須的操作,即對服務(wù)器發(fā)送心跳包采驻,每隔一段時間對服務(wù)器發(fā)送長連接指令(指令不唯一审胚,由服務(wù)器端指定匈勋,包括使用socket發(fā)送消息,發(fā)送的數(shù)據(jù)和格式都是由服務(wù)器指定)膳叨,如果沒有收到服務(wù)器的返回消息洽洁,AsyncSocket會得到失去連接的消息,我們可以在失去連接的回調(diào)方法里進行重新連接菲嘴。
先創(chuàng)建一個單例饿自,命名為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;
}
這樣一個單例就創(chuàng)建好了
在.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中實現(xiàn),連接時host與port都是由服務(wù)器指定健田,如果不是自己寫的服務(wù)器烛卧,請與服務(wù)器端開發(fā)人員交流
// socket連接
-(void)socketConnectHost{
self.socket = [[AsyncSocket alloc] initWithDelegate:self];
NSError *error = nil;
[self.socket connectToHost:self.socketHost onPort:self.socketPort withTimeout:3 error:&error];
}
心跳
心跳通過計時器來實現(xiàn) 在singleton.h中聲明一個定時器
@property (nonatomic, retain) NSTimer *connectTimer; // 計時器
在.m中實現(xiàn)連接成功回調(diào)方法,并在此方法中初始化定時器妓局,發(fā)送心跳在后文向服務(wù)器
發(fā)送數(shù)據(jù)時說明
#pragma mark - 連接成功回調(diào)
-(void)onSocket:(AsyncSocket *)sock didConnectToHost:(NSString *)host port:(UInt16)port
{
NSLog(@"socket連接成功");
// 每隔30s像服務(wù)器發(fā)送心跳包
self.connectTimer = [NSTimer scheduledTimerWithTimeInterval:30 target:self selector:@selector(longConnectToSocket) userInfo:nil repeats:YES];// 在longConnectToSocket方法中進行長連接需要向服務(wù)器發(fā)送的訊息
[self.connectTimer fire];
}
2. socket 斷開連接與重連
斷開連接
失去連接有幾種情況总放,服務(wù)器斷開,用戶主動cut好爬,還可能有如QQ其他設(shè)備登錄被掉線的情況局雄,不管那種情況,我們都能收到socket回調(diào)方法返回給我們的訊息存炮,如果是用戶退出登錄或是程序退出而需要手動cut炬搭,我們在cut前對socket的userData賦予一個值來標(biāo)記為用戶退出,這樣我們可以在收到斷開信息時判斷究竟是什么原因?qū)е碌牡艟€
在.h文件中聲明一個枚舉類型
enum{
SocketOfflineByServer,// 服務(wù)器掉線僵蛛,默認為0
SocketOfflineByUser, // 用戶主動cut
};
聲明斷開連接方法
-(void)cutOffSocket; // 斷開socket連接
.m
// 切斷socket
-(void)cutOffSocket{
self.socket.userData = SocketOfflineByUser;// 聲明是由用戶主動切斷
[self.connectTimer invalidate];
[self.socket disconnect];
}
重連
實現(xiàn)代理方法
-(void)onSocketDidDisconnect:(AsyncSocket *)sock
{
NSLog(@"sorry the connect is failure %ld",sock.userData);
if (sock.userData == SocketOfflineByServer) {
// 服務(wù)器掉線尚蝌,重連
[self socketConnectHost];
}
else if (sock.userData == SocketOfflineByUser) {
// 如果由用戶斷開,不進行重連
return;
}
}
3. socket 發(fā)送與接收數(shù)據(jù)
發(fā)送數(shù)據(jù) 我們補充上文心跳連接未完成的方法
// 心跳連接
-(void)longConnectToSocket{
// 根據(jù)服務(wù)器要求發(fā)送固定格式的數(shù)據(jù)充尉,假設(shè)為指令@"longConnect"飘言,但是一般不會是這么簡單的指令
NSString *longConnect = @"longConnect";
NSData *dataStream = [longConnect dataUsingEncoding:NSUTF8StringEncoding];
[self.socket writeData:dataStream withTimeout:1 tag:1];
}
socket發(fā)送數(shù)據(jù)是以棧的形式存放,所有數(shù)據(jù)放在一個棧中驼侠,存取時會出現(xiàn)粘包的現(xiàn)象姿鸿,所以很多時候服務(wù)器在收發(fā)數(shù)據(jù)時是以先發(fā)送內(nèi)容字節(jié)長度,再發(fā)送內(nèi)容的形式倒源,得到數(shù)據(jù)時也是先得到一個長度苛预,再根據(jù)這個長度在棧中讀取這個長度的字節(jié)流,如果是這種情況笋熬,發(fā)送數(shù)據(jù)時只需在發(fā)送內(nèi)容前發(fā)送一個長度热某,發(fā)送方法與發(fā)送內(nèi)容一樣,假設(shè)長度為8
NSData *dataStream = [@8 dataUsingEncoding:NSUTF8StringEncoding];
[self.socket writeData:dataStream withTimeout:1 tag:1];
接收數(shù)據(jù) 為了能時刻接收到socket的消息,我們在長連接方法中進行讀取數(shù)據(jù)
[self.socket readDataWithTimeout:30 tag:0];
如果得到數(shù)據(jù)昔馋,會調(diào)用回調(diào)方法
-(void)onSocket:(AsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag
{
// 對得到的data值進行解析與轉(zhuǎn)換即可
[self.socket readDataWithTimeout:30 tag:0];
}
4. 簡單使用說明
我們在用戶登錄后的第一個界面進行socket的初始化連接操作筹吐,在得到數(shù)據(jù)后,將所需要顯示的數(shù)據(jù)放在singleton中秘遏,對變量進行監(jiān)聽后做出相應(yīng)的操作即可丘薛,延伸起來比較復(fù)雜,沒有真實數(shù)據(jù)也不太方便說明邦危,大家自己進行探索吧堵漱,有問題請在下方留言
[Singleton sharedInstance].socketHost = @"192.186.100.21";// host設(shè)定
[Singleton sharedInstance].socketPort = 10045;// port設(shè)定
// 在連接前先進行手動斷開
[Singleton sharedInstance].socket.userData = SocketOfflineByUser;
[[Singleton sharedInstance] cutOffSocket];
// 確保斷開后再連米死,如果對一個正處于連接狀態(tài)的socket進行連接酵镜,會出現(xiàn)崩潰
[Singleton sharedInstance].socket.userData = SocketOfflineByServer;
[[Singleton sharedInstance] socketConnectHost];
全部代碼在這里痢法,只是對本文的整合,運行出來為空白