版本：7.0.2

本站内所有文档均为中英对照文档，点击中文可以显示英文。此提醒连续关闭5次后，将不再显示。

文档内容来源于 spring.io，由 springdoc.tech 翻译，版权归属于 SPRING.IO (Broadcom. Inc)。可供个人学习、研究，未经许可，不得进行转载或用于商业行为。

XMPP 支持

DeepSeek V3 中英对照 XMPP Support

Spring Integration 为 XMPP 提供了通道适配器。XMPP 代表“可扩展消息与存在协议”。

XMPP描述了一种在分布式系统中多个代理相互通信的方式。其典型应用场景是发送和接收聊天消息，不过XMPP也可以（并且已经）用于其他类型的应用程序。XMPP描述了一个参与者网络。在该网络中，参与者可以直接相互寻址，并广播状态变更（例如“在线状态”）。

XMPP 提供了支撑全球一些最大即时通讯网络的消息传递基础架构，包括 Google Talk（GTalk，也可在 GMail 中使用）和 Facebook Chat。目前有许多优秀的开源 XMPP 服务器可供选择。其中两种流行的实现是 Openfire 和 ejabberd。

Spring Integration 通过提供 XMPP 适配器来支持 XMPP，这些适配器支持发送和接收 XMPP 聊天消息以及客户端花名册中其他条目的状态变更。

此依赖项为项目所需：

Maven
Gradle

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-xmpp</artifactId>
    <version>7.0.2</version>
</dependency>

compile "org.springframework.integration:spring-integration-xmpp:7.0.2"

与其他适配器一样，XMPP适配器也支持便捷的基于命名空间的配置。要配置XMPP命名空间，请在XML配置文件的头部包含以下元素：

xmlns:int-xmpp="http://www.springframework.org/schema/integration/xmpp"
xsi:schemaLocation="http://www.springframework.org/schema/integration/xmpp
	https://www.springframework.org/schema/integration/xmpp/spring-integration-xmpp.xsd"

XMPP 连接

在使用入站或出站 XMPP 适配器参与 XMPP 网络之前，参与者必须建立其 XMPP 连接。连接到特定账户的所有 XMPP 适配器可以共享此连接对象。通常，这至少需要 user、password 和 host。要创建基本的 XMPP 连接，您可以使用命名空间的便利性，如下例所示：

<int-xmpp:xmpp-connection
    id="myConnection"
    user="user"
    password="password"
    host="host"
    port="port"
    resource="theNameOfTheResource"
    subscription-mode="accept_all"/>

备注

为了增加便利性，您可以依赖默认命名约定并省略 id 属性。此连接 Bean 将使用默认名称 (xmppConnection)。

如果 XMPP 连接变得不稳定，只要之前的连接状态是已登录（已认证），系统就会尝试自动重新连接并登录。我们还会注册一个 ConnectionListener，当启用 DEBUG 日志级别时，它会记录连接事件。

subscription-mode 属性用于启动花名册监听器，以处理来自其他用户的订阅请求。此功能并非在所有目标 XMPP 服务器上都可用。例如，Google Cloud Messaging (GCM) 和 Firebase Cloud Messaging (FCM) 会完全禁用此功能。若需关闭针对订阅的花名册监听器，您可以在使用 XML 配置时将其设为空字符串 (subscription-mode="")，或在使用 Java 配置时调用 XmppConnectionFactoryBean.setSubscriptionMode(null)。这样做也会在登录阶段禁用花名册功能。更多信息请参阅 Roster.setRosterLoadedAtLogin(boolean)。

XMPP 消息

Spring Integration 提供了发送和接收 XMPP 消息的支持。对于接收消息，它提供了一个入站消息通道适配器。对于发送消息，它提供了一个出站消息通道适配器。

入站消息通道适配器

