iOS 的 XMPPFramework 简介

XMPPFramework是一个OS X/iOS平台的开源项目，使用Objective-C实现了XMPP协议（RFC-3920），同时还提供了用于读写XML的工具，大大简化了基于XMPP的通信应用的开发。

1. 登录和好友上下线

1.1XMPP中常用对象们

XMPPStream：xmpp基础服务类

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(@"Connect Error: %@", [[error userInfo] description]);

}

}

}

connect成功之后会依次调用XMPPStreamDelegate的方法，首先调用

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

...

然后

- (void)xmppStreamDidConnect:(XMPPStream *)sender

在该方法下面需要使用xmppStream 的authenticateWithPassword方法进行密码验证，成功的话会响应delegate的方法，就是下面这个

- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender

1.3上线

实现 - (void)xmppStreamDidAuthenticate:(XMPPStream *)sender 委托方法

- (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好友状态

获取好友状态，通过实现

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

...

方法，当接收到 presence 标签的内容时，XMPPFramework 框架回调该方法

一个 presence 标签的格式一般如下：

presence 的状态：

available 上线

away 离开

do not disturb 忙碌

unavailable 下线

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

NSString *presenceType = [presence type];

NSString *presenceFromUser = [[presence from] user];

if (![presenceFromUser isEqualToString:[[sender myJID] user]]) {

if ([presenceType isEqualToString:@"available"]) {

//

} else if ([presenceType isEqualToString:@"unavailable"]) {

//

}

}

}

2. 接收消息和发送消息

2.1接收消息

通过实现

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

方法

当接收到 message 标签的内容时，XMPPFramework 框架回调该方法

根据 XMPP 协议，消息体的内容存储在标签 body 内

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

NSString *messageBody = [[message elementForName:@"body"] stringValue];

}

2.2发送消息

发送消息，我们需要根据 XMPP 协议，将数据放到标签内，例如：

- (void)sendMessage:(NSString *) message toUser:(NSString *) user {

NSXMLElement *body = [NSXMLElement elementWithName:@"body"];

[body setStringValue:message];

NSXMLElement *message = [NSXMLElement elementWithName:@"message"];

[message addAttributeWithName:@"type" stringValue:@"chat"];

NSString *to = [NSString stringWithFormat:@"%@@example.com", user];

[message addAttributeWithName:@"to" stringValue:to];

[message addChild:body];

[self.xmppStream sendElement:message];

}

3. 获取好友信息和删除好友

3.1好友列表和好友名片

[_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添加好友

//name为用户账号

- (void)XMPPAddFriendSubscribe:(NSString *)name

{

//XMPPHOST 就是服务器名，  主机名

XMPPJID *jid = [XMPPJID jidWithString:[NSString stringWithFormat:@"%@@%@",name,XMPPHOST]];

//[presence addAttributeWithName:@"subscription" stringValue:@"好友"];

[xmppRoster subscribePresenceToUser:jid];

}

3.3收到添加好友的请求

- (void)xmppRoster:(XMPPRoster *)sender didReceivePresenceSubscriptionRequest:(XMPPPresence *)presence

{

//取得好友状态

NSString *presenceType = [NSString stringWithFormat:@"%@", [presence type]]; //online/offline

//请求的用户

NSString *presenceFromUser =[NSString stringWithFormat:@"%@", [[presence from] user]];

NSLog(@"presenceType:%@",presenceType);

NSLog(@"presence2:%@  sender2:%@",presence,sender);

XMPPJID *jid = [XMPPJID jidWithString:presenceFromUser];

//接收添加好友请求

[xmppRoster acceptPresenceSubscriptionRequestFrom:jid andAddToRoster:YES];

}

3.4删除好友

//删除好友，name为好友账号

- (void)removeBuddy:(NSString *)name

{

XMPPJID *jid = [XMPPJID jidWithString:[NSString stringWithFormat:@"%@@%@",name,XMPPHOST]];

[self xmppRoster] removeUser:jid];

}

4. 聊天室

初始化聊天室

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

{

DDLogInfo(@"%@: %@", THIS_FILE, THIS_METHOD);

}

加入聊天室，使用昵称

[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;

离开房间

[xmppRoom deactivate:xmppStream];

XMPPRoomDelegate的其他代理方法:

离开聊天室

- (void)xmppRoomDidLeave:(XMPPRoom *)sender

{

DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);

}

新人加入群聊

