XMPP常用的协议（一）

最近，在用XMPP协议封装iOS和Android的IMSDK，整理了一下常用的协议内容。
其中包括上线、离线；添加好友、删除好友、同意好友申请、拒绝好友申请、为好友设置备注；发送消息（文本、图片、定位、语音）；获取群列表、创建群、配置群信息、设置管理员、撤销管理员、邀请人加群、踢人、退群、解散群等等。
使用各种库版本是Openfire 4.1 、（iOS）XMPPFramework、（Android）Smack 4.1.4

1.上线

我们在登录成功后，要发送一个上线的presence 消息：

<presence><status>我上线咯</status><show>xa</show>
</presence>

iOS 中的示例代码是：

- (void)goOnline
{// 发送一个<presence/> 默认值avaliable 在线 服务器收到空的presence 也会认为是avaliable// status ---自定义的内容，可以是任何的。// show 是固定的，有几种类型 dnd、xa、away、chat，在方法XMPPPresence 的intShow中可以看到XMPPPresence *presence = [XMPPPresence presence];[presence addChild:[DDXMLNode elementWithName:@"status" stringValue:@"我上线咯"]];[presence addChild:[DDXMLNode elementWithName:@"show" stringValue:@"xa"]];[self.stream sendElement:presence];
}

而Android 里(用Smack4.1) 是这样发的：

Presence presence = new Presence(Presence.Type.available);
presence.setMode(Presence.Mode.available);
dmConnection.sendStanza(presence);

当然，Android 这里少了<status> 和 <show> 这两个节点，因为Android 里添加节点比较麻烦，我们没有状态显示需求，也就没添加。

其中show的内容是固定的，只能是dnd、xa、away、chat，类似于QQ的状态：我在线上、离开、隐身、离线等。（可以在Demo里设置后，另一端用Spark查看效果）
而status 可以是任意的内容。

2. 离线

同样的，当我们推出登录时，最好也发出一个离线的presence消息：

<presence type="unavailable"/>

iOS 里的是这样的：

- (void)offline
{XMPPPresence *off = [XMPPPresence presenceWithType:@"unavailable"];[_stream sendElement:off];
}

Android 里是这样的：

Presence presence = new Presence(Presence.Type.unavailable);
dmConnection.sendStanza(presence);

3.添加好友

XMPP协议添加好友，其实就是A订阅B，同时B也订阅A的模式。
添加好友可以扩展几个节点，放备注信息。例如下面的extra 里的 message 节点

<presence type="subscribe" to="1007@duimy" id="3C1090D3-BF41-4CF3-8034-A6DFEACC118B"><extra xmlns="http://www.duimy.com/presence-extra"><message>请求加个好友呗</message><timestamp>2017-06-20 17:56:26</timestamp></extra>
</presence>

iOS里的代码是这样的：

    XMPPPresence* presence = [XMPPPresence presenceWithType:@"subscribe" to:[jid bareJID]];[presence addAttributeWithName:@"id" stringValue:[HLCoreManager manager].stream.generateUUID];//extraNSXMLElement *extra = [NSXMLElement elementWithName:@"extra" xmlns:ADDFRIEND_XMLNS];[presence addChild:extra];//verifyContentif (message.length > 0) {NSXMLElement *verifyContent = [NSXMLElement elementWithName:@"message"];[verifyContent setStringValue:message];[extra addChild:verifyContent];}//timestampNSXMLElement *timestamp = [NSXMLElement elementWithName:@"timestamp"];NSDateFormatter *dateFormat = [[NSDateFormatter alloc] init];dateFormat.dateFormat = @"YYYY-MM-dd HH:mm:ss";NSString *dateStr = [dateFormat stringFromDate:[NSDate date]];[timestamp setStringValue:dateStr];[extra addChild:timestamp];[self.stream sendElement:presence];

而Android 里因为使用Smack 就很简单了：

Presence presence = new Presence(Presence.Type.subscribe);
presence.setTo(user);
dmConnection.sendStanza(presence);

4.删除好友

删除好友其实就是取消订阅，A取消订阅B，B取消订阅A。

<presence type="unsubscribe" to="1002@duimy" id="F7129693-910C-4C0D-93C2-33845794FEF0"/>

iOS 里的代码片段：

XMPPPresence *presence = [XMPPPresence presenceWithType:@"unsubscribe" to:[jid bareJID]];
[presence addAttributeWithName:@"id" stringValue:[HLCoreManager manager].stream.generateUUID];
[self.stream sendElement:presence];

Android 中的代码段：

Presence presence = new Presence(Presence.Type.unsubscribe);
presence.setTo(user);
dmConnection.sendStanza(presence);

4.1 收到对方取消订阅

收到对方取消订阅自己，自己这边默认也要取消对方的订阅
为了避免收到对方取消订阅的死循环，取消订阅使用iq来发消息

<iq type="set"><query xmlns="jabber:iq:roster"><item jid="1001@duimy" subscription="remove"/></query>
</iq>

iOS 中的代码段：

//自动也取消订阅对方,这里的xmppRoster 就是XMPPRoster 的实例
[[HLCoreManager manager].xmppRoster removeUser:presence.from];

Android 中的代码段：

RosterEntry rosterEntry = roster.getEntry(presence.getFrom());
roster.removeEntry(rosterEntry);

5.同意对方的好友申请

同意对方的好友申请分为两步：第一步，告诉对方，你订阅成功了，发送如下消息：

<presence type="subscribed" to="1002@duimy" id="F7129693-910C-4C0D-93C2-33845794FEF0"/>

第二步，发送订阅对方的消息（即上面小节3）。

iOS 里的代码段：