Spring Integration适配器支持接收来自系统中其他用户的聊天消息。为此，入站消息通道适配器会代表您以用户身份“登录”，并接收发送给该用户的消息。这些消息随后会被转发到您的Spring Integration客户端。inbound-channel-adapter 元素为XMPP入站消息通道适配器提供了配置支持。以下示例展示了如何配置它：

<int-xmpp:inbound-channel-adapter id="xmppInboundAdapter"
	channel="xmppInbound"
	xmpp-connection="testConnection"
	payload-expression="getExtension('google:mobile:data').json"
	stanza-filter="stanzaFilter"
	auto-startup="true"/>

除了通常的属性（针对消息通道适配器），此适配器还需要引用一个 XMPP 连接。

XMPP入站适配器是事件驱动的，并且实现了Lifecycle接口。启动时，它会注册一个PacketListener来监听传入的XMPP聊天消息。任何接收到的消息都会被转发到底层适配器，由该适配器将其转换为Spring Integration消息并发送到指定的channel。停止时，它会注销PacketListener。

从 4.3 版本开始，ChatMessageListeningEndpoint（及其 <int-xmpp:inbound-channel-adapter>）支持注入一个 org.jivesoftware.smack.filter.StanzaFilter，该过滤器将与内部的 StanzaListener 实现一起注册到提供的 XMPPConnection 上。更多信息请参阅 Javadoc。

在版本 4.3 中，ChatMessageListeningEndpoint 引入了 payload-expression 属性。传入的 org.jivesoftware.smack.packet.Message 对象将作为评估上下文中的根对象。当您使用 XMPP 扩展时，此选项非常有用。例如，对于 GCM 协议，我们可以通过以下表达式提取消息体：

payload-expression="getExtension('google:mobile:data').json"

以下示例提取了 XHTML 协议的消息体：

payload-expression="getExtension(T(org.jivesoftware.smackx.xhtmlim.packet.XHTMLExtension).NAMESPACE).bodies[0]"

为了简化在 XMPP 消息中访问扩展的操作，EvaluationContext 中添加了 extension 变量。请注意，仅当消息中存在单个扩展时才会添加此变量。之前展示 namespace 操作的示例可以简化为以下示例：

payload-expression="#extension.json"
payload-expression="#extension.bodies[0]"

出站消息通道适配器

您还可以通过使用出站消息通道适配器向 XMPP 上的其他用户发送聊天消息。outbound-channel-adapter 元素为 XMPP 出站消息通道适配器提供了配置支持。

<int-xmpp:outbound-channel-adapter id="outboundEventAdapter"
						channel="outboundEventChannel"
						xmpp-connection="testConnection"/>

适配器期望其输入（至少）是一个类型为 java.lang.String 的负载，以及一个用于指定消息应发送给哪个用户的 XmppHeaders.CHAT_TO 标头值。要创建消息，您可以使用类似以下 Java 代码：

Message<String> xmppOutboundMsg = MessageBuilder.withPayload("Hello, XMPP!" )
						.setHeader(XmppHeaders.CHAT_TO, "userhandle")
						.build();

您也可以通过使用 XMPP 头信息增强器支持来设置头信息，如下例所示：

<int-xmpp:header-enricher input-channel="input" output-channel="output">
	<int-xmpp:chat-to value="test1@example.org"/>
</int-xmpp:header-enricher>

从 4.3 版本开始，ChatMessageSendingMessageHandler（XML 配置中的 <int-xmpp:outbound-channel-adapter>）已添加对数据包扩展的支持。除了常规的 String 和 org.jivesoftware.smack.packet.Message 负载外，现在您还可以发送负载为 org.jivesoftware.smack.packet.XmlElement 的消息（该负载会被填充到 org.jivesoftware.smack.packet.Message.addExtension() 中），而不是使用 setBody()。为了方便起见，我们为 ChatMessageSendingMessageHandler 添加了一个 extension-provider 选项。它允许您注入 org.jivesoftware.smack.provider.ExtensionElementProvider，该提供程序会在运行时根据负载构建 XmlElement。在这种情况下，负载必须是 JSON 或 XML 格式的字符串，具体取决于 XEP 协议。

