WebSockets 支持

从版本 4.1 开始， Spring 集成具有 WebSocket 支持。它基于 Spring Framework 的web-socket模块。因此，Spring WebSocket 的许多组件（例如SubProtocolHandler或WebSocketClient）和配置选项（例如@EnableWebSocketMessageBroker）可以在 Spring Integration 中重用。有关更多信息，请参阅 Spring Framework 参考手册中的 Spring Framework WebSocket Support 一章。spring-doc.cadn.net.cn

您需要将此依赖项包含在您的项目中：spring-doc.cadn.net.cn

Mavenspring-doc.cadn.net.cn
Gradlespring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-websocket</artifactId>
    <version>6.4.0</version>
</dependency>

compile "org.springframework.integration:spring-integration-websocket:6.4.0"

对于服务器端，org.springframework:spring-webmvc依赖项必须显式包含。spring-doc.cadn.net.cn

Spring 框架 WebSocket 基础设施基于 Spring 消息传递基础，并提供了基于相同的基本消息传递框架MessageChannelimplementations 和MessageHandlerSpring 集成使用的实现（以及一些 POJO 方法的 Comments 映射）。因此， Spring 集成可以直接参与 WebSocket 流，即使没有 WebSocket 适配器也是如此。为此，您可以配置 Spring 集成@MessagingGateway替换为适当的注释，如下例所示：spring-doc.cadn.net.cn

@MessagingGateway
@Controller
public interface WebSocketGateway {

    @MessageMapping("/greeting")
    @SendToUser("/queue/answer")
    @Gateway(requestChannel = "greetingChannel")
    String greeting(String payload);

}

概述

由于 WebSocket 协议根据定义是流式的，并且我们可以同时向 WebSocket 发送消息和从 WebSocket 接收消息，因此我们可以处理适当的WebSocketSession，无论是在客户端还是服务器端。要封装连接管理和WebSocketSession注册表中，使用IntegrationWebSocketContainer提供ClientWebSocketContainer和ServerWebSocketContainer实现。由于 WebSocket API 及其在 Spring Framework 中的实现（具有许多扩展），在服务器端和客户端（当然，从 Java 的角度来看）使用相同的类。因此，大多数 connection 和WebSocketSession注册表选项在两侧相同。这允许我们重用许多配置项和基础设施钩子，以在服务器端和客户端构建 WebSocket 应用程序。以下示例显示了组件如何同时实现这两个目的：spring-doc.cadn.net.cn

//Client side
@Bean
public WebSocketClient webSocketClient() {
    return new SockJsClient(Collections.singletonList(new WebSocketTransport(new JettyWebSocketClient())));
}

@Bean
public IntegrationWebSocketContainer clientWebSocketContainer() {
    return new ClientWebSocketContainer(webSocketClient(), "ws://my.server.com/endpoint");
}

//Server side
@Bean
public IntegrationWebSocketContainer serverWebSocketContainer() {
    return new ServerWebSocketContainer("/endpoint").withSockJs();
}

这IntegrationWebSocketContainer旨在实现双向消息传递，并且可以在入站和出站通道适配器之间共享（见下文），在使用单向（发送或接收）WebSocket 消息传递时，只能从其中一个适配器引用。它可以在没有任何通道适配器的情况下使用，但是，在这种情况下，IntegrationWebSocketContainer仅扮演WebSocketSession注册表。spring-doc.cadn.net.cn

这ServerWebSocketContainer实现WebSocketConfigurer注册内部IntegrationWebSocketContainer.IntegrationWebSocketHandler作为Endpoint. 它根据提供的paths和其他服务器 WebSocket 选项（例如HandshakeHandler或SockJS fallback）中的ServletWebSocketHandlerRegistry为目标供应商 WebSocket 容器。此注册是通过基础设施实现的WebSocketIntegrationConfigurationInitializer组件，其作用与@EnableWebSocket注解。这意味着，通过使用@EnableIntegration（或应用程序上下文中的任何 Spring 集成名称空间）的@EnableWebSocket声明，因为 Spring 集成基础结构会检测所有 WebSocket 端点。

从版本 6.1 开始，ClientWebSocketContainer可以使用提供的URI而不是uriTemplate和uriVariables组合。这在 URI 的某些部分需要自定义编码的情况下非常有用。请参阅UriComponentsBuilderAPI 为方便起见。spring-doc.cadn.net.cn

WebSocket 入站通道适配器

这WebSocketInboundChannelAdapter实现WebSocketSession互动。您必须为其提供IntegrationWebSocketContainer，并且适配器会将自身注册为WebSocketListener处理传入消息，使用WebSocketSession事件。spring-doc.cadn.net.cn

