您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發綜合

iOS 的 XMPPFramework 入門指南

編輯:iOS 開發綜合

XMPPFramework 是一個面向 OS X / iOS 的開源項目,用 Objective-C 實現了 XMPP 協議(RFC-3920),並附帶了一套讀寫 XML 的工具,讓基於 XMPP 的即時通訊應用開發變得輕鬆不少。

一、登錄與好友上下線

1.1 常用對象速覽

  • XMPPStream:整個框架的基礎服務類,連接與數據收發都靠它
  • XMPPRoster:好友列表
  • XMPPRosterCoreDataStorage:好友列表(賬號)在 Core Data 中的存儲實現
  • XMPPvCardCoreDataStorage:好友名片(昵稱、簽名、性別等)在 Core Data 中的存儲實現
  • XMPPvCardTemp:好友名片實體類,從數據庫取出的都是它
  • XMPPvCardAvatarModule:好友頭像
  • XMPPReconnect:斷線自動重連
  • XMPPRoom:多用戶聊天室支持
  • XMPPPubSub:發布訂閱

1.2 連接服務器

登錄的本質就是建立一條到 XMPP 服務器的連接:

- (void)connect {
    if (self.xmppStream == nil) {
        self.xmppStream = [[XMPPStream alloc] init];
        [self.xmppStream addDelegate:self delegateQueue:dispatch_get_main_queue()];
    }

    if (![self.xmppStream isConnected]) {
        NSString *username = [[NSUserDefaults standardUserDefaults] objectForKey:@"username"];
        XMPPJID *jid = [XMPPJID jidWithUser:username domain:@"lizhen" resource:@"Ework"];
        [self.xmppStream setMyJID:jid];
        [self.xmppStream setHostName:@"10.4.125.113"];

        NSError *error = nil;
        if (![self.xmppStream connect:&error]) {
            NSLog(@"ConnectError:%@", [[error userInfo] description]);
        }
    }
}

連接成功後,XMPPStreamDelegate 會按順序回調一連串方法。先是 socket 層面建立:

- (void)xmppStream:(XMPPStream *)sender socketDidConnect:(GCDAsyncSocket *)socket

然後是流打開:

- (void)xmppStreamDidConnect:(XMPPStream *)sender

在這個方法裡調用 authenticateWithPassword: 進行密碼驗證,驗證通過後觸發:

- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender

1.3 上線

驗證通過後,發送一條 available 類型的 presence 廣播自己上線:

- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender {
    XMPPPresence *presence = [XMPPPresence presenceWithType:@"available"];
    [self.xmppStream sendElement:presence];
}

1.4 下線並斷開

- (void)disconnect {
    XMPPPresence *presence = [XMPPPresence presenceWithType:@"unavailable"];
    [self.xmppStream sendElement:presence];
    [self.xmppStream disconnect];
}

1.5 好友狀態

好友上下線的判斷,依賴 presence 標簽:

- (void)xmppStream:(XMPPStream *)sender didReceivePresence:(XMPPPresence *)presence

一個 presence 標簽大致長這樣:

常見狀態有四種:available(在線)、away(離開)、do not disturb(忙碌)、unavailable(離線)。

- (void)xmppStream:(XMPPStream *)sender didReceivePresence:(XMPPPresence *)presence {
    NSString *presenceType = [presence type];
    NSString *presenceFromUser = [[presence from] user];

    // 過濾掉自己發出的 presence
    if (![presenceFromUser isEqualToString:[[sender myJID] user]]) {
        if ([presenceType isEqualToString:@"available"]) {
            // 好友上線
        } else if ([presenceType isEqualToString:@"unavailable"]) {
            // 好友下線
        }
    }
}

二、收發消息

2.1 接收消息

收到 message 標簽時框架回調:

- (void)xmppStream:(XMPPStream *)sender didReceiveMessage:(XMPPMessage *)message {
    // 按 XMPP 協議,消息正文放在 body 標簽內
    NSString *messageBody = [[message elementForName:@"body"] stringValue];
}

2.2 發送消息

發送時按協議組裝節點即可:

