【iOS XMPP】使用XMPPFramewok
【iOS XMPP】使用XMPPFramewok（一）：添加XMPPFramework（XCode 4.6.2）
XMPPFramework
GitHub: https://github.com/robbiehanson/XMPPFramework
获取源代码
git clone https://github.com/robbiehanson/XMPPFramework.git
checkout XMPPFramework 一个最新的 branch
添加依赖
> 拷贝 <XMPPFramework>/Vendor/CocoaLumberjack 到项目根目录下，add files...，选择 CocoaLumberjack 文件夹
> 同样的步骤，拷贝 CocoaAsyncSocket 和 KissXML 并添加到项目中
CocoaAsyncSocket 依赖 CFNetwork.framework 和 Security.framework，在 TARGETS -> Build Phases -> Link Binary With Libraries 添加
KissXML 使用了 libxml2 解析 XML，所以
首先，我们需要在 TARGETS -> Build Phases -> Link Binary With Libraries 添加 libXML2.dylib
然后，在 TARGETS -> Build Settings -> Other Linker Flags 添加 -lxml2，TARGETS -> Build Settings -> Header Search Paths 添加 /usr/include/libxml2
> 拷贝 <XMPPFramework>/Vendor/libidn 到项目根目录下，添加静态库文件 libidn.a 和头文件 idn-int.h 和 stringprep.h
添加 XMPPFramework
拷贝源码目录下的 Authentication Categories Core 和 Utilities 到项目根目录下并添加到项目中
此外，需要添加动态连接库 libresolv.dylib ，在 TARGETS -> Build Phases -> Link Binary With Libraries 添加
添加扩展
你可以根据自己的需要，添加 <XMPPFramework>/Extensions 的扩展到项目中
你可能遇到的问题：
> "XMPPFramework.h" file not found
XMPPFramework.h 内容如下，可根据实际使用模块进行删改：
#import "XMPP.h"// List the modules you're using here.#import "XMPPReconnect.h"#import "XMPPRoster.h"#import "XMPPRosterCoreDataStorage.h"#import "XMPPvCardTempModule.h"#import "XMPPvCardAvatarModule.h"#import "XMPPvCardCoreDataStorage.h"#import "XMPPCapabilities.h"#import "XMPPCapabilitiesCoreDataStorage.h"#import "XMPPMUC.h"#import "XMPPRoomCoreDataStorage.h"
还有一些问题，是由于没有添加Extension需要的依赖库所产生的
可在 TARGETS -> Build Phases -> Link Binary With Libraries 添加
CoreData.framework SystemConfiguration.framework CoreLocation.framework
ARC 警告
XMPPFramework 使用 ARC，如果你的项目没有使用 ARC，build 之后你会得到许许多多的 ARC 警告。
不要忽视这些警告，它会导致你的程序因 memory leak 而崩溃……
Edit -> Refactor -> convert to Objective-C ARC，消灭这些警告！
【iOS XMPP】使用XMPPFramewok（二）：用户登录
用户登录
准备工作
比较知名的开源XMPP服务器：一个是Openfire，一个是ejabberd
Openfire 使用 Java 语言编写，比较容易上手，地址：http://www.igniterealtime.org/projects/openfire/
ejabberd 使用 Erlang 语言编写，是一款非常知名的 Erlang 开源项目，地址：http://www.ejabberd.im/
安装 ejabberd，可以参考我的博客：【ejabberd】安装XMPP服务器ejabberd（Ubuntu 12.04）
搭建一个自己的 XMPP 服务器之后，就让我们开始吧！
连接服务器
1、新建一个 XMPPStream 对象，添加委托
添加委托方法 - (void)addDelegate:(id)delegate delegateQueue:(dispatch_queue_t)delegateQueue
参数 delegateQueue 为委托回调所使用的 GCD 队列，dispatch_get_main_queue() 获取主线程 GCD 队列
2、设置 JID 和 主机名
JID 一般由三部分构成：用户名，域名和资源名，例如 [email protected]/Anthony
如果没有设置主机名，则使用 JID 的域名作为主机名
端口号是可选的，默认是 5222
3、连接
- (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]);
}
}
}
身份认证
实现 - (void)xmppStreamDidConnect:(XMPPStream *)sender 委托方法
连接服务器成功后，回调该方法
This method is called after the XML stream has been fully opened. More precisely, this method is called after an opening <xml/> and <stream:stream/> tag have been sent and received, and after the stream features have been received, and any required features have been fullfilled. At this point it's safe to begin communication with the server.
身份认证方法 - (BOOL)authenticateWithPassword:(NSString *)inPassword error:(NSError **)errPtr
- (void)xmppStreamDidConnect:(XMPPStream *)sender {
NSString *password = [[NSUserDefaults standardUserDefaults] objectForKey:@"password"];
NSError *error = nil; if (![self.xmppStream authenticateWithPassword:password error:&error]) {
NSLog(@"Authenticate Error: %@", [[error userInfo] description]);
}
}
上线
实现 - (void)xmppStreamDidAuthenticate:(XMPPStream *)sender 委托方法
身份认证成功后，回调该方法
This method is called after authentication has successfully finished.
If authentication fails for some reason, the xmppStream:didNotAuthenticate: method will be called instead.
新建一个 XMPPPresence 对象，类型为 available，发送！
- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender {
XMPPPresence *presence = [XMPPPresence presenceWithType:@"available"];
[self.xmppStream sendElement:presence];
}
退出并断开连接
新建一个 XMPPPresence 对象，类型为 unavailable，发送！
断开连接
- (void)disconnect {
XMPPPresence *presence = [XMPPPresence presenceWithType:@"unavailable"];
[self.xmppStream sendElement:presence];
[self.xmppStream disconnect];
}
【iOS XMPP】使用XMPPFramewok（三）：好友状态
好友状态
获取好友状态，通过实现
- (void)xmppStream:(XMPPStream *)sender didReceivePresence:(XMPPPresence *)presence
方法
当接收到 <presence /> 标签的内容时，XMPPFramework 框架回调该方法
一个 <presence /> 标签的格式一般如下：
<presence from="">
<show>这里是显示的内容<show />
<status>这里是显示的状态<status />
<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"]) { // }
}
}
【iOS XMPP】使用XMPPFramewok（四）：收发消息
收发消息
接收消息
通过实现
- (void)xmppStream:(XMPPStream *)sender didReceiveMessage:(XMPPMessage *)message;
方法
当接收到 <message /> 标签的内容时，XMPPFramework 框架回调该方法
根据 XMPP 协议，消息体的内容存储在标签 <body /> 内
- (void)xmppStream:(XMPPStream *)sender didReceiveMessage:(XMPPMessage *)message {
NSString *messageBody = [[message elementForName:@"body"] stringValue];
}
发送消息
发送消息，我们需要根据 XMPP 协议，将数据放到 <message /> 标签内，例如：
<message type="chat" to="[email protected]">
<body>Hello World!<body />
<message />
- (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];
}
【iOS XMPP】使用XMPPFramewok（五）：好友列表
好友列表
好友列表，在 XMPP 中被称为 roster，花名册？
获取 roster 需要客户端发送 <iq /> 标签向 XMPP 服务器端查询
一个 IQ 请求：
<iq type="get"
from="[email protected]"
to="example.com"
id="1234567">
<query xmlns="jabber:iq:roster"/>
<iq />
type 属性，说明了该 iq 的类型为 get，与 HTTP 类似，向服务器端请求信息
from 属性，消息来源，这里是你的 JID
to 属性，消息目标，这里是服务器域名
id 属性，标记该请求 ID，当服务器处理完毕请求 get 类型的 iq 后，响应的 result 类型 iq 的 ID 与 请求 iq 的 ID 相同
<query xmlns="jabber:iq:roster"/> 子标签，说明了客户端需要查询 roster
- (void)queryRoster {
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:[self generateID]];
[iq addAttributeWithName:@"type" stringValue:@"get"];
[iq addChild:query];
[self.xmppStream sendElement:iq];
}
一个 IQ 响应：
<iq type="result"
id="1234567"
to="[email protected]">
<query xmlns="jabber:iq:roster">
<item jid="[email protected]" name="小燕" />
<item jid="[email protected]" name="小强"/>
<query />
<iq />
type 属性，说明了该 iq 的类型为 result，查询的结果
<query xmlns="jabber:iq:roster"/> 标签的子标签 <item />，为查询的子项，即为 roster
item 标签的属性，包含好友的 JID，和其它可选的属性，例如昵称等。
通过实现
- (BOOL)xmppStream:(XMPPStream *)sender didReceiveIQ:(XMPPIQ *)iq;
方法
当接收到 <iq /> 标签的内容时，XMPPFramework 框架回调该方法
- (BOOL)xmppStream:(XMPPStream *)sender didReceiveIQ:(XMPPIQ *)iq { 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];
[self.roster addObject:xmppJID];
}
}
}
}