在 iOS 上做低階網路連線,蘋果官方推薦的路線是 CFNetwork。但直接面對 C 層 API 繁瑣又容易出錯,因此社群包裝出了 CocoaAsyncSocket 這套開源庫,把 CFNetwork 的呼叫細節藏起來,對外提供一組-friendly 的異步行為。以下整理它的核心特性、最小可用範例,以及各方法的語意。
把 AsyncSocket.h/.m 與 AsyncUdpSocket.h/.m 四個檔案加入專案,並連結 CFNetwork.framework。
#import "AsyncSocket.h"
@interface HelloiPhoneViewController : UIViewController {
UITextField *textField;
AsyncSocket *asyncSocket;
}
@property (retain, nonatomic) IBOutlet UITextField *textField;
- (IBAction)buttonPressed:(id)sender;
- (IBAction)textFieldDoneEditing:(id)sender;
@end
初始化時傳入的 delegate 不可省略。initWithDelegate: 會把當前物件登錄為回呼接收者,之後只要在該物件中實作對應的 delegate 方法即可。
asyncSocket = [[AsyncSocket alloc] initWithDelegate:self];
NSError *err = nil;
if (![asyncSocket connectToHost:host onPort:port error:&err]) {
NSLog(@"Error: %@", err);
}
不論收或發,AsyncSocket 一律使用 NSData。它本質上就是一段指向位元組空間的指標加上長度。
// NSString → NSData NSData *xmlData = [@"testdata" dataUsingEncoding:NSUTF8StringEncoding]; // NSData → NSString NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
// 送出資料
- (void)writeData:(NSData *)data withTimeout:(NSTimeInterval)timeout tag:(long)tag;
NSData *aData = [@"test data" dataUsingEncoding:NSUTF8StringEncoding];
[sock writeData:aData withTimeout:-1 tag:1];
// 寫入完成的回呼
- (void)onSocket:(AsyncSocket *)sock didWriteDataWithTag:(long)tag {
NSLog(@"thread(%@), onSocket:%p didWriteDataWithTag:%ld",
[[NSThread currentThread] name], sock, tag);
}
// 讀取資料的回呼
- (void)onSocket:(AsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag {
NSString *aStr = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
NSLog(@"===%@", aStr);
[aStr release];
}
// 讀取固定長度位元組
[socket readDataToLength:length withTimeout:timeout tag:tag];
- (BOOL)acceptOnPort:(UInt16)port error:(NSError **)errPtr; // 開始監聽並接受指定 port 上的連線,會監聽所有可用介面(Wi-Fi、乙太網路等) - (BOOL)connectToHost:(NSString *)hostname onPort:(UInt16)port error:(NSError **)errPtr; // hostname 可以是網域名稱或 IP - (BOOL)connectToAddress:(NSData *)remoteAddr error:(NSError **)errPtr; // 直接指定 sockaddr 位址,例如取自 NSNetService 的位址方法 - (void)disconnect; // 立即斷線,所有未完成的讀寫都會被丟棄 - (void)disconnectAfterReading; // 等所有待處理的讀取完成後才斷線;呼叫後讀寫方法即失效
若已有 sockaddr 結構,可這樣轉成 NSData:
struct sockaddr sa -> NSData *dsa = [NSData dataWithBytes:&remoteAddr length:remoteAddr.sa_len]; struct sockaddr *sa -> NSData *dsa = [NSData dataWithBytes:remoteAddr length:remoteAddr->sa_len];
readDataWithTimeout:tag::讀取 socket 上第一個可用的位元組。timeout 傳負值代表不設逾時。readDataWithTimeout:buffer:bufferOffset:tag::讀到的位元組會從指定偏移量附加到既有緩衝區,緩衝區視需要自動擴容。若 bufferOffset 大於緩衝區長度,方法失效且不觸發 delegate。緩衝區在使用期間不可任意修改。readDataToLength:withTimeout:tag::讀取指定長度。length 為 0 時方法失效。readDataToData:withTimeout:tag::一直讀到(含)指定的分隔資料為止,常用來逐行讀取,例如以 CRLF 作為行分隔。注意它比對的是位元組而非字元集,若分隔序列剛好是編碼內容的一部分,讀取會提早結束。writeData:withTimeout:tag::寫入資料,完成後觸發 delegate。progressOfReadReturningTag:bytesDone:total: 與 progressOfWriteReturningTag:...:回傳 0.0~1.0 的進度;沒有進行中的讀寫時回傳 NaN,可用 isnan 判斷。讀寫皆可設定逾時,逾時後會先呼叫 onSocket:shouldTimeoutReadWithTag:elapsed:bytesDone:(寫入則是 shouldTimeoutWrite...),讓你有機會回傳正數來延長等待;接著才會走 onSocket:willDisconnectWithError: 與 onSocketDidDisconnect:。
startTLS: 用於把連線升級為 SSL/TLS,握手會排在所有待處理讀寫之後進行。常見設定鍵包括 kCFStreamSSLLevel、kCFStreamSSLPeerName、kCFStreamSSLValidatesCertificateChain、kCFStreamSSLAllowsExpiredCertificates 等。預設值會驗證憑證由可信第三方簽發且未過期,但不會驗證憑證上的名稱——除非你透過 kCFStreamSSLPeerName 指定。這個差異在安全性上很關鍵:若 DNS 被劫持而連到惡意主機,對方只要持有一張有效憑證,預設設定不會察覺任何異狀。因此連線到 MySecureServer.com 時,應明確把 peer name 設為該網域。
Run Loop 方面,moveToRunLoop: 可把 socket 搬移到另一條 Run Loop(必須從目前執行 socket 的執行緒呼叫),setRunLoopModes:/addRunLoopMode:/removeRunLoopMode: 則用來設定運作模式,預設是 NSRunLoopCommonModes。被接受的 socket 會自動沿用監聽 socket 的模式。
onSocket:willDisconnectWithError::發生錯誤即將關閉。此時可呼叫 unreadData 取出 socket 上殘留的位元組。連線階段它會早於 didAcceptNewSocket: 或 didConnectToHost:。onSocketDidDisconnect::不論有無錯誤,斷線完成後呼叫。若要釋放 socket,請在此方法進行;在 willDisconnect 中釋放並不安全。onSocket:didAcceptNewSocket::產生新 socket 處理連線時呼叫,可回傳新的 run loop 與 delegate。onSocketWillConnect: 與 onSocket:didConnectToHost:port::後者代表連線已可讀寫,注意 host 是 IP 而非 DNS 名稱。onSocket:didReadData:withTag:/didReadPartialDataOfLength:tag:/didWriteDataWithTag:/didWritePartialDataOfLength:tag::分別對應完成與部分完成的讀寫,部分完成適合用來更新進度條。onSocketDidSecure::SSL/TLS 協商成功後呼叫,僅在使用 startTLS: 時才會觸發。連線被接受時,delegate 的呼叫順序為:onSocket:didAcceptNewSocket: → onSocket:wantsRunLoopForNewSocket: → onSocketWillConnect: → onSocket:didConnectToHost:port:。若要保留被接受的 socket,最合適的位置是 didAcceptNewSocket:。
wantsRunLoopForNewSocket: 把新 socket 放到另一條 Run Loop,請務必等到 didConnectToHost:port: 再進行讀寫或 startTLS,否則作業會被排到錯誤的 Run Loop 上。[asyncSocket setDelegate:nil]; [asyncSocket disconnect]; [asyncSocket release];canSafelySetDelegate 可檢查目前是否有懸而未決的讀寫作業,換 delegate 前應先確認。enablePrebuffering 針對 readDataToData: 場景預先批次讀取並暫存溢出資料,能明顯提升效能,在 iPhone 上尤其有感。tag 只是方便你自己辨識用的識別碼,可當索引、步驟編號或狀態標記。參考原始討論與文件:原文連結。