WebFlux 支持_Spring 集成参考指南

WebFlux 支持

WebFlux Spring 集成模块 ( spring-integration-webflux) 允许以反应方式执行 HTTP 请求和处理入站 HTTP 请求。

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

Maven

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-webflux</artifactId>
    <version>5.5.13</version>
</dependency>

Gradle

compile "org.springframework.integration:spring-integration-webflux:5.5.13"

在io.projectreactor.netty:reactor-netty非基于 Servlet 的服务器配置的情况下，必须包含依赖项。

WebFlux 支持包括以下网关实现：WebFluxInboundEndpoint和WebFluxRequestExecutingMessageHandler. 该支持完全基于 Spring WebFlux和Project Reactor基础。有关更多信息，请参阅HTTP 支持，因为许多选项在反应式和常规 HTTP 组件之间共享。

WebFlux 命名空间支持

Spring Integration 提供了webflux命名空间和相应的模式定义。要将其包含在您的配置中，请在应用程序上下文配置文件中添加以下命名空间声明：

<?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-webflux="http://www.springframework.org/schema/integration/webflux"
  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/webflux
    https://www.springframework.org/schema/integration/webflux/spring-integration-webflux.xsd">
    ...
</beans>

WebFlux 入站组件

从 5.0 版开始，提供了的WebFluxInboundEndpoint实现WebHandler。该组件类似于基于 MVC 的组件HttpRequestHandlingEndpointSupport，通过新提取的BaseHttpInboundEndpoint. 它用于 Spring WebFlux 反应式环境（而不是 MVC）。以下示例显示了 WebFlux 端点的简单实现：

Java DSL

@Bean
public IntegrationFlow inboundChannelAdapterFlow() {
    return IntegrationFlows
        .from(WebFlux.inboundChannelAdapter("/reactivePost")
            .requestMapping(m -> m.methods(HttpMethod.POST))
            .requestPayloadType(ResolvableType.forClassWithGenerics(Flux.class, String.class))
            .statusCodeFunction(m -> HttpStatus.ACCEPTED))
        .channel(c -> c.queue("storeChannel"))
        .get();
}

科特林 DSL

@Bean
fun inboundChannelAdapterFlow() =
    integrationFlow(
        WebFlux.inboundChannelAdapter("/reactivePost")
            .apply {
                requestMapping { m -> m.methods(HttpMethod.POST) }
                requestPayloadType(ResolvableType.forClassWithGenerics(Flux::class.java, String::class.java))
                statusCodeFunction { m -> HttpStatus.ACCEPTED }
            })
    {
        channel { queue("storeChannel") }
    }

java

@Configuration
@EnableWebFlux
@EnableIntegration
public class ReactiveHttpConfiguration {

    @Bean
    public WebFluxInboundEndpoint simpleInboundEndpoint() {
        WebFluxInboundEndpoint endpoint = new WebFluxInboundEndpoint();
        RequestMapping requestMapping = new RequestMapping();
        requestMapping.setPathPatterns("/test");
        endpoint.setRequestMapping(requestMapping);
        endpoint.setRequestChannelName("serviceChannel");
        return endpoint;
    }

    @ServiceActivator(inputChannel = "serviceChannel")
    String service() {
        return "It works!";
    }

}

XML

<int-webflux:inbound-gateway request-channel="requests" path="/sse">
    <int-webflux:request-mapping produces="text/event-stream"/>
</int-webflux:inbound-gateway>

配置类似于HttpRequestHandlingEndpointSupport（在示例之前提到），除了我们用于@EnableWebFlux将 WebFlux 基础架构添加到我们的集成应用程序中。此外，通过使用响应式 HTTP 服务器实现提供的基于按需的背压功能对下游流WebFluxInboundEndpoint执行操作。sendAndReceive

回复部分也是非阻塞的，并且基于内部FutureReplyChannel，它被平面映射到回复Mono以按需解决。