只有一个WebSocketListener可以在IntegrationWebSocketContainer.

对于 WebSocket 子协议，WebSocketInboundChannelAdapter可配置SubProtocolHandlerRegistry作为第二个 constructor 参数。适配器将SubProtocolHandlerRegistry以确定适当的SubProtocolHandler对于被接受的WebSocketSession并将WebSocketMessage更改为Message根据子协议实现。spring-doc.cadn.net.cn

默认情况下，WebSocketInboundChannelAdapter仅依赖于原始PassThruSubProtocolHandler实现，它会将WebSocketMessage更改为Message.

这WebSocketInboundChannelAdapter仅接受并发送到底层集成流Message具有SimpMessageType.MESSAGE或空的simpMessageType页眉。所有其他Message类型通过ApplicationEvent实例从SubProtocolHandlerimplementation （例如StompSubProtocolHandler).spring-doc.cadn.net.cn

在服务器端，如果@EnableWebSocketMessageBroker配置，您可以配置WebSocketInboundChannelAdapter使用useBroker = true选择。在这种情况下，所有non-MESSAGE Message类型委托给提供的AbstractBrokerMessageHandler. 此外，如果代理中继配置了目标前缀，则与 Broker 目标匹配的消息将路由到AbstractBrokerMessageHandler而不是发送到outputChannel的WebSocketInboundChannelAdapter.spring-doc.cadn.net.cn

如果useBroker = false接收到的消息是SimpMessageType.CONNECTtype 中，使用WebSocketInboundChannelAdapter立即发送SimpMessageType.CONNECT_ACKmessage 发送到WebSocketSession而不将其发送到频道。spring-doc.cadn.net.cn

Spring 的 WebSocket 支持只允许配置一个代理中继。因此，我们不需要AbstractBrokerMessageHandler参考。在 Application Context 中检测到它。

有关更多配置选项，请参阅 WebSockets 命名空间支持。spring-doc.cadn.net.cn

WebSocket 出站通道适配器

这WebSocketOutboundChannelAdapter:spring-doc.cadn.net.cn

接受来自其 Spring Integration 的消息MessageChannelspring-doc.cadn.net.cn
确定WebSocketSession id从MessageHeadersspring-doc.cadn.net.cn
检索WebSocketSession从提供的IntegrationWebSocketContainerspring-doc.cadn.net.cn
委托WebSocketMessage工作到适当的SubProtocolHandler从提供的SubProtocolHandlerRegistry.spring-doc.cadn.net.cn

在客户端，WebSocketSession idmessage 标头不是必需的，因为ClientWebSocketContainer仅处理单个连接及其WebSocketSession分别。spring-doc.cadn.net.cn

要使用 STOMP 子协议，您应该为此适配器配置一个StompSubProtocolHandler. 然后，您可以使用StompHeaderAccessor.create(StompCommand…)以及MessageBuilder，或者只使用HeaderEnricher（请参阅 Header Enricher）。spring-doc.cadn.net.cn

本章的其余部分主要介绍其他配置选项。spring-doc.cadn.net.cn

WebSockets 命名空间支持

Spring 集成 WebSocket 名称空间包括本章其余部分中描述的几个组件。要将其包含在配置中，请在应用程序上下文配置文件中使用以下命名空间声明：spring-doc.cadn.net.cn

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:int="http://www.springframework.org/schema/integration"
  xmlns:int-websocket="http://www.springframework.org/schema/integration/websocket"
  xsi:schemaLocation="
    http://www.springframework.org/schema/beans
    https://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/integration
    https://www.springframework.org/schema/integration/spring-integration.xsd
    http://www.springframework.org/schema/integration/websocket
    https://www.springframework.org/schema/integration/websocket/spring-integration-websocket.xsd">
    ...
</beans>

`<int-websocket:client-container>`属性

以下清单显示了可用于<int-websocket:client-container>元素：spring-doc.cadn.net.cn

<int-websocket:client-container
                  id=""                             (1)
                  client=""                         (2)
                  uri=""                            (3)
                  uri-variables=""                  (4)
                  origin=""                         (5)
                  send-time-limit=""                (6)
                  send-buffer-size-limit=""         (7)
                  send-buffer-overflow-strategy=""  (8)
                  auto-startup=""                   (9)
                  phase="">                        (10)
                <int-websocket:http-headers>
                  <entry key="" value=""/>
                </int-websocket:http-headers>      (11)
</int-websocket:client-container>