- (void)xmppRoom:(XMPPRoom *)sender occupantDidJoin:(XMPPJID *)occupantJID

{

DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);

}

有人退出群聊

- (void)xmppRoom:(XMPPRoom *)sender occupantDidLeave:(XMPPJID *)occupantJID

{

DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);

}

有人在群里发言

- (void)xmppRoom:(XMPPRoom *)sender didReceiveMessage:(XMPPMessage *)message fromOccupant:(XMPPJID *)occupantJID

{

DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);

}

5. 消息回执

这个是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 *recieved = [NSXMLElement elementWithName:@"received" xmlns:@"urn:xmpp:receipts"];

[msg addChild:recieved];

//发送回执

[self.xmppStream sendElement:msg];

}

}else

{

NSXMLElement *received = [message elementForName:@"received"];

if (received)

{

if ([received.xmlns isEqualToString:@"urn:xmpp:receipts"])//消息回执

{

//发送成功

NSLog(@"message send success!");

}

}

}

//消息处理

//...

}

6. 添加AutoPing

为了监听服务器是否有效，增加心跳监听。用XEP-0199协议，在XMPPFrameWork框架下，封装了 XMPPAutoPing 和 XMPPPing两个类都可以使用，因为XMPPAutoPing已经组合进了XMPPPing类，所以XMPPAutoPing使用起来更方便。

//初始化并启动ping

-(void)autoPingProxyServer:(NSString*)strProxyServer

{

_xmppAutoPing = [[XMPPAutoPingalloc] init];

[_xmppAutoPingactivate:_xmppStream];

[_xmppAutoPingaddDelegate:selfdelegateQueue:  dispatch_get_main_queue()];

_xmppAutoPing.respondsToQueries = YES;

_xmppAutoPing.pingInterval=2;//ping 间隔时间

if (nil != strProxyServer)

{

_xmppAutoPing.targetJID = [XMPPJID jidWithString: strProxyServer ];//设置ping目标服务器，如果为nil,则监听socketstream当前连接上的那个服务器

}

}

//卸载监听

[_xmppAutoPing   deactivate];

[_xmppAutoPing   removeDelegate:self];

_xmppAutoPing = nil;

//ping XMPPAutoPingDelegate的委托方法:

- (void)xmppAutoPingDidSendPing:(XMPPAutoPing *)sender

{

NSLog(@"- (void)xmppAutoPingDidSendPing:(XMPPAutoPing *)sender");

}

- (void)xmppAutoPingDidReceivePong:(XMPPAutoPing *)sender

{

NSLog(@"- (void)xmppAutoPingDidReceivePong:(XMPPAutoPing *)sender");

}

- (void)xmppAutoPingDidTimeout:(XMPPAutoPing *)sender

{

NSLog(@"- (void)xmppAutoPingDidTimeout:(XMPPAutoPing *)sender");

}

（原文地址。作者：易颖。本文为作者授权转载，需要转载请联系作者。）

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 158,847评论 4赞 362
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,208评论 1赞 292
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 108,587评论 0赞 243
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 43,942评论 0赞 205
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,332评论 3赞 287
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,587评论 1赞 218
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,853评论 2赞 312
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,568评论 0赞 198
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,273评论 1赞 242
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2赞 246
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1赞 260
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,373评论 2赞 253
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,031评论 3赞 236
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0赞 195
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2赞 274
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2赞 269

推荐阅读更多精彩内容

  • iOS 的 XMPPFramework
    通讯协议聊天应用XMPPFramework XMPPFramework是一个OS X/iOS平台的开源项目，使用O...
    真爱要有你才完美阅读 396评论 0赞 2
  • XMPP实现3
    注册，获取好友列表，聊天 我们的注册功能实现上跟登录功能的步骤大致相当 首先需要在我们的XMPPManager类中...
    Axela阅读 557评论 1赞 0
  • ios中XMPPFramework 简介
    本文链接：http://www.cocoachina.com/ios/20141219/10703.html XM...
    小人不才阅读 535评论 1赞 0
  • XMPP(3)
    本篇文章是整理以前在CSDN上所发表的文章，更新文章内容，更详细地描述操作，以方便大家阅读和理解。 本篇文章的内容...
    随风飘荡的小逗逼阅读 503评论 0赞 0
  • 年味儿
    二十三糖官粘，二十四扫房子，二十五磨豆腐，二十六蒸馒头，二十七杀公鸡，男女老少集市购过年物品，笑声不断。
    平静的心情阅读 176评论 0赞 0