您可以WebFluxInboundEndpoint使用 custom ServerCodecConfigurer、 aRequestedContentTypeResolver甚至 a来配置ReactiveAdapterRegistry。后者提供了一种机制，您可以使用该机制将回复作为任何反应类型返回： Reactor Flux、 RxJava Observable、Flowable等。这样，我们就可以使用 Spring Integration 组件实现Server Sent Events场景，如以下示例所示：

Java DSL

@Bean
public IntegrationFlow sseFlow() {
    return IntegrationFlows
            .from(WebFlux.inboundGateway("/sse")
                    .requestMapping(m -> m.produces(MediaType.TEXT_EVENT_STREAM_VALUE)))
            .handle((p, h) -> Flux.just("foo", "bar", "baz"))
            .get();
}

科特林 DSL

@Bean
fun sseFlow() =
     integrationFlow(
            WebFlux.inboundGateway("/sse")
                       .requestMapping(m -> m.produces(MediaType.TEXT_EVENT_STREAM_VALUE)))
            {
                 handle { (p, h) -> Flux.just("foo", "bar", "baz") }
            }

java

@Bean
public WebFluxInboundEndpoint webfluxInboundGateway() {
    WebFluxInboundEndpoint endpoint = new WebFluxInboundEndpoint();
    RequestMapping requestMapping = new RequestMapping();
    requestMapping.setPathPatterns("/sse");
    requestMapping.setProduces(MediaType.TEXT_EVENT_STREAM_VALUE);
    endpoint.setRequestMapping(requestMapping);
    endpoint.setRequestChannelName("requests");
    return endpoint;
}

XML

<int-webflux:inbound-channel-adapter id="reactiveFullConfig" channel="requests"
                               path="test1"
                               auto-startup="false"
                               phase="101"
                               request-payload-type="byte[]"
                               error-channel="errorChannel"
                               payload-expression="payload"
                               supported-methods="PUT"
                               status-code-expression="'202'"
                               header-mapper="headerMapper"
                               codec-configurer="codecConfigurer"
                               reactive-adapter-registry="reactiveAdapterRegistry"
                               requested-content-type-resolver="requestedContentTypeResolver">
            <int-webflux:request-mapping headers="foo"/>
            <int-webflux:cross-origin origin="foo" method="PUT"/>
            <int-webflux:header name="foo" expression="'foo'"/>
</int-webflux:inbound-channel-adapter>

有关更多可能的配置选项，请参阅请求映射支持和跨域资源共享 (CORS) 支持。

当请求体为空或payloadExpression返回null时，请求参数( MultiValueMap<String, String>)用于payload处理目标消息的一个。

有效载荷验证

从 5.2 版开始，WebFluxInboundEndpoint可以使用Validator. 与HTTP Support中的 MVC 验证不同，它用于在执行回退和函数之前验证Publisher请求已被转换为的元素。框架无法假设构建最终有效负载后对象的复杂程度。如果需要限制对最终有效负载（或其元素）的验证可见性，则验证应该向下游而不是 WebFlux 端点进行。在 Spring WebFlux文档中查看更多信息。包含所有验证的（扩展名）拒绝了无效的有效负载HttpMessageReaderpayloadExpressionPublisherPublisherIntegrationWebExchangeBindExceptionWebExchangeBindExceptionErrors. 在 Spring Framework参考手册中查看有关验证的更多信息。

WebFlux 出站组件

（WebFluxRequestExecutingMessageHandler从 5.0 版开始）实现类似于HttpRequestExecutingMessageHandler. 它使用WebClient来自 Spring Framework 的 WebFlux 模块。要对其进行配置，请定义一个类似于以下内容的 bean：

Java DSL

@Bean
public IntegrationFlow outboundReactive() {
    return f -> f
        .handle(WebFlux.<MultiValueMap<String, String>>outboundGateway(m ->
                UriComponentsBuilder.fromUriString("http://localhost:8080/foo")
                        .queryParams(m.getPayload())
                        .build()
                        .toUri())
                .httpMethod(HttpMethod.GET)
                .expectedResponseType(String.class));
}

科特林 DSL

