XMPP常用的协议（一）

2024-06-13 06:18
文章标签 协议 常用 xmpp

本文主要是介绍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);}}];
}

这篇关于XMPP常用的协议（一）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1056497。

相关文章

Spring Boot 常用注解整理(最全收藏版)

Spring Boot 常用注解整理(最全收藏版)

《SpringBoot常用注解整理(最全收藏版)》本文系统整理了常用的Spring/SpringBoot注解,按照功能分类进行介绍,每个注解都会涵盖其含义、提供来源、应用场景以及代码示例,帮助开发... 目录Spring & Spring Boot 常用注解整理一、Spring Boot 核心注解二、Spr
阅读更多...
Java中的内部类和常用类用法解读

Java中的内部类和常用类用法解读

《Java中的内部类和常用类用法解读》：本文主要介绍Java中的内部类和常用类用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录内部类和常用类内部类成员内部类静态内部类局部内部类匿名内部类常用类Object类包装类String类StringBuffer和Stri
阅读更多...
MySQL连接池(Pool)常用方法详解

MySQL连接池(Pool)常用方法详解

《MySQL连接池(Pool)常用方法详解》本文详细介绍了MySQL连接池的常用方法,包括创建连接池、核心方法连接对象的方法、连接池管理方法以及事务处理,同时,还提供了最佳实践和性能提示,帮助开发者构... 目录mysql 连接池 (Pool) 常用方法详解1. 创建连接池2. 核心方法2.1 pool.q
阅读更多...
Spring Boot 常用注解详解与使用最佳实践建议

Spring Boot 常用注解详解与使用最佳实践建议

《SpringBoot常用注解详解与使用最佳实践建议》：本文主要介绍SpringBoot常用注解详解与使用最佳实践建议,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 目录一、核心启动注解1. @SpringBootApplication2. @EnableAutoConfi
阅读更多...
SQL常用操作精华之复制表、跨库查询、删除重复数据

SQL常用操作精华之复制表、跨库查询、删除重复数据

《SQL常用操作精华之复制表、跨库查询、删除重复数据》：本文主要介绍SQL常用操作精华之复制表、跨库查询、删除重复数据,这些SQL操作涵盖了数据库开发中最常用的技术点,包括表操作、数据查询、数据管... 目录SQL常用操作精华总结表结构与数据操作高级查询技巧SQL常用操作精华总结表结构与数据操作复制表结
阅读更多...
JavaScript时间戳与时间的转化常用方法

JavaScript时间戳与时间的转化常用方法

《JavaScript时间戳与时间的转化常用方法》在JavaScript中,时间戳（Timestamp）通常指Unix时间戳,即从1970年1月1日00:00:00UTC到某个时间点经过的毫秒数,下面... 目录1. 获取当前时间戳2. 时间戳 → 时间对象3. 时间戳php → 格式化字符串4. 时间字符
阅读更多...
Python中pywin32 常用窗口操作的实现

Python中pywin32 常用窗口操作的实现

《Python中pywin32常用窗口操作的实现》本文主要介绍了Python中pywin32常用窗口操作的实现,pywin32主要的作用是供Python开发者快速调用WindowsAPI的一个... 目录获取窗口句柄获取最前端窗口句柄获取指定坐标处的窗口根据窗口的完整标题匹配获取句柄根据窗口的类别匹配获取句
阅读更多...
Python的time模块一些常用功能(各种与时间相关的函数)

Python的time模块一些常用功能(各种与时间相关的函数)

《Python的time模块一些常用功能(各种与时间相关的函数)》Python的time模块提供了各种与时间相关的函数,包括获取当前时间、处理时间间隔、执行时间测量等,：本文主要介绍Python的... 目录1. 获取当前时间2. 时间格式化3. 延时执行4. 时间戳运算5. 计算代码执行时间6. 转换为指
阅读更多...
Python正则表达式语法及re模块中的常用函数详解

Python正则表达式语法及re模块中的常用函数详解

《Python正则表达式语法及re模块中的常用函数详解》这篇文章主要给大家介绍了关于Python正则表达式语法及re模块中常用函数的相关资料,正则表达式是一种强大的字符串处理工具,可以用于匹配、切分、... 目录概念、作用和步骤语法re模块中的常用函数总结 概念、作用和步骤概念： 本身也是一个字符串，其中
阅读更多...
usb接口驱动异常问题常用解决方案

usb接口驱动异常问题常用解决方案

《usb接口驱动异常问题常用解决方案》当遇到USB接口驱动异常时，可以通过多种方法来解决，其中主要就包括重装USB控制器、禁用USB选择性暂停设置、更新或安装新的主板驱动等... usb接口驱动异常怎么办，USB接口驱动异常是常见问题，通常由驱动损坏、系统更新冲突、硬件故障或电源管理设置导致。以下是常用解决
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2