本文介紹了CocoaAsyncSocket庫(kù)中GCDAsyncSocket類(lèi)的使用、粘包處理以及時(shí)間延遲測(cè)試.
一.CocoaAsyncSocket介紹
CocoaAsyncSocket中主要包含兩個(gè)類(lèi):
1.GCDAsyncSocket.
用GCD搭建的基于TCP/IP協(xié)議的socket網(wǎng)絡(luò)庫(kù)
GCDAsyncSocket is a TCP/IP socket networking library built atop Grand Central Dispatch. -- 引自CocoaAsyncSocket.
2.GCDAsyncUdpSocket.
用GCD搭建的基于UDP/IP協(xié)議的socket網(wǎng)絡(luò)庫(kù).
GCDAsyncUdpSocket is a UDP/IP socket networking library built atop Grand Central Dispatch..-- 引自CocoaAsyncSocket.
二.下載CocoaAsyncSocket
首先,需要到這里下載CocoaAsyncSocket.
下載后可以看到文件所在位置.
- 這里只要拷貝以下兩個(gè)文件到項(xiàng)目中.
三.客戶(hù)端
因?yàn)?大部分項(xiàng)目已經(jīng)有服務(wù)端socket,所以,先講解客戶(hù)端創(chuàng)建過(guò)程.
步驟:
1.繼承GCDAsyncSocketDelegate協(xié)議.
2.聲明屬性
// 客戶(hù)端socket
@property (strong, nonatomic) GCDAsyncSocket *clientSocket;
3.創(chuàng)建socket并指定代理對(duì)象為self,代理隊(duì)列必須為主隊(duì)列.
self.clientSocket = [[GCDAsyncSocket alloc] initWithDelegate:self delegateQueue:dispatch_get_main_queue()];
4.連接指定主機(jī)的對(duì)應(yīng)端口.
NSError *error = nil;
self.connected = [self.clientSocket connectToHost:self.addressTF.text onPort:[self.portTF.text integerValue] viaInterface:nil withTimeout:-1 error:&error];
5.成功連接主機(jī)對(duì)應(yīng)端口號(hào).
- (void)socket:(GCDAsyncSocket *)sock didConnectToHost:(NSString *)host port:(uint16_t)port
{
// NSLog(@"連接主機(jī)對(duì)應(yīng)端口%@", sock);
[self showMessageWithStr:@"鏈接成功"];
[self showMessageWithStr:[NSString stringWithFormat:@"服務(wù)器IP: %@-------端口: %d", host,port]];
// 連接成功開(kāi)啟定時(shí)器
[self addTimer];
// 連接后,可讀取服務(wù)端的數(shù)據(jù)
[self.clientSocket readDataWithTimeout:- 1 tag:0];
self.connected = YES;
}
注意:
The host parameter will be an IP address, not a DNS name. -- 引自GCDAsyncSocket
連接的主機(jī)為IP地址,并非DNS名稱(chēng).
6.發(fā)送數(shù)據(jù)給服務(wù)端
// 發(fā)送數(shù)據(jù)
- (IBAction)sendMessageAction:(id)sender
{
NSData *data = [self.messageTextF.text dataUsingEncoding:NSUTF8StringEncoding];
// withTimeout -1 : 無(wú)窮大,一直等
// tag : 消息標(biāo)記
[self.clientSocket writeData:data withTimeout:- 1 tag:0];
}
注意:
發(fā)送數(shù)據(jù)主要通過(guò)- (void)writeData:(NSData *)data withTimeout:(NSTimeInterval)timeout tag:(long)tag寫(xiě)入數(shù)據(jù)的.
7.讀取服務(wù)端數(shù)據(jù)
/**
讀取數(shù)據(jù)
@param sock 客戶(hù)端socket
@param data 讀取到的數(shù)據(jù)
@param tag 本次讀取的標(biāo)記
*/
- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag
{
NSString *text = [[NSString alloc]initWithData:data encoding:NSUTF8StringEncoding];
[self showMessageWithStr:text];
// 讀取到服務(wù)端數(shù)據(jù)值后,能再次讀取
[self.clientSocket readDataWithTimeout:- 1 tag:0];
}
注意:
有的人寫(xiě)好代碼,而且第一次能夠讀取到數(shù)據(jù),之后,再也接收不到數(shù)據(jù).那是因?yàn)?在讀取到數(shù)據(jù)的代理方法中,需要再次調(diào)用[self.clientSocket readDataWithTimeout:- 1 tag:0];方法,框架本身就是這么設(shè)計(jì)的.
8.客戶(hù)端socket斷開(kāi)連接.
/**
客戶(hù)端socket斷開(kāi)
@param sock 客戶(hù)端socket
@param err 錯(cuò)誤描述
*/
- (void)socketDidDisconnect:(GCDAsyncSocket *)sock withError:(NSError *)err
{
[self showMessageWithStr:@"斷開(kāi)連接"];
self.clientSocket.delegate = nil;
self.clientSocket = nil;
self.connected = NO;
[self.connectTimer invalidate];
}
注意:
sokect斷開(kāi)連接時(shí),需要清空代理和客戶(hù)端本身的socket.
self.clientSocket.delegate = nil;
self.clientSocket = nil;
9.建立心跳連接.
// 計(jì)時(shí)器
@property (nonatomic, strong) NSTimer *connectTimer;
// 添加定時(shí)器
- (void)addTimer
{
// 長(zhǎng)連接定時(shí)器
self.connectTimer = [NSTimer scheduledTimerWithTimeInterval:5.0 target:self selector:@selector(longConnectToSocket) userInfo:nil repeats:YES];
// 把定時(shí)器添加到當(dāng)前運(yùn)行循環(huán),并且調(diào)為通用模式
[[NSRunLoop currentRunLoop] addTimer:self.connectTimer forMode:NSRunLoopCommonModes];
}
// 心跳連接
- (void)longConnectToSocket
{
// 發(fā)送固定格式的數(shù)據(jù),指令@"longConnect"
float version = [[UIDevice currentDevice] systemVersion].floatValue;
NSString *longConnect = [NSString stringWithFormat:@"123%f",version];
NSData *data = [longConnect dataUsingEncoding:NSUTF8StringEncoding];
[self.clientSocket writeData:data withTimeout:- 1 tag:0];
}
注意:
心跳連接中發(fā)送給服務(wù)端的數(shù)據(jù)只是作為測(cè)試代碼,根據(jù)你們公司需求,或者和后臺(tái)商定好心跳包的數(shù)據(jù)以及發(fā)送心跳的時(shí)間間隔.因?yàn)檫@個(gè)項(xiàng)目的服務(wù)端socket也是我寫(xiě)的,所以,我自定義心跳包協(xié)議.客戶(hù)端發(fā)送心跳包,服務(wù)端也需要有對(duì)應(yīng)的心跳檢測(cè),以此檢測(cè)客戶(hù)端是否在線.
四.服務(wù)端
步驟:
1.繼承GCDAsyncSocketDelegate協(xié)議.
2.聲明屬性
// 服務(wù)端socket(開(kāi)放端口,監(jiān)聽(tīng)客戶(hù)端socket的連接)
@property (strong, nonatomic) GCDAsyncSocket *serverSocket;
3.創(chuàng)建socket并指定代理對(duì)象為self,代理隊(duì)列必須為主隊(duì)列.
// 初始化服務(wù)端socket
self.serverSocket = [[GCDAsyncSocket alloc]initWithDelegate:self delegateQueue:dispatch_get_main_queue()];
4.開(kāi)放服務(wù)端的指定端口.
BOOL result = [self.serverSocket acceptOnPort:[self.portF.text integerValue] error:&error];
5.連接上新的客戶(hù)端socket
// 連接上新的客戶(hù)端socket
- (void)socket:(GCDAsyncSocket *)sock didAcceptNewSocket:(nonnull GCDAsyncSocket *)newSocket
{
// 保存客戶(hù)端的socket
[self.clientSockets addObject: newSocket];
// 添加定時(shí)器
[self addTimer];
[self showMessageWithStr:@"鏈接成功"];
[self showMessageWithStr:[NSString stringWithFormat:@"客戶(hù)端的地址: %@ -------端口: %d", newSocket.connectedHost, newSocket.connectedPort]];
[newSocket readDataWithTimeout:- 1 tag:0];
}
6.發(fā)送數(shù)據(jù)給客戶(hù)端
// socket是保存的客戶(hù)端socket, 表示給這個(gè)客戶(hù)端socket發(fā)送消息
- (IBAction)sendMessage:(id)sender
{
if(self.clientSockets == nil) return;
NSData *data = [self.messageTextF.text dataUsingEncoding:NSUTF8StringEncoding];
// withTimeout -1 : 無(wú)窮大,一直等
// tag : 消息標(biāo)記
[self.clientSockets enumerateObjectsUsingBlock:^(id _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
[obj writeData:data withTimeout:-1 tag:0];
}];
}
7.讀取客戶(hù)端的數(shù)據(jù)
/**
讀取客戶(hù)端發(fā)送的數(shù)據(jù)
@param sock 客戶(hù)端的Socket
@param data 客戶(hù)端發(fā)送的數(shù)據(jù)
@param tag 當(dāng)前讀取的標(biāo)記
*/
- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag
{
NSString *text = [[NSString alloc]initWithData:data encoding:NSUTF8StringEncoding];
[self showMessageWithStr:text];
// 第一次讀取到的數(shù)據(jù)直接添加
if (self.clientPhoneTimeDicts.count == 0)
{
[self.clientPhoneTimeDicts setObject:[self getCurrentTime] forKey:text];
}
else
{
// 鍵相同,直接覆蓋,值改變
[self.clientPhoneTimeDicts enumerateKeysAndObjectsUsingBlock:^(id _Nonnull key, id _Nonnull obj, BOOL * _Nonnull stop) {
[self.clientPhoneTimeDicts setObject:[self getCurrentTime] forKey:text];
}];
}
[sock readDataWithTimeout:- 1 tag:0];
}
8.建立檢測(cè)心跳連接.
// 檢測(cè)心跳計(jì)時(shí)器
@property (nonatomic, strong) NSTimer *checkTimer;
// 添加計(jì)時(shí)器
- (void)addTimer
{
// 長(zhǎng)連接定時(shí)器
self.checkTimer = [NSTimer scheduledTimerWithTimeInterval:10.0 target:self selector:@selector(checkLongConnect) userInfo:nil repeats:YES];
// 把定時(shí)器添加到當(dāng)前運(yùn)行循環(huán),并且調(diào)為通用模式
[[NSRunLoop currentRunLoop] addTimer:self.checkTimer forMode:NSRunLoopCommonModes];
}
// 檢測(cè)心跳
- (void)checkLongConnect
{
[self.clientPhoneTimeDicts enumerateKeysAndObjectsUsingBlock:^(id _Nonnull key, id _Nonnull obj, BOOL * _Nonnull stop) {
// 獲取當(dāng)前時(shí)間
NSString *currentTimeStr = [self getCurrentTime];
// 延遲超過(guò)10秒判斷斷開(kāi)
if (([currentTimeStr doubleValue] - [obj doubleValue]) > 10.0)
{
[self showMessageWithStr:[NSString stringWithFormat:@"%@已經(jīng)斷開(kāi),連接時(shí)差%f",key,[currentTimeStr doubleValue] - [obj doubleValue]]];
[self showMessageWithStr:[NSString stringWithFormat:@"移除%@",key]];
[self.clientPhoneTimeDicts removeObjectForKey:key];
}
else
{
[self showMessageWithStr:[NSString stringWithFormat:@"%@處于連接狀態(tài),連接時(shí)差%f",key,[currentTimeStr doubleValue] - [obj doubleValue]]];
}
}];
}
心跳檢測(cè)方法只提供部分思路:
1.懶加載一個(gè)可變字典,字典的鍵作為客戶(hù)端的標(biāo)識(shí).如:客戶(hù)端標(biāo)識(shí)為13123456789.
2.在- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag方法中,將讀取到的數(shù)據(jù)或者數(shù)據(jù)中的部分字符串作為鍵.字典的值為系統(tǒng)當(dāng)前時(shí)間.服務(wù)端第一次讀取數(shù)據(jù)時(shí),字典中沒(méi)有數(shù)據(jù),所以,直接添加到可變字典中,之后每次讀取數(shù)據(jù)時(shí),都用字典的setObject: forKey:方法添加字典,若存儲(chǔ)的鍵相同,即客戶(hù)端標(biāo)識(shí)相同,鍵會(huì)被覆蓋,再使用系統(tǒng)的當(dāng)前時(shí)間作為值.
3.在- (void)checkLongConnect中,獲取此時(shí)的當(dāng)前時(shí)間,遍歷字典,將每個(gè)鍵的值和當(dāng)前時(shí)間進(jìn)行比較即可.判斷的延遲時(shí)間可以寫(xiě)8秒.時(shí)間自定.之后,再根據(jù)自己的需求進(jìn)行后續(xù)處理.
五.數(shù)據(jù)粘包處理.
1.粘包情況.
例如:包數(shù)據(jù)為:abcd.
[圖片上傳失敗...(image-91e3ea-1629185588357)]
2.粘包解決思路.
- 思路1:
發(fā)送方將數(shù)據(jù)包加上包頭和包尾,包頭枣抱、包體以及包尾用字典形式包裝成json字符串,接收方,通過(guò)解析獲取json字符串中的包體,便可進(jìn)行進(jìn)一步處理.
例如:
{
// head:包頭,body:包體,end:包尾
NSDictionary *dict = @{
@"head" : @"phoneNum",
@"body" : @(13133334444),
@"end" : @(11)};
}
- 思路2:
添加前綴.和包內(nèi)容拼接成同一個(gè)字符串.
例如:當(dāng)發(fā)送數(shù)據(jù)是13133334444,如果出現(xiàn)粘包情況只屬于完整型:
13133334444
1313333444413133334444
131333344441313333444413133334444...
可以將ab作為前綴.則接收到的數(shù)據(jù)出現(xiàn)的粘包情況:
ab13133334444
ab13133334444ab13133334444
ab13133334444ab13133334444ab13133334444...
使用componentsSeparatedByString:方法,以ab為分隔符,將每個(gè)包內(nèi)容存入數(shù)組中,再取對(duì)應(yīng)數(shù)組中的數(shù)據(jù)操作即可.
- 思路3:
如果最終要得到的數(shù)據(jù)的長(zhǎng)度是個(gè)固定長(zhǎng)度,用一個(gè)字符串作為緩沖池,每次收到數(shù)據(jù),都用字符串拼接對(duì)應(yīng)數(shù)據(jù),每當(dāng)字符串的長(zhǎng)度和固定長(zhǎng)度相同時(shí),便得到一個(gè)完整數(shù)據(jù),處理完這個(gè)數(shù)據(jù)并清空字符串,再進(jìn)行下一輪的字符拼接.
例如:處理上面的不完整型.創(chuàng)建一個(gè)長(zhǎng)度是4的tempData字符串作為數(shù)據(jù)緩沖池.第1次收到數(shù)據(jù),數(shù)據(jù)是:ab,tempData拼接上ab,tempData中只能再存儲(chǔ)2個(gè)字符,第2次收到數(shù)據(jù),將數(shù)據(jù)長(zhǎng)度和2進(jìn)行比較,第2次的數(shù)據(jù)是:cda,截取前兩位字符,即cd,tempData繼續(xù)拼接cd,此時(shí),tempData為abcd,就是我們想要的數(shù)據(jù),我們可以處理這個(gè)數(shù)據(jù),處理之后并清空tempData,將第2次收到數(shù)據(jù)的剩余數(shù)據(jù),即cda中的a,再與tempData拼接.之后,再進(jìn)行類(lèi)似操作.
- 核心代碼
/**
處理數(shù)據(jù)粘包
@param readData 讀取到的數(shù)據(jù)
*/
- (void)dealStickPackageWithData:(NSString *)readData
{
// 緩沖池還需要存儲(chǔ)的數(shù)據(jù)個(gè)數(shù)
NSInteger tempCount;
if (readData.length > 0)
{
// 還差tempLength個(gè)數(shù)填滿(mǎn)緩沖池
tempCount = 4 - self.tempData.length;
if (readData.length <= tempCount)
{
self.tempData = [self.tempData stringByAppendingString:readData];
if (self.tempData.length == 4)
{
[self.mutArr addObject:self.tempData];
self.tempData = @"";
}
}
else
{
// 下一次的數(shù)據(jù)個(gè)數(shù)比要填滿(mǎn)緩沖池的數(shù)據(jù)個(gè)數(shù)多,一定能拼接成完整數(shù)據(jù),剩余的繼續(xù)
self.tempData = [self.tempData stringByAppendingString:[readData substringToIndex:tempCount]];
[self.mutArr addObject:self.tempData];
self.tempData = @"";
// 多余的再執(zhí)行一次方法
[self dealStickPackageWithData:[readData substringFromIndex:tempCount]];
}
}
}
- 調(diào)用
// 存儲(chǔ)處理后的每次返回?cái)?shù)據(jù)
@property (nonatomic, strong) NSMutableArray *mutArr;
// 數(shù)據(jù)緩沖池
@property (nonatomic, copy) NSString *tempData;
/** 第四次測(cè)試 -- 混合型**/
self.mutArr = nil;
/*
第1次 : abc
第2次 : da
第3次 : bcdabcd
第4次 : abcdabcd
第5次 : abcdabcdab
*/
// 數(shù)組中的數(shù)據(jù)代表每次接收的數(shù)據(jù)
NSArray *testArr4 = [NSArray arrayWithObjects:@"abc",@"da",@"bcdabcd",@"abcdabcd",@"abcdabcdab", nil];
self.tempData = @"";
for (NSInteger i = 0; i < testArr4.count; I++)
{
[self dealStickPackageWithData:testArr4[I]];
}
NSLog(@"testArr4 = %@",self.mutArr);
- 結(jié)果:
2017-06-09 00:49:12.932976+0800 StickPackageDealDemo[10063:3430118] testArr4 = (
abcd,
abcd,
abcd,
abcd,
abcd,
abcd,
abcd
)
六.配置測(cè)試.
測(cè)試時(shí),兩端需要處于同一WiFi下.客戶(hù)端中的IP地址為服務(wù)端的IP地址,具體信息進(jìn)入Wifi設(shè)置中查看.
數(shù)據(jù)粘包處理Demo在文末.
GitHub:
本文來(lái)自 棗泥布丁 的 【iOS開(kāi)發(fā)】之CocoaAsyncSocket使用
