Roster 是 XMPP 中代表「好友清單」的概念。取得好友列表的標準做法是送出一個 iq 形式的 get 查詢,並在回應中解析 query 節點下的 item 元素。本文說明封裝流程,並附上 m 檔中對應的回呼屬性宣告。
/*! * @Author Dylan. * * Roster */ typedef void (^refreshRosterListFailure) (id); typedef void (^Rosterlist) (id); /*! * @Author Dylan. * * request for roster list. IQ */ - (void)refreshRosterList:(Rosterlist)success failure:(refreshRosterListFailure)failure; @property (nonatomic, strong) NSMutableDictionary *rosterDict;
#pragma mark - rosterList
- (void)initRosterlist
{
self.rosterDict = [NSMutableDictionary dictionary];
}
- (void)refreshRosterList:(Rosterlist)success failure:(refreshRosterListFailure)failure
{
// call back
self.refreshSuccess = success;
self.refreshFailure = failure;
NSXMLElement *query = [NSXMLElement elementWithName:@"query" xmlns:@"jabber:iq:roster"];
NSXMLElement *iq = [NSXMLElement elementWithName:@"iq"];
XMPPJID *myJID = self.xmppStream.myJID;
[iq addAttributeWithName:@"from" stringValue:myJID.description];
[iq addAttributeWithName:@"to" stringValue:myJID.domain];
[iq addAttributeWithName:@"id" stringValue:@"123456"];
[iq addAttributeWithName:@"type" stringValue:@"get"];
[iq addChild:query];
[self.xmppStream sendElement:iq];
}
- (void)xmppStream:(XMPPStream *)sender
didFailToSendIQ:(XMPPIQ *)iq
error:(NSError *)error
{
self.refreshFailure(error);
}
// get user list
- (BOOL)xmppStream:(XMPPStream *)sender didReceiveIQ:(XMPPIQ *)iq
{
// kind of result
if ([@"result" isEqualToString:iq.type]) {
NSXMLElement *query = iq.childElement;
if ([@"query" isEqualToString:query.name]) {
NSArray *items = [query children];
for (NSXMLElement *item in items) {
NSString *jid = [item attributeStringValueForName:@"jid"];
XMPPJID *xmppJID = [XMPPJID jidWithString:jid];
[_rosterDict setValue:xmppJID forKey:jid];
}
}
// block
self.refreshSuccess(_rosterDict);
return YES;
}
NSLog(@"get iq error");
return NO;
}
@end
順便把 m 檔中宣告的所有回呼屬性列出來,可以清楚看到整個封裝層對外提供了哪些事件:
@interface ADXMPPConn () /*! * @Author Dylan. * * Call back Block */ @property (nonatomic, copy) connectSuccess connSuccess; @property (nonatomic, copy) AuthenticateFailure authenFailure; @property (nonatomic, copy) registerSuccess regisSuccess; @property (nonatomic, copy) registerFailure regisFailure; /*! call back block */ @property (nonatomic, copy) sendSuccess success; @property (nonatomic, copy) sendFailure failure; /*! call back block */ @property (nonatomic, copy) refreshRosterListFailure refreshFailure; @property (nonatomic, copy) Rosterlist refreshSuccess; @end
整個請求可以拆成三個階段。組裝:建立一個帶有 jabber:iq:roster 命名空間的 query 子節點,放進 iq 中,並標記 type="get"。送出:透過 sendElement: 把 iq 寫入串流。接收:伺服器回應時觸發 xmppStream:didReceiveIQ:,我們判斷 type 是否為 result,再逐一取出 item 的 jid 屬性,組進字典後觸發成功回呼。
iq 的 id 應該唯一。 這裡把 id 寫死成 @"123456",在同時有多個 iq 往返的情況下會無法分辨回應屬於哪個請求。實務上建議用遞增序號或 UUID 產生 id,並維護一份 id → 回呼 的表,在 didReceiveIQ: 中依 id 派發,這樣才能支援併發請求。
要處理 error 型別。 目前只判斷了 result,其餘一律當成失敗並印一行 log。更完整的做法是明確判斷 type 是否為 error,並從 error 子節點中取出 condition,才能給呼叫方有意義的錯誤資訊。
回呼記得做 nil 檢查。 self.refreshSuccess(_rosterDict); 在呼叫方未傳入時會 crash,加上 if (self.refreshSuccess) 較安全。
字典的 key 建議正規化。 這裡直接用伺服器回傳的原始 jid 字串當 key,但 XMPP 的 JID 有大小寫與資源部分差異。建議統一用 [xmppJID.full] 或 [xmppJID bare] 作為 key,避免同一個好友被存成兩筆。