@Bean
fun outboundReactive() =
    integrationFlow {
        handle(
            WebFlux.outboundGateway<MultiValueMap<String, String>>({ m ->
                UriComponentsBuilder.fromUriString("http://localhost:8080/foo")
                    .queryParams(m.getPayload())
                    .build()
                    .toUri()
            })
                .httpMethod(HttpMethod.GET)
                .expectedResponseType(String::class.java)
        )
    }

java

@ServiceActivator(inputChannel = "reactiveHttpOutRequest")
@Bean
public WebFluxRequestExecutingMessageHandler reactiveOutbound(WebClient client) {
    WebFluxRequestExecutingMessageHandler handler =
        new WebFluxRequestExecutingMessageHandler("http://localhost:8080/foo", client);
    handler.setHttpMethod(HttpMethod.POST);
    handler.setExpectedResponseType(String.class);
    return handler;
}

XML

<int-webflux:outbound-gateway id="reactiveExample1"
    request-channel="requests"
    url="http://localhost/test"
    http-method-expression="headers.httpMethod"
    extract-request-payload="false"
    expected-response-type-expression="payload"
    charset="UTF-8"
    reply-timeout="1234"
    reply-channel="replies"/>

<int-webflux:outbound-channel-adapter id="reactiveExample2"
    url="http://localhost/example"
    http-method="GET"
    channel="requests"
    charset="UTF-8"
    extract-payload="false"
    expected-response-type="java.lang.String"
    order="3"
    auto-startup="false"/>

该WebClient exchange()操作返回 a Mono<ClientResponse>，它被映射（通过使用几个Mono.map()步骤）到 aAbstractIntegrationMessageBuilder作为的输出WebFluxRequestExecutingMessageHandler。与ReactiveChannelas一起outputChannel，Mono<ClientResponse>评估被推迟到进行下游订阅。否则，它被视为一种async模式，并且Mono响应适应于SettableListenableFuture来自的异步回复WebFluxRequestExecutingMessageHandler。输出消息的目标负载取决于WebFluxRequestExecutingMessageHandler配置。setExpectedResponseType(Class<?>)或标识响应正文元素转换的setExpectedResponseTypeExpression(Expression)目标类型。如果replyPayloadToFlux设置为true，则响应正文将转换为为每个元素Flux提供的 a，并且此expectedResponseTypeFlux作为有效载荷向下游发送。之后，您可以使用拆分器以反应方式对其进行迭代Flux。

此外，BodyExtractor<?, ClientHttpResponse>可以将 a 注入到WebFluxRequestExecutingMessageHandler而不是expectedResponseTypeandreplyPayloadToFlux属性中。它可用于对正文和 HTTP 标头转换的低级访问ClientHttpResponse和更多控制。Spring Integration 提供ClientHttpResponseBodyExtractor了一个标识函数来生成（下游）整体ClientHttpResponse和任何其他可能的自定义逻辑。

从 5.2 版开始，WebFluxRequestExecutingMessageHandler支持响应式Publisher、、Resource和MultiValueMap类型作为请求消息有效负载。A 各自BodyInserter用于在内部填充到WebClient.RequestBodySpec. 当有效负载是响应式Publisher时，配置publisherElementType或publisherElementTypeExpression可用于确定发布者元素类型的类型。表达式必须解析为 a Class<?>，String后者解析为目标Class<?>or ParameterizedTypeReference。

从版本 5.5 开始，WebFluxRequestExecutingMessageHandler公开一个extractResponseBody标志（true默认情况下）以仅返回响应正文，或将整个ResponseEntity作为回复消息有效负载返回，与提供的expectedResponseTypeor无关replyPayloadToFlux。如果 body 中不存在，ResponseEntity则忽略此标志并ResponseEntity返回整体。

有关更多可能的配置选项，请参阅HTTP 出站组件。

WebFlux 标头映射

由于 WebFlux 组件完全基于 HTTP 协议，因此 HTTP 标头映射没有区别。有关用于映射标头的更多可能选项和组件，请参阅HTTP 标头映射。