XMPP 在线状态

XMPP 同样支持状态广播功能。您可利用此功能让将您添加至联系人列表的用户看到您的状态变更。这在即时通讯客户端中十分常见：当您更改离开状态并设置离开消息时，所有将您添加为联系人的用户都会看到您的图标或用户名随之更新，并可能看到您新设置的“离开”消息。若您希望接收状态变更通知或向他人通知状态变更，可使用 Spring Integration 的“presence”适配器。

入站联系人列表消息通道适配器

Spring Integration 提供了一个入站在线状态消息通道适配器，它支持接收系统中位于您联系人列表中的其他用户的在线状态事件。为此，适配器会代表您以用户身份“登录”，注册一个 RosterListener，并将接收到的在线状态更新事件作为消息转发到由 channel 属性标识的通道。消息的有效载荷是一个 org.jivesoftware.smack.packet.Presence 对象（参见 www.igniterealtime.org/builds/smack/docs/latest/javadoc/org/jivesoftware/smack/packet/Presence.html）。

presence-inbound-channel-adapter 元素为 XMPP 入站出席消息通道适配器提供配置支持。以下示例配置了一个入站出席消息通道适配器：

<int-xmpp:presence-inbound-channel-adapter channel="outChannel"
		xmpp-connection="testConnection" auto-startup="false"/>

除了常规属性外，此适配器还需要引用一个 XMPP 连接。该适配器采用事件驱动机制，并实现了 Lifecycle 接口。启动时会注册一个 RosterListener，停止时则会注销该 RosterListener。

出站花名册消息通道适配器

Spring Integration 同样支持发送在线状态事件，以便网络中的其他用户（恰好将您添加至其联系人列表）能够看到。当您向出站在线状态消息通道适配器发送消息时，它会提取有效载荷（预期类型为 org.jivesoftware.smack.packet.Presence）并将其发送至 XMPP 连接，从而向网络中的其他用户广播您的在线状态事件。

presence-outbound-channel-adapter 元素为 XMPP 出站出席消息通道适配器提供配置支持。以下示例展示了如何配置出站出席消息通道适配器：

<int-xmpp:presence-outbound-channel-adapter id="eventOutboundPresenceChannel"
	xmpp-connection="testConnection"/>

它也可以是一个轮询消费者（如果它从可轮询通道接收消息），在这种情况下，您需要注册一个轮询器。以下示例展示了如何执行此操作：

<int-xmpp:presence-outbound-channel-adapter id="pollingOutboundPresenceAdapter"
		xmpp-connection="testConnection"
		channel="pollingChannel">
	<int:poller fixed-rate="1000" max-messages-per-poll="1"/>
</int-xmpp:presence-outbound-channel-adapter>

与入站连接类似，它需要一个对 XMPP 连接的引用。

备注

如果你依赖于 XMPP 连接 Bean 的默认命名约定（之前描述过），并且你的应用上下文中只配置了一个 XMPP 连接 Bean，那么你可以省略 xmpp-connection 属性。在这种情况下，系统会定位名为 xmppConnection 的 Bean 并将其注入到适配器中。

高级配置

Spring Integration 的 XMPP 支持基于 Smack 4.0 API (www.igniterealtime.org/projects/smack/)，该 API 允许对 XMPP 连接对象进行更复杂的配置。

如前文所述，xmpp-connection 命名空间支持旨在简化基本连接配置，仅支持少数常见配置属性。然而，org.jivesoftware.smack.ConnectionConfiguration 对象定义了约 20 个属性，为所有这些属性添加命名空间支持并无实际价值。因此，对于更复杂的连接配置，您可以将 XmppConnectionFactoryBean 的实例配置为常规 Bean，并将 org.jivesoftware.smack.ConnectionConfiguration 作为构造函数参数注入该 FactoryBean。您可以直接在该 ConnectionConfiguration 实例上指定所需的每个属性（使用 'p' 命名空间的 Bean 定义会很有效）。这样，您可以直接设置 SSL（或任何其他属性）。以下示例展示了如何实现：

