您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 教學 >> iOS 相關教學

iOS 中使用 AsyncSocket 庫處理 Socket 通訊的完整用法

編輯:iOS 相關教學

Socket 可以實現類似 QQ 那樣的即時訊息功能:客戶端與伺服器之間建立長連接,在這條通道上雙向收發訊息;客戶端則透過定時發送心跳包來維持並檢測長連接的存活狀態。

iOS 開發中要使用 socket,多數人會選擇第三方庫 AsyncSocket(CocoaAsyncSocket),這個庫的確非常成熟強大。

一、AsyncSocket 的特性

AsyncSocket 類別支援 TCP,AsyncUdpSocket 支援 UDP。前者封裝了 CFSocket 與 CFStream,提供完整的非同步操作與 delegate 支援,主要特性如下:

  • 佇列化的非阻塞讀寫,可選擇是否設定逾時;呼叫之後它會在完成時通知你。
  • 自動的 socket 接受機制:呼叫接受連線後,它會為每個連線啟動新的實例,也可以立即關閉這些連線。
  • 完整的 delegate 支援:錯誤、連線、接收、完整讀取、完整寫入、進度以及斷線,都能透過代理回調取得。
  • 基於 Run Loop 而非執行緒:可以在主執行緒或工作執行緒中使用,但並非必要。它以非同步方式呼叫代理方法,並在回調中帶入 socket 參數,方便在多實例間做區分。
  • 自包含在單一類別中,無需自己操作 CFStream 或 socket。
  • 支援 IPv4 與 IPv6 的 TCP 串流。

AsyncUdpSocket 是 UDP/IP 的 socket 庫,同樣包裝自 CFSocket,運作方式與 TCP 版本相似,只是用於處理 UDP,同樣具備非阻塞佇列、完整代理支援、基於 Run Loop 以及支援 IPv4/IPv6 等特點。

實務上通常會在 AsyncSocket 外再包一層,依需求對外提供「連接、斷開、發送訊息」等介面;接收到的訊息則可以透過通知、delegate 或 block 拋給業務層。由於一個使用者一般只需要一條長連接,用單例來封裝最為合適。

二、定義單例類 LGSocketServe

// LGSocketServe.h
#import <Foundation/Foundation.h>
#import "AsyncSocket.h"

@interface LGSocketServe : NSObject <AsyncSocketDelegate>

+ (LGSocketServe *)sharedSocketServe;

@end
// LGSocketServe.m
#import "LGSocketServe.h"

@implementation LGSocketServe

static LGSocketServe *socketServe = nil;

#pragma mark - public static methods

+ (LGSocketServe *)sharedSocketServe {
    @synchronized(self) {
        if (socketServe == nil) {
            socketServe = [[[self class] alloc] init];
        }
    }
    return socketServe;
}

+ (id)allocWithZone:(NSZone *)zone {
    @synchronized(self) {
        if (socketServe == nil) {
            socketServe = [super allocWithZone:zone];
            return socketServe;
        }
    }
    return nil;
}

@end

三、建立長連接

// LGSocketServe.h
@property (nonatomic, strong) AsyncSocket *socket;   // socket
- (void)startConnectSocket;
// LGSocketServe.m
// 依實際環境設定
#define HOST @"192.168.0.1"
#define PORT 8080
// 連線逾時
#define TIME_OUT 20

- (void)startConnectSocket {
    self.socket = [[AsyncSocket alloc] initWithDelegate:self];
    [self.socket setRunLoopModes:[NSArray arrayWithObject:NSRunLoopCommonModes]];
    if (![self SocketOpen:HOST port:PORT]) {
        // 連線失敗的處理
    }
}

- (NSInteger)SocketOpen:(NSString *)addr port:(NSInteger)port {
    if (![self.socket isConnected]) {
        NSError *error = nil;
        [self.socket connectToHost:addr onPort:port withTimeout:TIME_OUT error:&error];
    }
    return 0;
}

// 長連接成功後的非同步回調
- (void)onSocket:(AsyncSocket *)sock didConnectToHost:(NSString *)host port:(UInt16)port {
    NSLog(@"didConnectToHost");
}

四、心跳檢測

// LGSocketServe.h
@property (nonatomic, retain) NSTimer *heartTimer;   // 心跳計時器
// LGSocketServe.m
- (void)onSocket:(AsyncSocket *)sock didConnectToHost:(NSString *)host port:(UInt16)port {
    NSLog(@"didConnectToHost");

    // 透過計時器週期性發送訊息,用來檢測長連接是否還活著
    self.heartTimer = [NSTimer scheduledTimerWithTimeInterval:2
                                                       target:self
                                                     selector:@selector(checkLongConnectByServe)
                                                     userInfo:nil
                                                      repeats:YES];
    [self.heartTimer fire];
}

// 心跳
- (void)checkLongConnectByServe {
    // 向伺服器發送固定內容,用來維持長連接
    NSString *longConnect = @"connect is here";
    NSData *data = [longConnect dataUsingEncoding:NSUTF8StringEncoding];
    [self.socket writeData:data withTimeout:1 tag:1];
}

