CocoaAsyncSocket 是一套老牌的 socket 封裝庫,分為兩個類別:AsyncSocket 支援 TCP,AsyncUdpSocket 支援 UDP。AsyncSocket 封裝了 CFSocket 與 CFStream,提供非同步操作,並以 delegate 為基礎完整對應 Cocoa 的設計風格。
AsyncUdpSocket 是 UDP/IP 的 socket 庫,同樣包裝自 CFSocket,運作方式與 TCP 版本類似,同樣具備非阻塞佇列、完整 delegate、run loop 基礎與 IPv4/IPv6 支援。
HTTP 本身就是建立在 TCP 之上的,因此用「向網站發出請求並取得回應」來示範最直觀。若想先手動感受一次,可以在命令列用 telnet 連線;Mac OS X 預設有這個工具,Windows Vista/7 則需自行安裝。
#import <UIKit/UIKit.h> #import "AsyncSocket.h" @interface SocketDemosViewController : UIViewController @end
- (void)onSocket:(AsyncSocket *)sock didConnectToHost:(NSString *)host port:(UInt16)port {
NSLog(@"did connect to host");
}
- (void)onSocket:(AsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag {
NSLog(@"did read data");
NSString *message = [[[NSString alloc] initWithData:data
encoding:NSUTF8StringEncoding] autorelease];
NSLog(@"message is: \n%@", message);
}
AsyncSocketDelegate 的方法全都是可選的,這裡只實作了連線建立與資料讀取兩個時機。
- (void)viewDidLoad {
[super viewDidLoad];
AsyncSocket *socket = [[AsyncSocket alloc] initWithDelegate:self];
[socket connectToHost:@"www.baidu.com" onPort:80 error:nil];
[socket readDataWithTimeout:3 tag:1];
[socket writeData:[@"GET / HTTP/1.1\r\n\r\n" dataUsingEncoding:NSUTF8StringEncoding]
withTimeout:3 tag:1];
}
執行後的 log 大致如下(回應內容已截斷):
did connect to host did read data message is: HTTP/1.1 200 OK Date: Tue, 19 Jul 2011 09:17:46 GMT Server: BWS/1.0 Content-Length: 7691 Content-Type: text/html;charset=gb2312 Connection: Keep-Alive
之所以只收到一部分,是因為我們並不是真的要實作完整的 HTTP 客戶端。正常情況下 HTTP 回應應由伺服器端關閉連線,因此這裡可以在客戶端主動切斷:
[socket readDataWithTimeout:3 tag:1];
[socket writeData:[@"GET / HTTP/1.1\r\n\r\n" dataUsingEncoding:NSUTF8StringEncoding]
withTimeout:3 tag:1];
[socket disconnect];
並實作斷線通知:
- (void)onSocketDidDisconnect:(AsyncSocket *)sock {
NSLog(@"socket did disconnect");
}
socket 通訊中很常見的需求是「讀固定位元組數」,例如每次讀 50 個位元組,讀兩次後關閉。
socket = [[AsyncSocket alloc] initWithDelegate:self];
[socket connectToHost:@"www.baidu.com" onPort:80 error:nil];
data = [[NSMutableData dataWithLength:50] retain];
[socket readDataToLength:50 withTimeout:5 tag:1];
[socket readDataToLength:50 withTimeout:5 tag:2];
[socket writeData:[@"GET / HTTP/1.1\r\n\r\n" dataUsingEncoding:NSUTF8StringEncoding]
withTimeout:3 tag:1];
- (void)onSocket:(AsyncSocket *)sock didReadData:(NSData *)_data withTag:(long)tag {
NSLog(@"did read data");
NSString *message = [[[NSString alloc] initWithData:_data
encoding:NSUTF8StringEncoding] autorelease];
NSLog(@"message is: \n%@", message);
if (tag == 2) {
[socket disconnect]; // 第二次讀完就收工
}
}
這裡的 tag 就發揮了作用:同一個 delegate 方法要處理多次不同目的的讀取,靠 tag 就能分辨目前是第幾階段。
Echo 就是回聲——telnet 送什麼,伺服器就回什麼,是驗證 socket 是否正常最簡便的方式。
socket = [[AsyncSocket alloc] initWithDelegate:self];
NSError *err = nil;
if ([socket acceptOnPort:4322 error:&err]) {
NSLog(@"accept ok.");
} else {
NSLog(@"accept failed.");
}
if (err) {
NSLog(@"error: %@", err);
}
成功時只會看到一行 accept ok.。當有客戶端連線進來(例如用 telnet),delegate 會依序被呼叫:
範例中我們不打算多執行緒、也不支援多客戶端,且伺服器與客戶端維持長連線,直到客戶端斷開才釋放 socket:
- (void)onSocket:(AsyncSocket *)sock didAcceptNewSocket:(AsyncSocket *)newSocket {
if (!acceptSocket) {
acceptSocket = [newSocket retain];
NSLog(@"did accept new socket");
}
}
- (NSRunLoop *)onSocket:(AsyncSocket *)sock wantsRunLoopForNewSocket:(AsyncSocket *)newSocket {
NSLog(@"wants runloop for new socket.");
return [NSRunLoop currentRunLoop];
}
- (BOOL)onSocketWillConnect:(AsyncSocket *)sock {
NSLog(@"will connect");
return YES;
}
- (void)onSocket:(AsyncSocket *)sock didConnectToHost:(NSString *)host port:(UInt16)port {
NSLog(@"did connect to host");
[acceptSocket readDataWithTimeout:-1 tag:1]; // -1 表示不逾時,維持長連線
}
- (void)onSocket:(AsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag {
NSLog(@"did read data");
NSString *message = [[[NSString alloc] initWithData:data
encoding:NSUTF8StringEncoding] autorelease];
NSLog(@"message is: \n%@", message);
[acceptSocket writeData:data withTimeout:2 tag:1]; // 原封不動回傳
}
- (void)onSocket:(AsyncSocket *)sock didWriteDataWithTag:(long)tag {
NSLog(@"message did write");
[acceptSocket readDataWithTimeout:-1 tag:1]; // 繼續等待下一筆
}
- (void)onSocket:(AsyncSocket *)sock willDisconnectWithError:(NSError *)err {
NSLog(@"onSocket:%p willDisconnectWithError:%@", sock, err);
}
- (void)onSocketDidDisconnect:(AsyncSocket *)sock {
NSLog(@"socket did disconnect");
[acceptSocket release];
acceptSocket = nil;
}
關鍵在 timeout 設為 -1,如此才能維持長連線;讀與寫會形成一個循環,讀到就回,回完再讀。
發送端
AsyncUdpSocket *socket = [[AsyncUdpSocket alloc] initWithDelegate:self]; NSData *data = [@"Hello from iPhone" dataUsingEncoding:NSUTF8StringEncoding]; [socket sendData:data toHost:@"192.168.0.165" port:5555 withTimeout:-1 tag:1]; NSLog(@"send udp complete.");
接收端
AsyncUdpSocket *socket = [[AsyncUdpSocket alloc] initWithDelegate:self];
NSError *error = nil;
[socket bindToPort:5555 error:&error];
if (error) {
NSLog(@"error: %@", error);
}
[socket receiveWithTimeout:-1 tag:1];
NSLog(@"start udp server");
至少還要實作這個 delegate:
- (BOOL)onUdpSocket:(AsyncUdpSocket *)sock
didReceiveData:(NSData *)data
withTag:(long)tag
fromHost:(NSString *)host
port:(UInt16)port {
NSLog(@"received data: %@",
[[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding] autorelease]);
return YES;
}
接收端成功印出 received data: Hello from iPhone,就代表資料報已經到手。
組播的接收是實務上更需要留意的部分。過去在 Android 上做過 Wi-Fi 組播被限制的問題,因此特別驗證了 iOS 是否也有類似機制,結果發現並不需要額外解鎖。
iOS 端接收組播
AsyncUdpSocket *socket = [[AsyncUdpSocket alloc] initWithDelegate:self];
NSError *error = nil;
[socket bindToPort:3333 error:&error];
[socket enableBroadcast:YES error:&error];
[socket joinMulticastGroup:@"239.0.0.1" error:&error];
if (error) {
NSLog(@"error: %@", error);
}
[socket receiveWithTimeout:-1 tag:1];
NSLog(@"start udp server");
delegate 的實作與接收普通 UDP 完全一樣,log 中出現 received data: Hello everyone. 即表示成功。發送組播的方式與一般 UDP 發送類似,只是多了一個 join group 的動作。
CocoaAsyncSocket 最大的價值在於把 run loop 上的事件調度細節都收攏起來,讓開發者只要專注在 delegate 的幾個時機點。有幾個慣例值得記住:timeout 設 -1 代表不逾時(長連線必備)、tag 用來在多階段流程中辨識來源、以及 accept 之後記得 retain 新 socket,否則連線會立刻被切斷。
補充:此庫近年已推出以 GCD 為基礎的 GCDAsyncSocket 版本,API 更貼近現代寫法(連線完成、資料讀完各自獨立 delegate 與 dispatch queue)。新專案建議直接採用 GCD 版本,本篇的 delegate 概念仍然通用。