XMPP 支持

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

XMPP 描述了一种分布式系统中多个代理相互通信的方式。规范用例是发送和接收聊天消息，尽管 XMPP 可以（并且正在）用于其他类型的应用程序。XMPP 描述了一个参与者网络。在该网络中，参与者可以直接相互联系并广播状态变化（例如“存在”）。

XMPP 提供的消息结构是世界上一些最大的即时消息网络的基础，包括 Google Talk（GTalk，也可从 GMail 中获得）和 Facebook Chat。许多优秀的开源 XMPP 服务器都可用。两个流行的实现是Openfire和ejabberd。

Spring 集成通过提供 XMPP 适配器来提供对 XMPP 的支持，该适配器支持发送和接收 XMPP 聊天消息以及来自客户端名册中其他条目的状态更改。

您需要将此依赖项包含到您的项目中：

Maven
<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-xmpp</artifactId>
    <version>5.5.13</version>
</dependency>
Gradle
compile "org.springframework.integration:spring-integration-xmpp:5.5.13"

与其他适配器一样，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属性。默认名称 ( xmppConnection) 用于此连接 bean。

如果 XMPP 连接过时，只要记录了先前的连接状态（经过身份验证），就会使用自动登录进行重新连接尝试。我们还注册了一个，如果启用ConnectionListener了日志记录级别，它会记录连接事件。DEBUG

该subscription-mode属性启动名册侦听器以处理来自其他用户的传入订阅。此功能并非始终可用于目标 XMPP 服务器。例如，Google Cloud Messaging (GCM) 和 Firebase Cloud Messaging (FCM) 完全禁用它。要关闭订阅的名册侦听器，您可以在使用 XML 配置 ( subscription-mode="") 或XmppConnectionFactoryBean.setSubscriptionMode(null)使用 Java 配置时将其配置为空字符串。这样做也会在登录阶段禁用名册。有关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要在 provided 上注册的 aXMPPConnection以及内部StanzaListener实现。有关更多信息，请参阅Javadoc。

4.3 版引入payload-expression了ChatMessageListeningEndpoint. 传入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 消息中扩展的访问，该extension变量被添加到EvaluationContext. 请注意，当消息中只有一个扩展名时，会添加它。前面显示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 header-enricher 支持设置标头，如以下示例所示：

<int-xmpp:header-enricher input-channel="input" output-channel="output">
	<int-xmpp:chat-to value="[email protected]"/>
</int-xmpp:header-enricher>

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

XMPP 存在

XMPP 还支持广播状态。您可以使用此功能让名册上有您的人看到您的状态变化。这种情况一直发生在您的 IM 客户端中。您更改了离开状态并设置了离开消息，而将您列入名单的每个人都会看到您的图标或用户名更改以反映这种新状态，并且可能会看到您的新“离开”消息。如果您想接收通知或通知其他人状态更改，您可以使用 Spring Integration 的“存在​​”适配器。

入站状态消息通道适配器

Spring Integration 提供了一个入站在线状态消息通道适配器，它支持从系统中您名册上的其他用户接收在线状态事件。为此，适配器代表您以用户身份“登录”，注册 aRosterListener并将接收到的存在更新事件作为消息转发到由channel属性标识的通道。消息的有效负载是一个org.jivesoftware.smack.packet.Presence对象（参见https://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在启动时注册 a 并RosterListener在停止时取消注册。

出站状态消息通道适配器

Spring Integration 还支持发送在线状态事件，以供网络中碰巧有你在他们名单上的其他用户看到。当您向出站状态消息通道适配器发送消息时，它会提取有效负载（预计为 type 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 Connection bean 的默认命名约定（如前所述）并且您在应用程序上下文中只配置了一个 XMPP Connection bean，则可以省略该xmpp-connection属性。在这种情况下，命名的 beanxmppConnection被定位并注入到适配器中。

高级配置

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

如前所述，xmpp-connection命名空间支持旨在简化基本连接配置，并且仅支持少数常见的配置属性。但是，该org.jivesoftware.smack.ConnectionConfiguration对象定义了大约 20 个属性，并且为所有这些属性添加命名空间支持并没有真正的价值。因此，对于更复杂的连接配置，您可以将 our 的实例配置XmppConnectionFactoryBean为常规 bean，并将 aorg.jivesoftware.smack.ConnectionConfiguration作为构造函数参数注入 that 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 机制。对于这种复杂程度，我们建议对 XMPP 连接配置使用 Spring Java 配置。这样，您可以通过 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 属性。默认情况下，这些属性MessageHeaders通过使用 DefaultXmppHeaderMapper.

除非由. requestHeaderNames_replyHeaderNamesDefaultXmppHeaderMapper

映射用户定义的标头时，值还可以包含简单的通配符模式（例如“thing*”或“*thing”）。

从 4.1 版开始，AbstractHeaderMapper（的超类DefaultXmppHeaderMapper）允许您NON_STANDARD_HEADERS为属性配置令牌requestHeaderNames（除了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。

!如果您有一个以您希望映射 的开头的用户定义标头，则可以使用以下命令对其进行转义\：STANDARD_REQUEST_HEADERS,\!myBangHeader. 在该示例中，标准请求标头和!myBangHeader被映射。

XMPP 扩展

扩展将“Extensible”放在“Extensible Messaging and Presence Protocol”中。

XMPP 基于 XML，这是一种支持命名空间概念的数据格式。通过命名空间，您可以向 XMPP 添加原始规范中未定义的位。XMPP 规范特意只描述了一组核心特性：

  • 客户端如何连接到服务器

  • 加密 (SSL/TLS)

  • 验证

  • 服务器如何相互通信以中继消息

  • 其他一些基本构建块

一旦你实现了这个，你就有了一个 XMPP 客户端，并且可以发送你喜欢的任何类型的数据。但是，您可能需要做的不仅仅是基础知识。例如，您可能需要在消息中包含格式（粗体、斜体等），这在核心 XMPP 规范中没有定义。好吧，您可以想出一种方法来做到这一点，但是，除非其他人都按照您的方式进行操作，否则没有其他软件可以解释它（它们会忽略它们无法理解的名称空间）。

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

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

为了能够处理 XEP 或任何其他自定义 XMPP 扩展，您必须提供 Smack 的ProviderManager预配置。您可以使用staticJava 代码执行此操作，如以下示例所示：

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就是为此目的而提供的。默认情况下，它smack-experimental使用资源在类路径中的 jar 中注册该类experimental.providers，如以下 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);

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

1. see XML Configuration