也就是說,在連線成功的回調裡啟動計時器,每隔兩秒送出固定訊息。具體的間隔與內容只要和伺服器約定好即可。

五、斷開連接

使用者主動斷開時,標記 userData 以便後續判斷是否重連:

// LGSocketServe.h
- (void)cutOffSocket;

// LGSocketServe.m
- (void)cutOffSocket {
    self.socket.userData = SocketOfflineByUser;
    [self.socket disconnect];
}

Wi-Fi 斷開導致 socket 中斷時,會回調 willDisconnectWithError:,此時 err.code == 57:

- (void)onSocket:(AsyncSocket *)sock willDisconnectWithError:(NSError *)err {
    NSLog(@"willDisconnectWithError %ld  err = %@", (long)sock.userData, [err description]);
    if (err.code == 57) {
        self.socket.userData = SocketOfflineByWifiCut;
    }
}

六、重新連接

- (void)onSocketDidDisconnect:(AsyncSocket *)sock {
    NSLog(@"sorry the connect is failure %ld", (long)sock.userData);

    if (sock.userData == SocketOfflineByServer) {
        // 伺服器端掉線,需要重連
        [self startConnectSocket];
    } else if (sock.userData == SocketOfflineByUser) {
        // 使用者主動斷開,不重連
        return;
    } else if (sock.userData == SocketOfflineByWifiCut) {
        // Wi-Fi 斷開,不重連
        return;
    }
}

透過 sock.userData 標記斷線原因,就能精準決定要不要自動重連,避免「使用者自己關掉卻又被自動連回去」這類惱人的 bug。

七、發送訊息

// LGSocketServe.h
- (void)sendMessage:(id)message;

// LGSocketServe.m
// 寫入逾時,-1 表示不使用逾時
#define WRITE_TIME_OUT -1

- (void)sendMessage:(id)message {
    NSData *cmdData = [message dataUsingEncoding:NSUTF8StringEncoding];
    [self.socket writeData:cmdData withTimeout:WRITE_TIME_OUT tag:1];
}

// 發送成功的回調
- (void)onSocket:(AsyncSocket *)sock didWriteDataWithTag:(long)tag {
}

八、接收訊息

// 讀取逾時 -1 表示不使用逾時
#define READ_TIME_OUT -1
#define MAX_BUFFER    1024

// 發送成功之後,隨即掛上等下一批資料
- (void)onSocket:(AsyncSocket *)sock didWriteDataWithTag:(long)tag {
    [self.socket readDataWithTimeout:-1 buffer:nil bufferOffset:0 maxLength:MAX_BUFFER tag:0];
}

// 接收成功的回調
- (void)onSocket:(AsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag {
    // 伺服器回傳的資料量較大時可能分多次送達。
    // 因此設定 MAX_BUFFER 限制單次讀取量,
    // 當 data.length < MAX_BUFFER 時,我們認為一個完整訊息已經收完,才進行解析。
    if (data.length < MAX_BUFFER) {
        NSDictionary *dic = [NSJSONSerialization JSONObjectWithData:data
                                                           options:NSJSONReadingMutableLeaves
                                                             error:nil];
        NSLog(@"%@", dic);
        // 解析後的訊息可以透過通知、delegate 或 block 拋給業務層
    }

    // 繼續讀取下一段
    [self.socket readDataWithTimeout:READ_TIME_OUT buffer:nil bufferOffset:0 maxLength:MAX_BUFFER tag:0];
}

九、錯誤處理

- (void)onSocket:(AsyncSocket *)sock willDisconnectWithError:(NSError *)err {
    NSData *unreadData = [sock unreadData];   // 取出尚未讀完的緩衝區
    if (unreadData.length > 0) {
        // 把僅剩的資料當成一筆結果交回去處理
        [self onSocket:sock didReadData:unreadData withTag:0];
    } else {
        NSLog(@"willDisconnectWithError %ld  err = %@", (long)sock.userData, [err description]);
        if (err.code == 57) {
            self.socket.userData = SocketOfflineByWifiCut;
        }
    }
}

透過 unreadData 把來不及讀取的資料撈出來,可以避免連線斷在「資料收到一半」時整批丟失。

十、使用方式

#import "LGSocketServe.h"

LGSocketServe *socketServe = [LGSocketServe sharedSocketServe];
// 連接前先斷開,避免上次的 socket 沒關閉導致閃退
[socketServe cutOffSocket];
socketServe.socket.userData = SocketOfflineByServer;
[socketServe startConnectSocket];

// 發送訊息,這裡只是舉例,實際格式依伺服器協議而定
[socketServe sendMessage:@"hello world"];

整體而言,用 AsyncSocket 打造長連接的關鍵環節就四件事:建立連線、心跳維持、斷線判斷與重連、以及收發訊息緩衝區的處理。把這四塊做扎實,即時通訊的基本骨架就完成了。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved