Jabber 协议概述(转载)

Jabber即时消息协议详解

最新推荐文章于 2019-11-25 22:58:26 发布

最新推荐文章于 2019-11-25 22:58:26 发布 · 232 阅读

文章标签：

#应用服务器 #.net #XML #XHTML #thread

IM 开发专栏收录该内容

2 篇文章

订阅专栏

本文详细介绍了Jabber即时消息系统的核心组件——开放XML协议。内容覆盖了XML流的交互原理，以及<message>、<presence>和<iq>等关键元素的使用方法。深入探讨了各种消息类型及在线状态的表达方式。

1. 介绍

Jabber 是一个由开源社区发起并领导开发的即时消息和在线状态的系统。 Jabber 系统和其它即时消息（ IM ）服务的一个功能上的差别在于 Jabber 拥有开放的 XML 协议。在保持 Jabber1.0 版本有关消息核心以及在线状态的协议的基础上，增加了一些必要的扩展。本文档将对 Jabber 服务器 1.4 版的 Jabber 协议进行介绍。

在 XML 上下文的数据流中， Jabber 开放的 XML 协议包括三个顶级 XML 元素：

l <message/>

l <presence/>

l <iq/>(info/query)

每一个元素通过属性和名字空间包含大量的数据，这些属性和名字空间都是 Jabber 的组成部分（但不包括为特殊应用的名字空间应用）。下面将描述整个 Jabber 协议。如果您想获得关于 Jabber 系统结构的信息，请查看名为 Jabber 技术概述的文档（http://docs.jabber.org/general/html/overview.html）。

2. XML 流

一个 Jabber 会话由两个平行的 XML 流组成，一个从客户端到服务器端，另一个从服务端到客户端。当一个 Jabber 客户端连接上一个 Jabber 服务器时，这个客户端将发起一个客户端－服务器的 XML 流，同时作为响应，服务器也将发起一个服务器－客户端的 XML 流。所有 <message/> ， <presence/> ，以及 <iq/> 元素都被放在这些 XML 流的上下文中。下面就有一个例子：

SEND:<?xml version=”1.0” encoding=”UTF-8” ?>

SEND:<stream:stream

SEND:to=’jabber.org’

SEND:xmlns=’jabber:client’

SEND:xmlns:stream=’http://ether.jabber.org/streams’>

RECV:<stream:stream

RECV:xmlns:stream=’http://etherx.jabber.org/streams’

RECV:id=’39ABA7D2’

RECV:xmlns=’jabber:client’

RECV:from=’jabber.org’>

(XML for user session goes here)*

SEND:</stream:stream>

RECV:</stream:stream>

* 注意：必须等到当一个 <iq/> 元素（特别指一个 ’jabber:iq:auth’ 名字空间下的 <query/> 元素）发送了认证信息后，服务器才会同意用户会话进行工作。

3. <message/> 元素

<message/> 元素是 Jabber 开放 XML 协议三个顶级元素中的一个。它被用来包含两个 Jabber 用户间互相发送消息内容，或者两个 Jabber IDs 之间更一般的消息（因为，通过神奇的传输器，另一个 IM 系统可以用 Jabber ID 代替，如70902454@icq.jabber.org）。

3.1. 消息类型－“ type ”属性

Jabber 支持几种不同的消息，这些消息通过 <message/> 的“ type ”属性来进行区分。下面就是“ type ”属性的有效值：

3.1.1 . [default] （不设置“ type ”属性）

表示本消息是一个普通消息。默认的情况下，客户端在没有设置属性时，将消息类型定为普通消息。

例子：

<body>Wherefore art though Romeo?</body>

</message>

3.1.2 .type=”chat”

表示消息需要被一个接一个的显示在聊天界面上（一般是一条接一条的界面，不过实际界面可以被用户自己定义。）

例子：

<body>Wherefore art though Romeo?</body>

</message>

3.1.3 .type=”error”

表示消息被描述成一个错误条件。实际的错误在消息中用一个 <error/> 元素来描述。一个 <message/> 元素包括一个 <body/> 和一个 <error/> 。下面的例子将演示，当 Juliet 对一个不存在的用户发送一个“ hi ”的消息时，将收到的包体：

例子：

<message

to="juliet@capulet.com"

from="flomeo@montague.net"

type="error">

<error code="404">Not Found</error>

</message>

3.1.4 . type=”groupchat”

表示本消息需要在一个聊天室的界面中进行显示。

例子：

<body>Double, double toil and trouble</body>

</message>

3.2. <message/> 其它属性

除了设置“ type ”属性，还可以通过下面的属性修改 <message/> 元素：

3.2.1 . “ from ”属性

消息发送者的标志。总得来说， Jabber ID 的 ”from” 必须是 user@host/resource 的格式。从 XML 的观点来说，这个属性必须包含于所有的 <message/> 元素中，为了对付一些欺骗，实际应用中服务器添加或置换这个属性。因此，它并不是客户端开发者需要关心的问题。

例子：

<body>Wherefore art thou Romeo?</body>

</message>

3.2.2 . “ id ”属性

“ id ”属性是作为消息的一个唯一标志。它由 Jabber 客户端或客户库（类似 WinJab 或 JabberCOM ），生成，客户端用它来为跟踪消息（比如将发送到一个群组聊天室的信息和从这个聊天室收到的消息相关联，或将一个消息与它可能产生的错误相关联）进行标识。“ id ”属性是可选的，并且在系统的别的方是不可用的。

例子：

<body>Wherefore art thou Romeo?</body>

</message>

3.2.3 . “ to ”属性

表示消息的接收者。 Jabber ID 的“ to ”属性一般是 user@host/resource 格式， user@host 也可以被接受。如果接收者在线，通过 user@host/resource 方式解决，如果用户不在线，直接发送离线存储器。这个属性是所有 <message/> 元素必须的。

例子：

<body>Wherefore art thou Romeo?</body>

</message>

3.3. <message/> 中的子元素

下面的子元素是用来定义一个 Jabber 消息的上下文或数据元。

3.3.1 . <body/>

这个元素包含消息的主要文本。 <body/> 元素只存在于一个 <message/> 元素中，并且只能包含明文。不过，它可以由其它子元素构成（如 <error/> 、 <x/> ）。

3.3.2 . <error/>

当消息类型属性被置为“ error ”时，这个元素将被使用。错误代码被一个 ”type” 属性定义，这个 ”type” 属性包含代码数，通过 <error/> 元素来包含一个这个错误的文本描述。 <error/> 元素必须包含在原始消息的 <body/> 中。下面的例子将演示，当 Juliet 向一个不存在的用户发送“ hi ”消息后的包体：

例子：

<message

to="juliet@capulet.com"

from="flomeo@montague.net"

type="error">

<error code="404">Not Found</error>

</message>

附文中有非法代码与它们所定义的含义表。

3.3.3 . <html/>

<html/> 元素结合 XHTML 名字空间（ http://www.w3.org/1999/xhtml ），为一个消息提供一个交替的名字空间，就像在 email 世界中规定同时发送普通文本与 HTML 版本的邮件消息一样。这个功能使用的是 W3C 开发的基本 XHTML 格式（ http://www.w3.org/TR/xhtml-basic/ ），关于 Jabber 在消息中的 XHTML 执行细节，请看 Jabber 消息的暂定格式规范（ http://docs.jabber.org/draft-proto/html/xhtml.html ）。所有 XHTML 的根元素都必须是 <html xmlns=”http://www.w3.org/1999/xhmtl”></html> 。这个根元素中，支持任何一个基本 XHTML 格式中定义的元素，但不是每一个元素可以通过即时消息的上下文来进行理解。

3.3.4 . <subject/>

这是一个可选元素，包含消息的标题。

3.3.5 . <thread/>

当一个 Jabber 客户端发送一个 ”chat” 类型的消息，将生成唯一的线程 ID （通常是由发送者的 Jabber ID 和当前时间生成的一个 hash ）。消息发送者和接收者在聊天中后续的消息都包含一个 <thread/> 子元素，这个子元素包含原始线程 ID 。这使得消息发送者和接收者对回复进行认证并创建一个对话线程。下面的是例子：

<message

from="juliet@capulet.com/balcony"

to="romeo@montague.net/orchard"

type="chat">

<thread>AAC96FEFDE226C2C04BE8F2E19A2151B</thread>

<body>Art thou not Romeo and a Montague?</body>

</message>

<message

from="romeo@montague.net/orchard"

to="juliet@capulet.com/balcony"

type="chat">

<thread>AAC96FEFDE226C2C04BE8F2E19A2151B</thread>

<body>Neither, fair saint, if either thee dislike.</body>

</message>

3.3.6 . <x/>

<x/> 元素作为一个扩展机制来使用，或发送从服务器发送命令给客户端，或从一个客户端发送命令到另一个客户端。每次用到这个元素时，必须指明相关的 XML 名字空间。单一消息可以包含多个 <x/> 子元素实例。下列已定义的名字空间可以被 <x/> 子元素使用：

l jabber:x:autoupdate

l jabber:x:delay

l jabber:x:encrypted

l jabber:x:oob

l jabber:x:roster

这些名字空间在下面的 Jabber 名字空间中被更完整地描述。

下面是一个使用 jabber:x:delay 名字空间在加入的群组聊天室的显示上下文的例子：

<message

type=’groupchat’

from=’cauldron@conference.witches.org’>

<body>Thrice the brinded cat hath mew’d.</body>

<x xmlns=’jabber:x:delay’

stamp=’10541031T21:43:40’>Cached In GC History</x>

</message>

4. <presence/> 元素

<presence/> 元素提供关于一个 Jabber 实体的可用性信息。任何一个通过一个 Jabber ID 确认的实体可以与另一个实体进行在线状态信息的通信，这种通信大多以订阅在线状态信息的方式进行。

所有实体表现出的在线状态不是“可用”就是“不可用”。“可用”状态表示发送者可以立即收到消息。“不可用”状态表示发送者不能在当前时间收到任何数据。默认情况下，所有 <presence/> 元素除非包含 type=”unavailable” 属性外，都表示“可用”。“可用”的更多特殊形势通过 <status/> 和 <show/> 子元素进行指定。

4.1. “ type ”属性

<presence/> 的“ type ”属性根据不同目的使用。除了提示其它用户本用户的可用性状态的“普通”用法外，还包括订阅、取消订阅、以及探测在线状态信息。下面是“ type ”属性的可用值：

4.1.1 . type=”available”

如果没有包含任何“ type ”属性，在线状态包将被设为 type=”available” ，用来提供用户在线时的信息。一个 type=”available” 的在线状态包通常包含一个 <show/> 元素以详细说明 Jabber 实体的可用类型，以及一个 <status/> 元素，该元素包含人能看懂的关于该可用类型的描述。在线状态包还可以包含一个 <priority/> 元素，来指明该连接的 Jabber ID 的优先级。

例子：

<presence

from="juliet@capulet.com/balcony"

to="romeo@montague.net/orchard"/>

<status>Stay but a little, I will come again.</status>

</presence>

<show/> 元素的可用值为：

l away ―― Jabber 用户或实体在线，但不能马上联系上

l chat ―― Jabber 用户或实体在线并有兴趣聊天

l dnd ―― Jabber 用户或实体在线，但不想被打扰（“ dnd ”表示“ do not disturb ”）

l xa ―― Jabber 用户或实体在线，但已经离开很长时间了（“ xa ”表示“ extended away ”）

<status/> 可以包含任意特性数据，这些数据通常包含对于用户状态的描述，如，“开会中”是“ away ”的一个表现值，或者“忙于编码”可以是“ dnd ”的一个表现。

4.1.2 . type=”error”

当一个在线状态包发送给一个不存在的 JID 时，或在发送在线状态请求时发生一个错误时，服务器都将返回一个 type=”error” 的在线状态包。

下面是一个例子（注意域名的类型）：

<presence

type="subscribe"

to="romeo@montague.nett"/>

回复的例子：

<presence

from="romeo@montague.nett"

to="juliet@capulet.com/balcony"

type="error">

<error code=’504’>Remote server timeout. Unable to deliver

packet.</error>

</presence>

4.1.3 . type=”probe”

向一个特定实体（实体不能发送在线状态消息给自己）发出在线状态信息请求。服务器而非客户端，进行一个探测请求。实际上，虽然 Jabber 客户端也可以发送一个探测一个指定 Jabber 用户是否在线的请求，但通常都是服务器端发出探测请求。注意，只有在发起请求的用户在请求所对应的用户的花名册上，并且拥有“ from ”或“ both ”订阅类型时，服务器才会发出探测请求。在下面的例子中，我们将看到我们的英雄 Romeo 向 Juliet 发出一个探测请求， Juliet 所在服务器回复一个“状态报告包”（包含 jabber:x:delay 名字空间中指明的上次在线状态更新的时间戳）

探测请求的例子：

<presence

from="romeo@montague.net"

to="juliet@capulet.com"

type="probe"/>

回复探测请求的例子：

<presence

from="juliet@capulet.com/."

to="romeo@montague.net">

<status>Stay but a little, I will come again.</status>

xmlns="jabber:x:delay"

from="juliet@capulet.com/."

stamp="15310309T23:47:15"/>

</presence>

4.1.4 . type=”subscribe”