1	组件 Bean 名称。
2	这`WebSocketClient`bean 引用。
3	这`uri`或`uriTemplate`添加到目标 WebSocket 服务。如果您将其用作`uriTemplate`使用 URI 变量占位符时，`uri-variables`属性是必需的。
4	URI 变量占位符的逗号分隔值`uri`属性值。这些值将根据它们在`uri`. 看`UriComponents.expand(Object…uriVariableValues)`.
5	这`Origin`握手 HTTP 标头值。
6	WebSocket 会话 'send' 超时限制。默认为`10000`.
7	WebSocket 会话 'send' 消息大小限制。默认为`524288`.
8	WebSocket 会话发送缓冲区溢出策略确定会话的出站消息缓冲区到达`send-buffer-size-limit`. 看`ConcurrentWebSocketSessionDecorator.OverflowStrategy`了解可能的值和更多详细信息。
9	指示此端点是否应自动启动的布尔值。默认为`false`，假设此容器是从 WebSocket 入站适配器启动的。
10	此终端节点应在其中启动和停止的生命周期阶段。值越低，此终端节点开始得越早，停止得越晚。默认值为`Integer.MAX_VALUE`. 值可以是负数。看`SmartLifeCycle`.
11	一个`Map`之`HttpHeaders`与 Handshake 请求一起使用。

`<int-websocket:server-container>`属性

以下清单显示了可用于<int-websocket:server-container>元素：spring-doc.cadn.net.cn

<int-websocket:server-container
          id=""                             (1)
          path=""                           (2)
          handshake-handler=""              (3)
          handshake-interceptors=""         (4)
          decorator-factories=""            (5)
          send-time-limit=""                (6)
          send-buffer-size-limit=""         (7)
          send-buffer-overflow-strategy=""  (8)
          allowed-origins="">               (9)
          <int-websocket:sockjs
            client-library-url=""          (10)
            stream-bytes-limit=""          (11)
            session-cookie-needed=""       (12)
            heartbeat-time=""              (13)
            disconnect-delay=""            (14)
            message-cache-size=""          (15)
            websocket-enabled=""           (16)
            scheduler=""                   (17)
            message-codec=""               (18)
            transport-handlers=""          (19)
            suppress-cors="true" />        (20)
</int-websocket:server-container>

1	组件 Bean 名称。
2	将特定请求映射到`WebSocketHandler`. 支持精确路径映射 URI（例如`/myPath`）和 ant 样式路径模式（例如`/myPath/**`).
3	这`HandshakeHandler`bean 引用。默认为`DefaultHandshakeHandler`.
4	列表`HandshakeInterceptor`bean 引用。
5	一个或多个工厂的列表（`WebSocketHandlerDecoratorFactory`），这些函数修饰用于处理 WebSocket 消息的处理程序。这对于某些高级用例可能很有用（例如，允许 Spring Security 强制关闭 WebSocket 会话（当相应的 HTTP 会话过期时）。有关更多信息，请参见 Spring Session 项目。
6	在`<int-websocket:client-container>`.
7	在`<int-websocket:client-container>`.
8	WebSocket 会话发送缓冲区溢出策略确定会话的出站消息缓冲区到达`send-buffer-size-limit`. 看`ConcurrentWebSocketSessionDecorator.OverflowStrategy`了解可能的值和更多详细信息。
9	允许的源标头值。您可以将多个源指定为逗号分隔列表。此检查主要针对浏览器客户端设计。没有什么可以阻止其他类型的 Client 端修改 origin 标头值。启用 Sockjs 并限制允许的源时，不对跨源请求使用源标头的传输类型（`jsonp-polling`,`iframe-xhr-polling`,`iframe-eventsource`和`iframe-htmlfile`）被禁用。因此，IE6 和 IE7 不受支持，IE8 和 IE9 仅支持没有 Cookie。默认情况下，允许所有源。
10	没有本机跨域通信的传输（例如`eventsource`和`htmlfile`）必须从不可见 iframe 中的“外部”域获取一个简单的页面，以便 iframe 中的代码可以从 Sockjs 服务器的本地域运行。由于 iframe 需要加载 Sockjs javascript 客户端库，因此此属性允许您指定加载它的位置。默认情况下，它指向`d1fxtkz8shb9d2.cloudfront.net/sockjs-0.3.4.min.js`. 但是，您也可以将其设置为指向应用程序提供的 URL。请注意，可以指定相对 URL，在这种情况下，URL 必须相对于 iframe URL。例如，假设将 Sockjs 端点映射到`/sockjs`生成的 iframe URL 为`/sockjs/iframe.html`，则相对 URL 必须以“../../“ 遍历到 Sockjs 映射上方的位置。对于基于前缀的 servlet 映射，您可能需要再进行一次遍历。
11	在关闭单个 HTTP 流请求之前可以通过该请求发送的最小字节数。默认为`128K`（即 128*1024 或 131072 字节）。
12	这`cookie_needed`value 在 SockJs 的响应中`/info`端点。此属性指示`JSESSIONID`应用程序需要 cookie 才能正常运行（例如，用于负载平衡或在 Java Servlet 容器中使用 HTTP 会话）。
13	服务器未发送任何消息的时间量（以毫秒为单位），超过此时间后服务器应发送向客户端发送检测信号帧，以防止连接中断。默认值为`25,000`（25 秒）。
14	在没有接收连接（即服务器可以通过该连接向客户端发送数据的活动连接）后，客户端被视为断开连接之前的时间（以毫秒为单位）。默认值为`5000`.
15	会话在等待来自客户端的下一个 HTTP 轮询请求时可以缓存的服务器到客户端消息的数量。默认大小为`100`.
16	某些负载均衡器不支持 WebSockets。将此选项设置为`false`以在服务器端禁用 WebSocket 传输。默认值为`true`.
17	这`TaskScheduler`bean 引用。新的`ThreadPoolTaskScheduler`instance 如果未提供任何值，则创建。此计划程序实例用于调度心率消息。
18	这`SockJsMessageCodec`用于编码和解码 Sockjs 消息的 bean 引用。默认情况下，`Jackson2SockJsMessageCodec`，这要求 Jackson 库存在于 Classpath 中。
19	列表`TransportHandler`bean 引用。
20	是否禁用 Sockjs 请求的自动添加 CORS 标头。默认值为`false`.

