AsyncSocket 中 tag 參數的作用與內部機制詳解

AsyncSocket 中 tag 參數的作用與內部機制詳解

在 iOS/macOS 網絡開發中，AsyncSocket（GCDAsyncSocket 的前身）廣泛用於異步 TCP 通訊。其讀寫方法均帶有一個 tag 參數，許多開發者對其用途存疑。本文從源碼角度徹底解析。

核心結論

tag 參數僅用於在回調方法中匹配發起調用的請求，不會隨數據發送到網絡，也不會從網絡讀取。

讀操作流程

// 發起讀請求
- (void)readDataWithTimeout:(NSTimeInterval)timeout tag:(long)tag;

// 回調
- (void)onSocket:(AsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag;

1. 調用 readDataWithTimeout:tag: 時，內部創建 AsyncReadPacket 對象，封裝 tag、超時時間等信息；
2. 該對象被加入 theReadQueue 隊列；
3. 當 CFStream 回調有數據可讀時，從隊列取出最早的 AsyncReadPacket，提取其 tag；
4. 最終回調 onSocket:didReadData:withTag: 時將該 tag 透傳給委託。

寫操作流程（完全對稱）

// 發起寫請求
- (void)writeData:(NSData *)data withTimeout:(NSTimeInterval)timeout tag:(long)tag;

// 回調
- (void)onSocket:(AsyncSocket *)sock didWriteDataWithTag:(long)tag;

寫入時同樣封裝 AsyncWritePacket 入隊 theWriteQueue，完成後回調攜帶原 tag。

關鍵注意點

• 發送端的 tag 與接收端的 tag 完全無關：雙方各自維護獨立的讀/寫隊列與 tag 空間；
• tag 可為任意 long 整數，常用枚舉常量語義化：
  #define TAG_WELCOME 10
#define TAG_CAPABILITIES 11
#define TAG_MSG 12
• 委託方法中通過 switch(tag) 分發業務邏輯，避免在數據中解析協議頭，極大簡化代碼。

官方文檔原文說明

In addition to this you've probably noticed the tag parameter. The tag you pass during the read/write operation is passed back to you via the delegate method once the read/write operation completes. It does not get sent over the socket or read from the socket. It is designed to help simplify the code in your delegate method.

典型委託實現示例

- (void)onSocket:(AsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag {
    switch (tag) {
        case TAG_WELCOME:
            // 忽略歡迎消息
            break;
        case TAG_CAPABILITIES:
            [self processCapabilities:data];
            break;
        case TAG_MSG:
            [self processMessage:data];
            break;
        default:
            break;
    }
}

源碼關鍵片段（簡化版）

// 讀請求入隊
- (void)readDataWithTimeout:(NSTimeInterval)timeout tag:(long)tag {
    AsyncReadPacket *packet = [[AsyncReadPacket alloc] init];
    packet.tag = tag;
    packet.timeout = timeout;
    [theReadQueue addObject:packet];
    // ... 設置 CFStream 回調 ...
}

// CFStream 回調中取出包並觸發委託
- (void)_onReadStreamEvent:(CFStreamEventType)event {
    AsyncReadPacket *packet = [theReadQueue firstObject];
    long tag = packet.tag;
    [delegate onSocket:self didReadData:data withTag:tag];
}

最佳實踐建議

1. 定義枚舉或 #define 常量管理 tag，避免魔術數字；
2. 協議設計時，將消息類型編碼在 tag 而非數據頭部，解耦協議解析與業務邏輯；
3. 異步並發場景下，tag 可攜帶請求上下文（如請求 ID、回調塊指針），實現「發起-回調」配對。

理解 tag 的本質是「用戶態請求標識」，而非「協議字段」，能幫助你設計更清晰、可維護的網絡層架構。