- (void)sendMessage:(NSString *)message toUser:(NSString *)user {
    NSXMLElement *body = [NSXMLElement elementWithName:@"body"];
    [body setStringValue:message];

    NSXMLElement *messageNode = [NSXMLElement elementWithName:@"message"];
    [messageNode addAttributeWithName:@"type" stringValue:@"chat"];

    NSString *to = [NSString stringWithFormat:@"%@@example.com", user];
    [messageNode addAttributeWithName:@"to" stringValue:to];
    [messageNode addChild:body];

    [self.xmppStream sendElement:messageNode];
}

三、好友管理

3.1 好友列表與名片相關 API

// 拉取好友列表
[_xmppRoster fetchRoster];

// 收到單個好友節點
- (void)xmppRoster:(XMPPRoster *)sender didRecieveRosterItem:(NSXMLElement *)item

// 好友列表拉取完畢
- (void)xmppRosterDidEndPopulating:(XMPPRoster *)sender

// 向服務器請求某個聯繫人的名片
- (void)fetchvCardTempForJID:(XMPPJID *)jid;

// 數據庫有就不請求,沒有才發請求
- (void)fetchvCardTempForJID:(XMPPJID *)jid ignoreStorage:(BOOL)ignoreStorage;

// 取名片:數據庫有則直接返回,沒有則返回空並向服務器抓取
- (XMPPvCardTemp *)vCardTempForJID:(XMPPJID *)jid shouldFetch:(BOOL)shouldFetch;

// 更新自己的名片
- (void)updateMyvCardTemp:(XMPPvCardTemp *)vCardTemp;

// 收到聯繫人名片的回調
- (void)xmppvCardTempModule:(XMPPvCardTempModule *)vCardTempModule
        didReceivevCardTemp:(XMPPvCardTemp *)vCardTemp
                      forJID:(XMPPJID *)jid

3.2 添加好友

添加好友在 XMPP 裡本質是訂閱對方的 presence:

- (void)XMPPAddFriendSubscribe:(NSString *)name {
    XMPPJID *jid = [XMPPJID jidWithString:[NSString stringWithFormat:@"%@@%@", name, XMPPHOST]];
    [xmppRoster subscribePresenceToUser:jid];
}

3.3 收到添加好友的請求

- (void)xmppRoster:(XMPPRoster *)sender didReceivePresenceSubscriptionRequest:(XMPPPresence *)presence {
    NSString *presenceFromUser = [NSString stringWithFormat:@"%@", [[presence from] user]];
    XMPPJID *jid = [XMPPJID jidWithString:presenceFromUser];

    // 同意並加入本地好友列表
    [xmppRoster acceptPresenceSubscriptionRequestFrom:jid andAddToRoster:YES];
}

3.4 刪除好友

- (void)removeBuddy:(NSString *)name {
    XMPPJID *jid = [XMPPJID jidWithString:[NSString stringWithFormat:@"%@@%@", name, XMPPHOST]];
    [self.xmppRoster removeUser:jid];
}

四、聊天室

初始化聊天室對象並激活:

XMPPJID *roomJID = [XMPPJID jidWithString:ROOM_JID];
xmppRoom = [[XMPPRoom alloc] initWithRoomStorage:self jid:roomJID];
[xmppRoom activate:xmppStream];
[xmppRoom addDelegate:self delegateQueue:dispatch_get_main_queue()];

房間創建成功:

- (void)xmppRoomDidCreate:(XMPPRoom *)sender

用昵稱加入房間:

[xmppRoom joinRoomUsingNickname:@"quack" history:nil];

加入成功後拉取房間信息:

- (void)xmppRoomDidJoin:(XMPPRoom *)sender {
    [xmppRoom fetchConfigurationForm];
    [xmppRoom fetchBanList];
    [xmppRoom fetchMembersList];
    [xmppRoom fetchModeratorsList];
}

房間存在時,分別回調:

- (void)xmppRoom:(XMPPRoom *)sender didFetchBanList:(NSArray *)items;
- (void)xmppRoom:(XMPPRoom *)sender didFetchMembersList:(NSArray *)items;
- (void)xmppRoom:(XMPPRoom *)sender didFetchModeratorsList:(NSArray *)items;

房間不存在時,回調:

- (void)xmppRoom:(XMPPRoom *)sender didNotFetchBanList:(XMPPIQ *)iqError;
- (void)xmppRoom:(XMPPRoom *)sender didNotFetchMembersList:(XMPPIQ *)iqError;
- (void)xmppRoom:(XMPPRoom *)sender didNotFetchModeratorsList:(XMPPIQ *)iqError;