`<int-websocket:outbound-channel-adapter>`属性

以下清单显示了可用于<int-websocket:outbound-channel-adapter>元素：spring-doc.cadn.net.cn

<int-websocket:outbound-channel-adapter
                          id=""                             (1)
                          channel=""                        (2)
                          container=""                      (3)
                          default-protocol-handler=""       (4)
                          protocol-handlers=""              (5)
                          message-converters=""             (6)
                          merge-with-default-converters=""  (7)
                          auto-startup=""                   (8)
                          phase=""/>                        (9)

1	组件 Bean 名称。如果您未提供`channel`属性、`DirectChannel`在应用程序上下文中创建并注册`id`属性作为 bean 名称。在这种情况下，端点使用 Bean 名称注册`id`加`.adapter`. 而`MessageHandler`已使用 Bean 别名注册`id`加`.handler`.
2	标识连接到此适配器的通道。
3	对`IntegrationWebSocketContainer`bean，它封装了低级连接和`WebSocketSession`处理作。必填。
4	对`SubProtocolHandler`实例。当 Client 端没有请求子协议或它是单个协议处理程序时，使用它。如果此引用或`protocol-handlers`list 时，则`PassThruSubProtocolHandler`默认使用。
5	列表`SubProtocolHandler`此通道适配器的 bean 引用。如果您只提供单个 Bean 引用，并且没有提供`default-protocol-handler`，那个单`SubProtocolHandler`用作`default-protocol-handler`. 如果未设置此属性或`default-protocol-handler`这`PassThruSubProtocolHandler`默认使用。
6	列表`MessageConverter`此通道适配器的 bean 引用。
7	布尔值，指示是否应在任何自定义转换器之后注册默认转换器。此标志仅在以下情况下使用`message-converters`。否则，将注册所有默认转换器。默认为`false`. 默认转换器为（按顺序）：`StringMessageConverter`,`ByteArrayMessageConverter`和`MappingJackson2MessageConverter`（如果 Jackson 库存在于 Classpath 上）。
8	指示此端点是否应自动启动的布尔值。默认为`true`.
9	此终端节点应在其中启动和停止的生命周期阶段。值越低，此终端节点开始得越早，停止得越晚。默认值为`Integer.MIN_VALUE`. 值可以是负数。看`SmartLifeCycle`.

`<int-websocket:inbound-channel-adapter>`属性

以下清单显示了可用于<int-websocket:outbound-channel-adapter>元素：spring-doc.cadn.net.cn

<int-websocket:inbound-channel-adapter
                            id=""  (1)
                            channel=""  (2)
                            error-channel=""  (3)
                            container=""  (4)
                            default-protocol-handler=""  (5)
                            protocol-handlers=""  (6)
                            message-converters=""  (7)
                            merge-with-default-converters=""  (8)
                            send-timeout=""  (9)
                            payload-type=""  (10)
                            use-broker=""  (11)
                            auto-startup=""  (12)
                            phase=""/>  (13)