// 同意加好友的申请
- (void)agreeFriendRequestFrom:(NSString *)username completion:(CompletionBlock)completion
{XMPPJID *jid = [[HLCoreManager manager] jidWithUsername:username];XMPPPresence *presence = [XMPPPresence presenceWithType:@"subscribed" to:[jid bareJID]];[presence addAttributeWithName:@"id" stringValue:[HLCoreManager manager].stream.generateUUID];// 发送已订阅的信息给对方[self sendElement:presence completion:nil];//并添加对方为好友[self addContact:username message:nil completion:^(NSString *username, NSError *error) {if (completion) {completion(username, error);}}];
}

Android 里的代码段：

Presence presence = new Presence(Presence.Type.subscribed);
presence.setTo(user);
// 告诉对方，已订阅成功
dmConnection.sendStanza(presence);
// 发送一条订阅对方的消息
Presence presence2 = new Presence(Presence.Type.subscribe);
presence2.setTo(user);
dmConnection.sendStanza(presence);

5.1 收到对方订阅自己的消息

收到别人订阅自己的消息时，分两种情况：
如果是别人发出的申请，那么需要将这个申请的消息传递出去，让用户觉得是同意还是拒绝。
如果是自己发起的，别人订阅自己其实是同意操作，则我们只需要给对方发一条订阅成功的消息即可。（防止无限订阅的死循环）

iOS里的代码段：

    if ([presence.type isEqualToString:@"subscribe"]) {XMPPUserMemoryStorageObject *userObject = [[HLCoreManager manager].xmppRosterMemoryStorage userForJID:presence.from];NSDictionary *userDict = [userObject valueForKey:@"itemAttributes"];if (userDict && [@"to" isEqualToString:userDict[@"subscription"]]) { //如果订阅状态是to,说明是我发送给对方的好友申请，对方同意并添加我为好友XMPPPresence *replyPresence = [XMPPPresence presenceWithType:@"subscribed" to:presence.from];[replyPresence addAttributeWithName:@"id" stringValue:[HLCoreManager manager].stream.generateUUID];[self sendElement:replyPresence completion:nil];return;}NSXMLElement *extra = [presence elementForName:@"extra"];NSString *content = [[extra elementForName:@"message"] stringValue];NSString *time = [[extra elementForName:@"timestamp"] stringValue];NSMutableDictionary *dict = [NSMutableDictionary dictionary];if (content.length > 0) {[dict setObject:content forKey:@"message"];}if (time.length > 0) {[dict setObject:time forKey:@"time"];}if (presence.from.user > 0) {[dict setObject:presence.from.user forKey:@"jid"];}// 通过多播代理，把消息传出去[self.multicastDelegate friendRequestDidReceiveFromUser:presence.from.user message:content];}

Android 里的代码段：

if (presence.getType() == Presence.Type.subscribe) { // 对方请求添加好友RosterEntry entry = roster.getEntry(presence.getFrom());if (entry != null && entry.getType() == RosterPacket.ItemType.to) {// 如果是自己添加对方为好友，收到对方的订阅信息Presence replyPresence = new Presence(Presence.Type.subscribed);replyPresence.setTo(presence.getFrom());dmCore.getConnection().sendStanza(replyPresence);return;}InputStream inputStream = new ByteArrayInputStream(presence.toString().getBytes());String message = XMLParse(inputStream, "message");for (DMContactListener contactListener : contactListeners) {                                  contactListener.onFriendRequestReceived(presence.getFrom(), message);}
}

6.拒绝好友申请

<presence type="unsubscribed" to="1002@duimy" id="F7129693-910C-4C0D-93C2-33845794FEF0"/>

iOS 里的代码段：

// 拒绝加好友的申请
- (void)rejectFriendRequestFrom:(NSString *)username completion:(CompletionBlock)completion
{XMPPJID *jid = [[HLCoreManager manager] jidWithUsername:username];// 先告诉对方，我不然让你订阅XMPPPresence *presence = [XMPPPresence presenceWithType:@"unsubscribed" to:[jid bareJID]];[presence addAttributeWithName:@"id" stringValue:[HLCoreManager manager].stream.generateUUID];[self sendElement:presence completion:^(XMPPElement *element, NSError *error) {if (completion) {completion(username, error);}}];// 从好友关系里删除[[HLCoreManager manager].xmppRoster removeUser:presence.from];
}

Android 里的代码段：

Presence presence = new Presence(Presence.Type.unsubscribed);
presence.setTo(user);
dmCore.getConnection().sendStanza(presence);
RosterEntry rosterEntry = roster.getEntry(presence.getFrom());
if (rosterEntry != null) {roster.removeEntry(rosterEntry);
}

7.为好友设置备注

<iq type="set"><query xmlns="jabber:iq:roster"><item jid="bareJID" name="nickname"/></query></iq>

iOS里的代码段：

// 为好友设置备注
- (void)setNickName:(NSString *)nickName forUser:(NSString *)username completion:(CompletionBlock)completion
{XMPPJID *jid = [[HLCoreManager manager] jidWithUsername:username];NSXMLElement *item = [NSXMLElement elementWithName:@"item"];[item addAttributeWithName:@"jid" stringValue:[jid bare]];[item addAttributeWithName:@"name" stringValue:nickName];NSXMLElement *query = [NSXMLElement elementWithName:@"query" xmlns:@"jabber:iq:roster"];[query addChild:item];XMPPIQ *iq = [XMPPIQ iqWithType:@"set"];[iq addAttributeWithName:@"id" stringValue:[HLCoreManager manager].stream.generateUUID];[iq addChild:query];[self sendElement:iq completion:^(XMPPElement *element, NSError *error) {if (completion) {completion(username, error);}}];
}