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的内容是固定的,只能是dndxaawaychat,类似于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

相关文章

关于WebSocket协议状态码解析

《关于WebSocket协议状态码解析》:本文主要介绍关于WebSocket协议状态码的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录WebSocket协议状态码解析1. 引言2. WebSocket协议状态码概述3. WebSocket协议状态码详解3

Linux上设置Ollama服务配置(常用环境变量)

《Linux上设置Ollama服务配置(常用环境变量)》本文主要介绍了Linux上设置Ollama服务配置(常用环境变量),Ollama提供了多种环境变量供配置,如调试模式、模型目录等,下面就来介绍一... 目录在 linux 上设置环境变量配置 OllamPOgxSRJfa手动安装安装特定版本查看日志在

Java常用注解扩展对比举例详解

《Java常用注解扩展对比举例详解》:本文主要介绍Java常用注解扩展对比的相关资料,提供了丰富的代码示例,并总结了最佳实践建议,帮助开发者更好地理解和应用这些注解,需要的朋友可以参考下... 目录一、@Controller 与 @RestController 对比二、使用 @Data 与 不使用 @Dat

Mysql中深分页的五种常用方法整理

《Mysql中深分页的五种常用方法整理》在数据量非常大的情况下,深分页查询则变得很常见,这篇文章为大家整理了5个常用的方法,文中的示例代码讲解详细,大家可以根据自己的需求进行选择... 目录方案一:延迟关联 (Deferred Join)方案二:有序唯一键分页 (Cursor-based Paginatio

Python实现常用文本内容提取

《Python实现常用文本内容提取》在日常工作和学习中,我们经常需要从PDF、Word文档中提取文本,本文将介绍如何使用Python编写一个文本内容提取工具,有需要的小伙伴可以参考下... 目录一、引言二、文本内容提取的原理三、文本内容提取的设计四、文本内容提取的实现五、完整代码示例一、引言在日常工作和学

Redis中的常用的五种数据类型详解

《Redis中的常用的五种数据类型详解》:本文主要介绍Redis中的常用的五种数据类型详解,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Redis常用的五种数据类型一、字符串(String)简介常用命令应用场景二、哈希(Hash)简介常用命令应用场景三、列表(L

python中time模块的常用方法及应用详解

《python中time模块的常用方法及应用详解》在Python开发中,时间处理是绕不开的刚需场景,从性能计时到定时任务,从日志记录到数据同步,时间模块始终是开发者最得力的工具之一,本文将通过真实案例... 目录一、时间基石:time.time()典型场景:程序性能分析进阶技巧:结合上下文管理器实现自动计时

C#中的 Dictionary常用操作

《C#中的Dictionary常用操作》C#中的DictionaryTKey,TValue是用于存储键值对集合的泛型类,允许通过键快速检索值,并且具有唯一键、动态大小和无序集合的特性,常用操作包括添... 目录基本概念Dictionary的基本结构Dictionary的主要特性Dictionary的常用操作

Python中常用的四种取整方式分享

《Python中常用的四种取整方式分享》在数据处理和数值计算中,取整操作是非常常见的需求,Python提供了多种取整方式,本文为大家整理了四种常用的方法,希望对大家有所帮助... 目录引言向零取整(Truncate)向下取整(Floor)向上取整(Ceil)四舍五入(Round)四种取整方式的对比综合示例应

Qt 中集成mqtt协议的使用方法

《Qt中集成mqtt协议的使用方法》文章介绍了如何在工程中引入qmqtt库,并通过声明一个单例类来暴露订阅到的主题数据,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友一起看看吧... 目录一,引入qmqtt 库二,使用一,引入qmqtt 库我是将整个头文件/源文件都添加到了工程中进行编译,这样 跨平台