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。

相关文章

HarmonyOS学习(七)——UI（五）常用布局总结

HarmonyOS学习(七)——UI（五）常用布局总结

自适应布局 1.1、线性布局（LinearLayout） 通过线性容器Row和Column实现线性布局。Column容器内的子组件按照垂直方向排列，Row组件中的子组件按照水平方向排列。 属性说明space通过space参数设置主轴上子组件的间距，达到各子组件在排列上的等间距效果alignItems设置子组件在交叉轴上的对齐方式，且在各类尺寸屏幕上表现一致，其中交叉轴为垂直时，取值为Vert
阅读更多...
JS常用组件收集

JS常用组件收集

收集了一些平时遇到的前端比较优秀的组件，方便以后开发的时候查找！！！ 函数工具： Lodash 页面固定： stickUp、jQuery.Pin 轮播： unslider、swiper 开关: switch 复选框： icheck 气泡： grumble 隐藏元素： Headroom
阅读更多...
【C++】_list常用方法解析及模拟实现

【C++】_list常用方法解析及模拟实现

相信自己的力量，只要对自己始终保持信心，尽自己最大努力去完成任何事，就算事情最终结果是失败了，努力了也不留遗憾。💓💓💓 目录   ✨说在前面 🍋知识点一：什么是list？ •🌰1.list的定义 •🌰2.list的基本特性 •🌰3.常用接口介绍 🍋知识点二：list常用接口 •🌰1.默认成员函数 🔥构造函数（⭐） 🔥析构函数 •🌰2.list对象
阅读更多...
常用的jdk下载地址

常用的jdk下载地址

jdk下载地址 安装方式可以看之前的博客： mac安装jdk oracle 版本：https://www.oracle.com/java/technologies/downloads/ Eclipse Temurin版本：https://adoptium.net/zh-CN/temurin/releases/ 阿里版本： github：https://github.com/
阅读更多...
30常用 Maven 命令

30常用 Maven 命令

Maven 是一个强大的项目管理和构建工具，它广泛用于 Java 项目的依赖管理、构建流程和插件集成。Maven 的命令行工具提供了大量的命令来帮助开发人员管理项目的生命周期、依赖和插件。以下是 常用 Maven 命令的使用场景及其详细解释。 1. mvn clean 使用场景：清理项目的生成目录，通常用于删除项目中自动生成的文件（如 target/ 目录）。共性规律：清理操作
阅读更多...
【Linux】应用层http协议

【Linux】应用层http协议

一、HTTP协议 1.1 简要介绍一下HTTP        我们在网络的应用层中可以自己定义协议，但是，已经有大佬定义了一些现成的，非常好用的应用层协议，供我们直接使用，HTTP（超文本传输协议）就是其中之一。        在互联网世界中，HTTP（超文本传输协议）是一个至关重要的协议，他定义了客户端（如浏览器）与服务器之间如何进行通信，以交换或者传输超文本（比如HTML文档）。
阅读更多...
019、JOptionPane类的常用静态方法详解

019、JOptionPane类的常用静态方法详解

目录 JOptionPane类的常用静态方法详解 1. showInputDialog()方法 1.1基本用法 1.2带有默认值的输入框 1.3带有选项的输入对话框 1.4自定义图标的输入对话框 2. showConfirmDialog()方法 2.1基本用法 2.2自定义按钮和图标 2.3带有自定义组件的确认对话框 3. showMessageDialog()方法 3.1
阅读更多...
工作常用指令与快捷键

工作常用指令与快捷键

Git提交代码 git fetch  git add .  git commit -m “desc”  git pull  git push Git查看当前分支 git symbolic-ref --short -q HEAD Git创建新的分支并切换 git checkout -b XXXXXXXXXXXXXX git push origin XXXXXXXXXXXXXX
阅读更多...
【Go】go连接clickhouse使用TCP协议

【Go】go连接clickhouse使用TCP协议

离开你是傻是对是错 是看破是软弱 这结果是爱是恨或者是什么 如果是种解脱 怎么会还有眷恋在我心窝 那么爱你为什么                      🎵 黄品源/莫文蔚《那么爱你为什么》 package mainimport ("context""fmt""log""time""github.com/ClickHouse/clickhouse-go/v2")func main(
阅读更多...
java常用面试题-基础知识分享

java常用面试题-基础知识分享

什么是Java？ Java是一种高级编程语言，旨在提供跨平台的解决方案。它是一种面向对象的语言，具有简单、结构化、可移植、可靠、安全等特点。 Java的主要特点是什么？ Java的主要特点包括： 简单性：Java的语法相对简单，易于学习和使用。面向对象：Java是一种完全面向对象的语言，支持封装、继承和多态。跨平台性：Java的程序可以在不同的操作系统上运行，称为"Write once,
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2