XMPP:XMPP是基于XML的点对点通讯协议,The Extensible Messaging and Presence Protocol(可扩展通讯和表示协议)。
XMPP可用于服务类实时通讯,表示和需求响应服务中的XML数据元流失传输。XMPP以Jabber协议为基础,而Jabber是即时通讯中常用的开放式协议。
基本结构。
XMPP是一个典型的C/S架构,而不是像大多数即时通讯软件一样,使用P2P客户端到客户端的架构,也就是说在大多数情况下,当两个客户端进行通讯时,他们的消息都是通过服务器传递的。采用这种架构,主要是为了简化客户端,将大多数工作放在服务器端进行。
XMPP中定义了三个角色,客户端,服务器,网关。通信能够在这三者的任意两个之间双向发生。
服务器同时承担了客户端信息记录,连接管理和信息的路由功能。网关承担着与异构即时通讯系统的互联互通,异构系统可以包括SMS(短信),MSN,ICQ等。
基本的网络形式是单客户端通过TCP/IP连接到单服务器,然后在之上传输XML流。
1.1XMPP中的常用对象
XMPPStream:xmpp基础服务类
XMPPRoster:好友列表类
XMPPRosterCoreDataStoreage:好友列表(用户账号)在core data中的操作类
XMPPvCardCoreDataStorage:好友名片(昵称、签名、性别、年龄等信息)在core data中的操作类
XMPPvCardTemp:好友名片实体类,从数据库里面取出来的都是它
xmppvCardAvatarModule:好友头像
XMPPReconnect:如果失去连接,自动重连
XMPPRoom:提供多用户聊天支持
XMPPPubSub:发布订阅
1.2登录操作,也就是连接xmpp服务器
XMPP的地址叫做JabberID(简写为JID),它用来标识XMPP网络中的各个XMPP实体,JID由三个部分组成:domain、node identifier和resource。JID中domain是必不可少的部分。注意:domain和user部分是不分大小写的,但是resource区别大小写。
domain:通常指网络中的网关或者服务器。
node identifier:通常表示一个向服务器或者网关请求和使用网络服务的实体(比如一个客户端),当然它也能够表示其他的实体(比如在多用户聊天系统中的一个房间)。
resource:通常表示一个特定的会话(与某个设备),连接(与某个地址),或者一个附属于某个节点ID实体相关实体的对象(比如多用户聊天室中的一个参加者)。
JID种类有:
bare JID:user@domain.tld
full JID:user@domain.tld/resource
如:
tom@jabber.org:表示服务器jabber.org上的用户tom
room@service:一个用来提供多用户聊天服务的特定的聊天室。这里“room”是聊天室的名字,“service”是多用户聊天服务的主机名。
room@service/nick:加入了聊天室的用户nick的地址。这里“room”是聊天室的名字,“service”是多用户聊天服务的主机名,“nick”是用户在聊天室的昵称。
为了表示JID,xmpp也有自己的URI,例如xmpp:stpeter.org,默认规则是在JID前加xmpp:。
代码操作:
1、登录操作,也就是连接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的authenticcateWithPassword方法进行密码验证,成功的话就会响应delegate的方法,就是下面这个:
- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender
2、上线
实现- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender 委托方法
- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender {
XMPPPresence *presence = [XMPPPresence presenceWithType:@"available"];
[self.xmppStream sendElement:presence];
}
3、退出并断开连接
- (void)disconnect {
XMPPPresence *presence = [XMPPPresence presenceWithType:@"unavailable"];
[self.xmppStream sendElement:presence]; [self.xmppStream disconnect];
}
4、好友状态
获取好友状态,通过实现
- (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"]) {
//
}
}
}
5、接收消息
通过实现
- (void)xmppStream:(XMPPStream *)sender didReceiveMessage:(XMPPMessage *)message;
方法,当接收到message标签的内容时,XMPPFramework框架回调该方法,根据XMPP协议,消息体的内容存储在标签body内
- (void)xmppStream:(XMPPStream *)sender didReceiveMessage:(XMPPMessage *)message {
NSString *messageBody = [[message elementForName:@"body"] stringValue];
}
6、发送消息
发送消息,我们需要根据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];
}
7、获取好友信息
[_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
8、添加好友
//name为用户账号
- (void)XMPPAddFriendSubscribe:(NSString *)name
{
//XMPPHOST 就是服务器名, 主机名
XMPPJID *jid = [XMPPJID jidWithString:[NSString stringWithFormat:@"%@@%@",name,XMPPHOST]];
//[presence addAttributeWithName:@"subscription" stringValue:@"好友"];
[xmppRoster subscribePresenceToUser:jid]; }
9、收到添加好友的请求
- (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]; }
10、删除好友
//删除好友,name为好友账号
- (void)removeBuddy:(NSString *)name
{
XMPPJID *jid = [XMPPJID jidWithString:[NSString stringWithFormat:@"%@@%@",name,XMPPHOST]]; [self xmppRoster] removeUser:jid];
}
11、聊天室
XMPPJID *roomJID = [XMPPJID jidWithString:ROOM_JID]; xmppRoom = [[XMPPRoom alloc] initWithRoomStorage:self jid:roomJID]; [xmppRoom activate:xmppStream];
[xmppRoom addDelegate:self delegateQueue:dispatch_get_main_queue()];
12、创建聊天室成功
- (void)xmppRoomDidCreate:(XMPPRoom *)sender
{
DDLogInfo(@"%@: %@", THIS_FILE, THIS_METHOD);
}
13、加入聊天室,使用昵称
[xmppRoom joinRoomUsingNickname:@"quack" history:nil];
14、获取聊天室信息
- (void)xmppRoomDidJoin:(XMPPRoom *)sender
{
[xmppRoom fetchConfigurationForm];
[xmppRoom fetchBanList];
[xmppRoom fetchMembersList];
[xmppRoom fetchModeratorsList];
}
15、如果房间存在,会调用委托
// 收到禁止名单列表
- (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;
16、离开房间
[xmppRoom deactivate:xmppStream];
17、离开聊天室
- (void)xmppRoomDidLeave:(XMPPRoom *)sender
{
DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);
}
18、新人加入群聊
- (void)xmppRoom:(XMPPRoom *)sender occupantDidJoin:(XMPPJID *)occupantJID
{
DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);
}
19、有人退出群聊
- (void)xmppRoom:(XMPPRoom *)sender occupantDidLeave:(XMPPJID *)occupantJID
{
DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);
}
20、有人在群里发言
- (void)xmppRoom:(XMPPRoom *)sender didReceiveMessage:(XMPPMessage *)message fromOccupant:(XMPPJID *)occupantJID
{
DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);
}
21、消息回执
这个是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!");
}
}
} //消息处理
//...
}
22、添加AutoPing
为了监听服务器是否有效,增加心跳监听。用XEP-0199协议,在XMPPFraneWork框架下,封装了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=;//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");
}
demo下载:http://download.csdn.net/detail/shaoting19910730/9178475