发送一个请求，这个请求是接收者在其在线状态改变时，自动发送在线状态信息给发送者。

例子：

<presence

from="romeo@montague.net"

to="juliet@capulet.com"

type="subscribe"/>

4.1.5 . type=”subscribed”

发送一个消息，表明发送者接受了接受者对其再现状态订阅的请求。从现在起，当发送者的在线状态信息改变时，服务器将会把状态信息发送给接收者。

例子：

<presence

from="juliet@capulet.com"

to="romeo@montague.net"

type="subscribed"/>

4.1.6 . type=”unavailable”

例子：

<presence

from="juliet@capulet.com"

to="romeo@montague.net"

type="unavailable">

<status>Disconnnected</status>

</presence>

4.1.7 . type=”unsubscribe”

发送一个请求，表明接收者停止发送在线状态信息给发送者。

例子：

<presence

from="juliet@capulet.com"

to="romeo@montague.net"

type="unsubscribe"/>

4.1.8 . type=”unsubscribed”

这种类型的在线状态包有两个用途：

1. 发送一个表明发送者接受接收者关于不订阅其在线状态信息的请求的通知。服务器将不再发送发送者的在线状态信息给接收者。

2. 拒绝一个订阅请求。服务器将不再发送发送者的在线状态信息给试图订阅其在线状态信息的用户。

例子：

<presence

from="romeo@montague.net"

to="juliet@capulet.com"

type="unsubscribed"/>

4.2. 其它 <presence/> 属性

除了设置“ type ”属性，还可以通过下列属性修改 <presence/> 元素：

4.2.1 . “ from ”属性

标识在线状态包的发送者。一般 Jabber ID 再“ from ”属性中必须写成 user@host/resource 的格式。从 XML 的观点来说，这个属性是所有 <presence/> 元素所必须的，而在实际应用中，都是服务器对该属性进行添加和修改（防止一些欺骗的手段），因此客户端开发者不需要考虑它。

例子：

4.2.2 . “ id ”属性

为在线状态请求包配置唯一的验证符。“ id ”属性由 Jabber 客户端或客户库（如 Gabber 或 JabberCOM ）生成，客户端用其为在线状态包的轨迹进行验证。“ id ”属性是可选的，并且不能用于系统其它任何地方。

例子：

4.2.3 . “ to ”属性

标识在线状态包的接收者。一般 Jabber ID 在“ to ”属性中都是 user@host/resource 的格式， user@host 的格式也是可以的，但当接收者在线时，它将转化为 user@host/resource 。在 Jabber 的一般用法中， Jabber 客户端向服务器发出在线状态包，服务器将这些在线状态包发送到该用户花名册上所有的用户。当一个 Jabber 客户端发送的 <presence/> 元素中不含“ to ”属性时，服务器将将其转化为在线状态包发送给指定的 Jabber 实体。下面的例子将演示这一过程。

发送给服务器的在线状态的例子：

<status>Stay but a little, I will come again.</status>

</presence>

服务器发给指定用户的在线状态例子：

<presence

to="romeo@montague.net/orchard"

from="juliet@capulet.com/balcony">

<status>Stay but a little, I will come again.</status>

</presence>

4.3. <presence/> 的子元素

下面的元素用于 <presence/> 协议。

4.3.1 . <priority/>

在 Jabber 中，根据 Jabber 知道的设备数或位置数，一个用户可以建立相同数量的连接。用户可以给每一个资源赋予一个数字优先级（通过对指派给该资源的 Jabber 客户端进行设置），这个优先级与 <presence/> 元素的子元素 <priority/> 方法进行通信。

当在线状态包发送到服务器后，服务器有能力决定哪一个连接资源需要指派一个单一的 Jabber ID ，该资源将收到发往该 Jabber ID 的消息，这是因为数字最高的资源是默认或第一资源。如果最高优先级的资源不可用，消息和其它 Jabber 通信将发送给次高优先级的资源（当其它资源都不可用时，一个没有从默认数到 0 的优先级的客户端，也可以成为第一资源）

举例来说， Julie 可以通过两个资源： the balcony 和 the chamber 连接她的帐号 juliet@capulet.com 。如果“ balcony ”资源的优先级被设置为“ 2 ” ，而“ chamber ”资源的优先级被设为“ 1 ” ，而且两个资源都可以连接，消息将发送到 juliet@capulet.com/balcony ，而不是 juliet@capulet.com/chamber 。

4.3.2 . <show/>

可选的 <show/> 元素告诉 Jabber 客户端如何显示一个用户的在线状态。 <show> 标