<bean id="xmppConnection" class="o.s.i.xmpp.XmppConnectionFactoryBean">
    <constructor-arg>
        <bean class="org.jivesoftware.smack.ConnectionConfiguration">
            <constructor-arg value="myServiceName"/>
            <property name="socketFactory" ref="..."/>
        </bean>
    </constructor-arg>
</bean>

<int:channel id="outboundEventChannel"/>

<int-xmpp:outbound-channel-adapter id="outboundEventAdapter"
    channel="outboundEventChannel"
    xmpp-connection="xmppConnection"/>

Smack API 还提供了静态初始化器，这在某些情况下会很有帮助。对于更复杂的情况（例如注册 SASL 机制），您可能需要执行某些静态初始化器。其中一个静态初始化器是 SASLAuthentication，它允许您注册支持的 SASL 机制。对于这种复杂程度，我们建议使用 Spring Java 配置来处理 XMPP 连接配置。这样，您可以通过 Java 代码配置整个组件，并在适当的时候执行所有其他必要的 Java 代码，包括静态初始化器。以下示例展示了如何在 Java 中配置一个带有 SASL（简单认证与安全层）的 XMPP 连接：

@Configuration
public class CustomConnectionConfiguration {
  @Bean
  public XMPPConnection xmppConnection() {
	SASLAuthentication.supportSASLMechanism("EXTERNAL", 0); // static initializer

	ConnectionConfiguration config = new ConnectionConfiguration("localhost", 5223);
	config.setKeystorePath("path_to_truststore.jks");
	config.setSecurityEnabled(true);
	config.setSocketFactory(SSLSocketFactory.getDefault());
	return new XMPPConnection(config);
  }
}

有关使用 Java 进行应用程序上下文配置的更多信息，请参阅 Spring 参考手册中的以下部分。

XMPP 消息头部

Spring Integration XMPP 适配器会自动映射标准的 XMPP 属性。默认情况下，这些属性会通过使用 DefaultXmppHeaderMapper 在 Spring Integration 的 MessageHeaders 之间进行复制。

除非通过 DefaultXmppHeaderMapper 的 requestHeaderNames 或 replyHeaderNames 属性明确指定，否则任何用户自定义的头部都不会复制到 XMPP 消息中，也不会从 XMPP 消息中复制出来。

提示

在映射用户自定义头部时，其值也可以包含简单的通配符模式（例如 "thing*" 或 "*thing"）。

从版本4.1开始，AbstractHeaderMapper（DefaultXmppHeaderMapper 的超类）允许您为 requestHeaderNames 属性配置 NON_STANDARD_HEADERS 令牌（除了 STANDARD_REQUEST_HEADERS 之外），以映射所有用户定义的头部。

org.springframework.xmpp.XmppHeaders 类定义了 DefaultXmppHeaderMapper 使用的默认头部信息：

xmpp_from
xmpp_subject
xmpp_thread
xmpp_to
xmpp_type

从 4.3 版本开始，你可以在头部映射模式前添加 ! 来否定该模式。否定模式具有优先级，因此像 STANDARD_REQUEST_HEADERS,thing1,thing*,!thing2,!thing3,qux,!thing1 这样的列表不会映射 thing1、thing2 或 thing3。该列表会映射标准头部以及 thing4 和 qux。

important

如果你有一个以 ! 开头的自定义请求头，并且你希望映射它，可以通过 \ 进行转义，例如：STANDARD_REQUEST_HEADERS,\!myBangHeader。在这个例子中，标准请求头和 !myBangHeader 都会被映射。

XMPP 扩展

扩展功能让“可扩展消息与在场协议”真正实现了“可扩展”。