1	组件 Bean 名称。如果未设置`channel`属性、`DirectChannel`在应用程序上下文中创建并注册`id`属性作为 bean 名称。在这种情况下，端点使用 Bean 名称注册`id`加`.adapter`.
2	标识连接到此适配器的通道。
3	这`MessageChannel`bean 引用，其中`ErrorMessage`实例。
4	在`<int-websocket:outbound-channel-adapter>`.
5	在`<int-websocket:outbound-channel-adapter>`.
6	在`<int-websocket:outbound-channel-adapter>`.
7	在`<int-websocket:outbound-channel-adapter>`.
8	在`<int-websocket:outbound-channel-adapter>`.
9	如果通道可以阻塞，则向通道发送消息时要等待的最长时间（以毫秒为单位）。例如，`QueueChannel`如果已达到其最大容量，则可以阻止，直到空间可用。
10	目标的 Java 类型的完全限定名称`payload`从传入的`WebSocketMessage`. 默认为`java.lang.String`.
11	指示此适配器是否发送`non-MESSAGE` `WebSocketMessage`实例和消息的 broker 目标发送到`AbstractBrokerMessageHandler`从应用程序上下文。当此属性为`true`这`Broker Relay`配置是必需的。此属性仅在服务器端使用。在客户端，它被忽略。默认为`false`.
12	在`<int-websocket:outbound-channel-adapter>`.
13	在`<int-websocket:outbound-channel-adapter>`.

用`ClientStompEncoder`

从版本 4.3.13 开始， Spring 集成提供了ClientStompEncoder（作为标准的扩展StompEncoder）在 WebSocket 通道适配器的客户端使用。为了正确地准备客户端消息，您必须注入ClientStompEncoder到StompSubProtocolHandler. 默认StompSubProtocolHandler是它是为服务器端设计的，因此它会更新SEND stompCommandheader 转换为MESSAGE（根据服务器端的 STOMP 协议的要求）。如果客户端没有以正确的SENDweb socket 框架，一些 STOMP broker 不接受它们。目的ClientStompEncoder，在本例中，是为了覆盖stompCommand标头并将其设置为SEND值，然后将消息编码为byte[].spring-doc.cadn.net.cn

动态 WebSocket 终端节点注册

从版本 5.5 开始，WebSocket 服务器端点（基于ServerWebSocketContainer）现在可以在运行时注册（和删除）-paths一个ServerWebSocketContainer映射通过HandlerMapping转换为DispatcherServlet并且可供 WebSocket 客户端访问。动态和运行时集成流支持有助于以透明的方式注册这些端点：spring-doc.cadn.net.cn

@Autowired
IntegrationFlowContext integrationFlowContext;

@Autowired
HandshakeHandler handshakeHandler;
...
ServerWebSocketContainer serverWebSocketContainer =
       new ServerWebSocketContainer("/dynamic")
               .setHandshakeHandler(this.handshakeHandler);

WebSocketInboundChannelAdapter webSocketInboundChannelAdapter =
       new WebSocketInboundChannelAdapter(serverWebSocketContainer);

QueueChannel dynamicRequestsChannel = new QueueChannel();

IntegrationFlow serverFlow =
       IntegrationFlow.from(webSocketInboundChannelAdapter)
               .channel(dynamicRequestsChannel)
               .get();

IntegrationFlowContext.IntegrationFlowRegistration dynamicServerFlow =
       this.integrationFlowContext.registration(serverFlow)
               .addBean(serverWebSocketContainer)
               .register();
...
dynamicServerFlow.destroy();

调用.addBean(serverWebSocketContainer)在 Dynamic Flow 注册上添加ServerWebSocketContainer转换为ApplicationContext用于终端节点注册。销毁动态流注册时，关联的ServerWebSocketContainer实例以及相应的端点注册（包括 URL 路径映射）也会被销毁。

动态 Websocket 端点只能通过 Spring 集成机制进行注册：当常规 Spring@EnableWebsocket时，Spring 集成配置将回退，并且不会注册动态端点的基础设施。

WebSockets 支持

概述

WebSocket 入站通道适配器

WebSocket 出站通道适配器

WebSockets 命名空间支持

<int-websocket:client-container>属性

<int-websocket:server-container>属性

<int-websocket:outbound-channel-adapter>属性

<int-websocket:inbound-channel-adapter>属性