XMPPRoomDelegate 裡還有幾個常用的成員事件:

// 離開房間
- (void)xmppRoomDidLeave:(XMPPRoom *)sender

// 新人加入
- (void)xmppRoom:(XMPPRoom *)sender occupantDidJoin:(XMPPJID *)occupantJID

// 有人退出
- (void)xmppRoom:(XMPPRoom *)sender occupantDidLeave:(XMPPJID *)occupantJID

// 房間內有人發言
- (void)xmppRoom:(XMPPRoom *)sender didReceiveMessage:(XMPPMessage *)message fromOccupant:(XMPPJID *)occupantJID

離開房間只需停用:

[xmppRoom deactivate:xmppStream];

五、消息回執(XEP-0184)

很多 IM 場景需要「已送達」提示,這靠 XEP-0184 協議實現。

發送方:附加回執請求

NSString *siID = [XMPPStream generateUUID];

XMPPMessage *message = [XMPPMessage messageWithType:@"chat" to:jid elementID:siID];
NSXMLElement *receipt = [NSXMLElement elementWithName:@"request" xmlns:@"urn:xmpp:receipts"];
[message addChild:receipt];
[message addBody:@"測試"];
[self.xmppStream sendElement:message];

接收方:收到請求後回執

- (void)xmppStream:(XMPPStream *)sender didReceiveMessage:(XMPPMessage *)message {

    NSXMLElement *request = [message elementForName:@"request"];
    if (request) {
        if ([request.xmlns isEqualToString:@"urn:xmpp:receipts"]) {
            // 組裝並發送回執
            XMPPMessage *msg = [XMPPMessage messageWithType:[message attributeStringValueForName:@"type"]
                                                        to:message.from
                                                 elementID:[message attributeStringValueForName:@"id"]];
            NSXMLElement *received = [NSXMLElement elementWithName:@"received" xmlns:@"urn:xmpp:receipts"];
            [msg addChild:received];
            [self.xmppStream sendElement:msg];
        }
    } else {
        NSXMLElement *received = [message elementForName:@"received"];
        if (received && [received.xmlns isEqualToString:@"urn:xmpp:receipts"]) {
            NSLog(@"消息發送成功");
        }
    }

    // 其他消息處理邏輯
}

六、心跳與自動重連

長連接必須有心跳來探測服務器是否還活著。XMPPFramework 基於 XEP-0199 封裝了 XMPPAutoPing 和 XMPPPing 兩個類。由於 XMPPAutoPing 內部已經組合了 XMPPPing,直接使用它更省事。

// 啟動 ping
- (void)autoPingProxyServer:(NSString *)strProxyServer {
    _xmppAutoPing = [[XMPPAutoPing alloc] init];
    [_xmppAutoPing activate:_xmppStream];
    [_xmppAutoPing addDelegate:self delegateQueue:dispatch_get_main_queue()];

    _xmppAutoPing.respondsToQueries = YES;
    _xmppAutoPing.pingInterval = 2;   // 心跳間隔(秒)

    if (strProxyServer) {
        // 指定 ping 目標;為 nil 時監聽當前連接的服務器
        _xmppAutoPing.targetJID = [XMPPJID jidWithString:strProxyServer];
    }
}

// 卸載
- (void)stopAutoPing {
    [_xmppAutoPing deactivate];
    [_xmppAutoPing removeDelegate:self];
    _xmppAutoPing = nil;
}

相關回調:

- (void)xmppAutoPingDidSendPing:(XMPPAutoPing *)sender
- (void)xmppAutoPingDidReceivePong:(XMPPAutoPing *)sender
- (void)xmppAutoPingDidTimeout:(XMPPAutoPing *)sender

實戰中通常把 pingInterval 設為十幾到幾十秒,並在連續超時若干次後觸發 XMPPReconnect 重連,而不是一次超時就斷線。

小結

XMPPFramework 的封裝粒度很舒服:底層的 XML 節點拼裝由框架代勞,你只需要實現幾個 delegate 方法就能完成登錄、好友、消息、群聊、回執、心跳這一整條鏈路。真正需要花時間設計的,反倒是業務層的離線消息補發、多設備登入互踢這些問題。

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