XMPP 基于 XML 构建，XML 是一种支持命名空间概念的数据格式。通过命名空间，您可以为 XMPP 添加原始规范中未定义的功能。XMPP 规范有意仅描述一组核心功能：

客户端如何连接到服务器
加密（SSL/TLS）
身份验证
服务器之间如何通信以转发消息
其他一些基本构建模块

一旦你实现了这些，你就拥有了一个XMPP 客户端，可以发送任何类型的数据。然而，你可能需要做的不仅仅是基础功能。例如，你可能需要在消息中包含格式（粗体、斜体等），这在核心 XMPP 规范中并未定义。当然，你可以自己创造一种方式来实现，但除非其他所有人都采用与你相同的方式，否则没有其他软件能够解析它（它们会忽略无法理解的命名空间）。

为了解决这个问题，XMPP标准基金会（XSF）发布了一系列额外文档，称为XMPP扩展协议（XEPs）。通常，每个XEP描述一项特定的活动（从消息格式到文件传输、多人聊天等等）。它们还为每个人在该活动中使用提供了标准格式。

Smack API 通过其 extensions 和 experimental 项目提供了许多 XEP 实现。从 Spring Integration 4.3 版本开始，您可以将任何 XEP 与现有的 XMPP 通道适配器一起使用。

为了处理 XEPs 或其他自定义 XMPP 扩展，您必须预先配置 Smack 的 ProviderManager。您可以通过 static Java 代码来实现，如下例所示：

ProviderManager.addIQProvider("element", "namespace", new MyIQProvider());
ProviderManager.addExtensionProvider("element", "namespace", new MyExtProvider());

你也可以在特定实例中使用 .providers 配置文件，并通过 JVM 参数访问它，如下例所示：

-Dsmack.provider.file=file:///c:/my/provider/mycustom.providers

mycustom.providers 文件内容可能如下：

<?xml version="1.0"?>
<smackProviders>
<iqProvider>
    <elementName>query</elementName>
    <namespace>jabber:iq:time</namespace>
    <className>org.jivesoftware.smack.packet.Time</className>
</iqProvider>

<iqProvider>
    <elementName>query</elementName>
    <namespace>https://jabber.org/protocol/disco#items</namespace>
    <className>org.jivesoftware.smackx.provider.DiscoverItemsProvider</className>
</iqProvider>

<extensionProvider>
    <elementName>subscription</elementName>
    <namespace>https://jabber.org/protocol/pubsub</namespace>
    <className>org.jivesoftware.smackx.pubsub.provider.SubscriptionProvider</className>
</extensionProvider>
</smackProviders>

例如，最流行的XMPP消息传递扩展是Google Cloud Messaging（GCM）。为此，Smack库提供了org.jivesoftware.smackx.gcm.provider.GcmExtensionProvider。默认情况下，它会通过experimental.providers资源将该类注册到类路径中的smack-experimental jar中，如下面的Maven示例所示：

<!-- GCM JSON payload -->
<extensionProvider>
    <elementName>gcm</elementName>
    <namespace>google:mobile:data</namespace>
    <className>org.jivesoftware.smackx.gcm.provider.GcmExtensionProvider</className>
</extensionProvider>

此外，GcmPacketExtension 允许目标消息协议解析传入的数据包并构建传出的数据包，如下例所示：

GcmPacketExtension gcmExtension = (GcmPacketExtension) xmppMessage.getExtension(GcmPacketExtension.NAMESPACE);
String message = gcmExtension.getJson());

GcmPacketExtension packetExtension = new GcmPacketExtension(gcmJson);
Message smackMessage = new Message();
smackMessage.addExtension(packetExtension);

有关更多信息，请参阅本章前面的入站消息通道适配器和出站消息通道适配器。

XMPP 连接​

XMPP 消息​

入站消息通道适配器​

出站消息通道适配器​

XMPP 在线状态​

入站联系人列表消息通道适配器​

出站花名册消息通道适配器​

高级配置​

XMPP 消息头部​

XMPP 扩展​