HTTP 命名空间支持

Spring Integration 提供了一个 http 命名空间和相应的模式定义。要在您的配置中包含它，请在您的应用程序上下文配置文件中提供以下命名空间声明

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

入站

XML 命名空间提供了两个组件来处理 HTTP 入站请求：inbound-channel-adapter 和 inbound-gateway。为了处理不返回专用响应的请求，请使用 inbound-channel-adapter。以下示例展示了如何配置一个

<int-http:inbound-channel-adapter id="httpChannelAdapter" channel="requests"
    supported-methods="PUT, DELETE"/>

要处理预期响应的请求，请使用 inbound-gateway。以下示例展示了如何配置一个

<int-http:inbound-gateway id="inboundGateway"
    request-channel="requests"
    reply-channel="responses"/>

请求映射支持

Spring Integration 3.0 通过引入 IntegrationRequestMappingHandlerMapping 改进了 REST 支持。该实现依赖于 Spring Framework 3.1 或更高版本提供的增强 REST 支持。

解析 HTTP 入站网关或 HTTP 入站通道适配器会注册一个类型为 IntegrationRequestMappingHandlerMapping 的 integrationRequestMappingHandlerMapping bean，如果尚未注册一个。这种特定实现的 HandlerMapping 将其逻辑委托给 RequestMappingInfoHandlerMapping。该实现提供了类似于 Spring MVC 中 org.springframework.web.bind.annotation.RequestMapping 注释的功能。

有关更多信息，请参阅使用 @RequestMapping 映射请求。

为此，Spring Integration 3.0 引入了 <request-mapping> 元素。您可以将此可选元素添加到 <http:inbound-channel-adapter> 和 <http:inbound-gateway>。它与 path 和 supported-methods 属性一起使用。以下示例展示了如何在入站网关上配置它

<inbound-gateway id="inboundController"
    request-channel="requests"
    reply-channel="responses"
    path="/foo/{fooId}"
    supported-methods="GET"
    view-name="foo"
    error-code="oops">
   <request-mapping headers="User-Agent"
     params="myParam=myValue"
     consumes="application/json"
     produces="!text/plain"/>
</inbound-gateway>

基于前面的配置，命名空间解析器会创建一个 IntegrationRequestMappingHandlerMapping 实例（如果不存在）和一个 HttpRequestHandlingController bean，并将一个 RequestMapping 实例与之关联。这个 RequestMapping 实例会转换为 Spring MVC 的 RequestMappingInfo。

<request-mapping> 元素提供以下属性：

headers
params
consumes
produces

结合 <http:inbound-channel-adapter> 或 <http:inbound-gateway> 的 path 和 supported-methods 属性，<request-mapping> 属性会直接转换为 Spring MVC 中 org.springframework.web.bind.annotation.RequestMapping 注解提供的相应选项。

<request-mapping> 元素允许您将多个 Spring Integration HTTP 入站端点配置到同一个 path（甚至同一个 supported-methods），并允许您根据传入的 HTTP 请求提供不同的下游消息流。

或者，您也可以只声明一个 HTTP 入站端点，并在 Spring Integration 流中应用路由和过滤逻辑来实现相同的结果。这使您能够尽早地将 Message 传入流中。以下示例展示了如何做到这一点：

<int-http:inbound-gateway request-channel="httpMethodRouter"
    supported-methods="GET,DELETE"
    path="/process/{entId}"
    payload-expression="#pathVariables.entId"/>

<int:router input-channel="httpMethodRouter" expression="headers.http_requestMethod">
    <int:mapping value="GET" channel="in1"/>
    <int:mapping value="DELETE" channel="in2"/>
</int:router>

<int:service-activator input-channel="in1" ref="service" method="getEntity"/>

<int:service-activator input-channel="in2" ref="service" method="delete"/>

有关处理程序映射的更多信息，请参阅 Spring 框架 Web Servlet 文档 或 Spring 框架 Web Reactive 文档。

IntegrationRequestMappingHandlerMapping 扩展了 Spring MVC 的 RequestMappingHandlerMapping 类，继承了其大部分逻辑，尤其是 handleNoMatch(Set, String, HttpServletRequest)，该方法在映射由于某种原因不匹配时，会为 HTTP 响应抛出一个特定的 4xx 错误，从而阻止对应用程序上下文中的任何剩余映射处理程序的调用。因此，不支持为 Spring Integration 和 Spring MVC 请求映射配置相同的路径（例如，一个为 POST，另一个为 GET）；MVC 映射将无法找到。

跨域资源共享 (CORS) 支持

从 4.2 版本开始，您可以使用 <cross-origin> 元素配置 <http:inbound-channel-adapter> 和 <http:inbound-gateway>。它表示与 Spring MVC 的 @Controller 注解的 @CrossOrigin 相同的选项，并允许为 Spring Integration HTTP 端点配置跨域资源共享 (CORS)。

origin：允许的来源列表。* 表示允许所有来源。这些值将放置在预检和实际响应的 Access-Control-Allow-Origin 标头中。默认值为 *。
allowed-headers: 指示在实际请求期间可以使用哪些请求头。* 表示允许客户端请求的所有头。此属性控制预检响应的 Access-Control-Allow-Headers 头的值。默认值为 *。
exposed-headers: 用户代理允许客户端访问的响应头列表。此属性控制实际响应的 Access-Control-Expose-Headers 头的值。
method: 允许的 HTTP 请求方法：GET、POST、HEAD、OPTIONS、PUT、PATCH、DELETE、TRACE。此处指定的方法会覆盖 supported-methods 中的方法。
allow-credentials: 如果浏览器应该包含与请求域关联的任何 cookie，则设置为 true；如果浏览器不应该包含，则设置为 false。空字符串 ("") 表示未定义。如果为 true，则预检响应将包含 Access-Control-Allow-Credentials=true 头。默认值为 true。
max-age: 控制预检响应的缓存持续时间。将其设置为合理的值可以减少浏览器所需的预检请求-响应交互次数。此属性控制预检响应中 Access-Control-Max-Age 头的值。值为 -1 表示未定义。默认值为 1800 秒（30 分钟）。

CORS Java 配置由 org.springframework.integration.http.inbound.CrossOrigin 类表示，该类的实例可以注入到 HttpRequestHandlingEndpointSupport bean 中。

响应状态码

从版本 4.1 开始，您可以使用 status-code-expression 配置 <http:inbound-channel-adapter> 以覆盖默认的 200 OK 状态。表达式必须返回可以转换为 org.springframework.http.HttpStatus 枚举值的对象。evaluationContext 具有 BeanResolver，从版本 5.1 开始，它将 RequestEntity<?> 作为根对象提供。一个示例可能是，在运行时解析一些作用域 bean，该 bean 返回状态码值。但是，最有可能的是，它被设置为固定值，例如 status-code=expression="204"（无内容），或 status-code-expression="T(org.springframework.http.HttpStatus).NO_CONTENT"。默认情况下，status-code-expression 为 null，这意味着返回正常的“200 OK”响应状态。使用 RequestEntity<?> 作为根对象，状态码可以根据条件设置，例如根据请求方法、某些头、URI 内容甚至请求正文。以下示例显示如何将状态码设置为 ACCEPTED

<http:inbound-channel-adapter id="inboundController"
       channel="requests" view-name="foo" error-code="oops"
       status-code-expression="T(org.springframework.http.HttpStatus).ACCEPTED">
   <request-mapping headers="BAR"/>
</http:inbound-channel-adapter>

<http:inbound-gateway> 从回复 Message 的 http_statusCode 头解析“状态码”。从版本 4.2 开始，当在 reply-timeout 内未收到回复时，默认响应状态码为 500 Internal Server Error。有两种方法可以修改此行为

添加一个reply-timeout-status-code-expression。它的语义与入站适配器上的status-code-expression相同。

添加一个error-channel，并返回带有 HTTP 状态码头的适当消息，如下例所示

<int:chain input-channel="errors">
    <int:header-enricher>
        <int:header name="http_statusCode" value="504" />
    </int:header-enricher>
    <int:transformer expression="payload.failedMessage" />
</int:chain>

ErrorMessage 的有效负载是一个 MessageTimeoutException。它必须转换为网关可以转换的内容，例如 String。一个好的选择是异常的消息属性，这是使用expression技术时使用的值。

如果错误流在主流超时后超时，则返回500 Internal Server Error，或者，如果存在reply-timeout-status-code-expression，则对其进行评估。

以前，超时的默认状态码是200 OK。要恢复该行为，请设置reply-timeout-status-code-expression="200"。

同样从 5.4 版本开始，在准备请求消息时遇到的错误将发送到错误通道（如果提供）。应通过检查异常在错误流中做出有关抛出适当异常的决定。以前，任何异常都会被简单地抛出，导致 HTTP 500 服务器错误响应状态，但在某些情况下，问题可能是由不正确的请求参数引起的，因此应改为抛出带有 4xx 客户端错误状态的ResponseStatusException。有关更多信息，请参阅ResponseStatusException。发送到此错误通道的ErrorMessage包含原始异常作为有效负载以供分析。

URI 模板变量和表达式

通过将path属性与payload-expression属性和header元素结合使用，您可以获得高度的灵活性来映射入站请求数据。

在以下示例配置中，入站通道适配器配置为使用以下 URI 接受请求

/first-name/{firstName}/last-name/{lastName}

当您使用 `payload-expression` 属性时，`{firstName}` URI 模板变量映射到 `Message` 的有效负载，而 `{lastName}` URI 模板变量映射到 `lname` 消息头，如下例所示

<int-http:inbound-channel-adapter id="inboundAdapterWithExpressions"
    path="/first-name/{firstName}/last-name/{lastName}"
    channel="requests"
    payload-expression="#pathVariables.firstName">
    <int-http:header name="lname" expression="#pathVariables.lastName"/>
</int-http:inbound-channel-adapter>

有关 URI 模板变量的更多信息，请参阅 Spring 参考手册中的 uri 模板模式。

从 Spring Integration 3.0 开始，除了现有的 `#pathVariables` 和 `#requestParams` 变量可以在有效负载和头表达式中使用之外，我们还添加了其他有用的表达式变量

#requestParams：来自 `ServletRequest` `parameterMap` 的 `MultiValueMap`。
#pathVariables：来自 URI 模板占位符及其值的 `Map`。
#matrixVariables：根据 Spring MVC 规范的 `MultiValueMap` 的 `Map`。请注意，`#matrixVariables` 需要 Spring MVC 3.2 或更高版本。
#requestAttributes：与当前请求关联的 `org.springframework.web.context.request.RequestAttributes`。
#requestHeaders：来自当前请求的 `org.springframework.http.HttpHeaders` 对象。
#cookies：来自当前请求的 `jakarta.servlet.http.Cookie` 实例的 `MultiValueMap<String, Cookie>`。

请注意，如果该消息流是单线程的并且位于请求线程内，则所有这些值（以及其他值）都可以通过 `ThreadLocal` `org.springframework.web.context.request.RequestAttributes` 变量在向下游消息流中的表达式中访问。以下示例配置了一个使用 `expression` 属性的转换器

<int-:transformer
    expression="T(org.springframework.web.context.request.RequestContextHolder).
                  requestAttributes.request.queryString"/>

出站

要配置出站网关，您可以使用命名空间支持。以下代码片段显示了出站 HTTP 网关的可用配置选项

<int-http:outbound-gateway id="example"
    request-channel="requests"
    url="https://127.0.0.1/test"
    http-method="POST"
    extract-request-payload="false"
    expected-response-type="java.lang.String"
    charset="UTF-8"
    request-factory="requestFactory"
    reply-timeout="1234"
    reply-channel="replies"/>

最重要的是，请注意提供了 'http-method' 和 'expected-response-type' 属性。这是两个最常配置的值。默认的 `http-method` 是 `POST`，默认的响应类型为 null。对于 null 响应类型，回复 `Message` 的有效负载包含 `ResponseEntity`，只要其 HTTP 状态为成功（非成功状态代码会抛出异常）。如果您期望不同的类型，例如 `String`，请将其作为完全限定的类名提供（在前面的示例中为 `java.lang.String`）。另请参阅有关 HTTP 出站组件中的空响应主体的说明。

从 Spring Integration 2.1 开始，HTTP 出站网关的 `request-timeout` 属性已重命名为 `reply-timeout`，以更好地反映其意图。

从 Spring Integration 2.2 开始，默认情况下不再启用 HTTP 上的 Java 序列化。以前，当将 expected-response-type 属性设置为 Serializable 对象时，Accept 标头没有正确设置。从 Spring Integration 2.2 开始，SerializingHttpMessageConverter 现在已更新为将 Accept 标头设置为 application/x-java-serialized-object。

但是，由于这可能会导致与现有应用程序不兼容，因此决定不再自动将此转换器添加到 HTTP 端点。如果您希望使用 Java 序列化，可以通过使用 message-converters 属性（当您使用 XML 配置时）或使用 setMessageConverters() 方法（在 Java 配置中）将 SerializingHttpMessageConverter 添加到相应的端点。或者，您可能希望考虑使用 JSON，它通过在类路径上拥有 Jackson 库来启用。

从 Spring Integration 2.2 开始，您还可以使用 SpEL 和 http-method-expression 属性动态确定 HTTP 方法。请注意，此属性与 http-method 互斥。您还可以使用 expected-response-type-expression 属性而不是 expected-response-type，并提供任何有效的 SpEL 表达式来确定响应的类型。以下配置示例使用 expected-response-type-expression

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

如果您的出站适配器要以单向方式使用，您可以使用 outbound-channel-adapter。这意味着成功的响应将在不向回复通道发送任何消息的情况下执行。在任何非成功响应状态代码的情况下，它将抛出异常。配置看起来与网关非常相似，如下例所示

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

要指定 URL，您可以使用 'url' 属性或 'url-expression' 属性。'url' 属性接受一个简单的字符串（带有 URI 变量的占位符，如下所述）。'url-expression' 是一个 SpEL 表达式，以 Message 作为根对象，它使动态 URL 成为可能。表达式求值结果的 URL 仍然可以包含 URI 变量的占位符。

在以前的版本中，一些用户使用占位符将整个 URL 替换为 URI 变量。Spring 3.1 中的更改可能会导致一些问题，例如转义字符，例如 '?'。出于这个原因，我们建议，如果您希望在运行时完全生成 URL，请使用 'url-expression' 属性。

映射 URI 变量

如果您的 URL 包含 URI 变量，您可以使用 `uri-variable` 元素对其进行映射。此元素适用于 HTTP 出站网关和 HTTP 出站通道适配器。以下示例将 `zipCode` URI 变量映射到表达式

<int-http:outbound-gateway id="trafficGateway"
    url="https://local.yahooapis.com/trafficData?appid=YdnDemo&amp;zip={zipCode}"
    request-channel="trafficChannel"
    http-method="GET"
    expected-response-type="java.lang.String">
    <int-http:uri-variable name="zipCode" expression="payload.getZip()"/>
</int-http:outbound-gateway>

`uri-variable` 元素定义了两个属性：`name` 和 `expression`。`name` 属性标识 URI 变量的名称，而 `expression` 属性用于设置实际值。通过使用 `expression` 属性，您可以充分利用 Spring 表达式语言 (SpEL) 的强大功能，它使您可以完全动态地访问消息有效负载和消息头。例如，在前面的配置中，`getZip()` 方法在 `Message` 的有效负载对象上调用，该方法的结果用作名为 'zipCode' 的 URI 变量的值。

从 Spring Integration 3.0 开始，HTTP 出站端点支持 `uri-variables-expression` 属性来指定应评估的 `expression`，从而生成 URL 模板中所有 URI 变量占位符的 `Map`。它提供了一种机制，您可以根据出站消息使用不同的变量表达式。此属性与 `<uri-variable/>` 元素互斥。以下示例展示了如何使用 `uri-variables-expression` 属性

<int-http:outbound-gateway
     url="https://foo.host/{foo}/bars/{bar}"
     request-channel="trafficChannel"
     http-method="GET"
     uri-variables-expression="@uriVariablesBean.populate(payload)"
     expected-response-type="java.lang.String"/>

`uriVariablesBean` 的定义如下

public class UriVariablesBean {
    private static final ExpressionParser EXPRESSION_PARSER = new SpelExpressionParser();

    public Map<String, ?> populate(Object payload) {
        Map<String, Object> variables = new HashMap<String, Object>();
        if (payload instanceOf String.class)) {
            variables.put("foo", "foo"));
        }
        else {
            variables.put("foo", EXPRESSION_PARSER.parseExpression("headers.bar"));
        }
        return variables;
    }

}

`uri-variables-expression` 必须评估为 `Map`。`Map` 的值必须是 `String` 或 `Expression` 的实例。此 `Map` 提供给 `ExpressionEvalMap`，以便通过在出站 `Message` 的上下文中使用这些表达式来进一步解析 URI 变量占位符。

重要 `uriVariablesExpression` 属性提供了一种非常强大的机制来评估 URI 变量。我们预计人们主要使用简单的表达式，例如前面的示例。但是，您也可以配置类似 `"@uriVariablesBean.populate(#root)"` 的内容，其中返回的映射中的表达式为 `variables.put("thing1", EXPRESSION_PARSER.parseExpression(message.getHeaders().get("thing2", String.class)));`，其中表达式在名为 `thing2` 的消息头中动态提供。由于标头可能来自不受信任的来源，因此 HTTP 出站端点在评估这些表达式时使用 `SimpleEvaluationContext`。`SimpleEvaluationContext` 仅使用 SpEL 功能的子集。如果您信任您的消息源并希望使用受限的 SpEL 结构，请将出站端点的 `trustedSpel` 属性设置为 `true`。

您可以通过使用自定义 `url-expression` 和一些用于构建和编码 URL 参数的实用程序来实现需要在每个消息的基础上提供动态 URI 变量集的场景。以下示例展示了如何做到这一点

url-expression="T(org.springframework.web.util.UriComponentsBuilder)
                           .fromHttpUrl('https://HOST:PORT/PATH')
                           .queryParams(payload)
                           .build()
                           .toUri()"

`queryParams()` 方法期望 `MultiValueMap<String, String>` 作为参数，因此您可以在执行请求之前预先构建一组真实的 URL 查询参数。

整个 `queryString` 也可以作为 `uri-variable` 展示，如下例所示

<int-http:outbound-gateway id="proxyGateway" request-channel="testChannel"
              url="http://testServer/test?{queryString}">
    <int-http:uri-variable name="queryString" expression="'a=A&amp;b=B'"/>
</int-http:outbound-gateway>

在这种情况下，您必须手动提供 URL 编码。例如，您可以使用 org.apache.http.client.utils.URLEncodedUtils#format() 来实现此目的。如前所述，可以使用以下 Java 流片段将手动构建的 MultiValueMap<String, String> 转换为 List<NameValuePair> format() 方法参数

List<NameValuePair> nameValuePairs =
    params.entrySet()
            .stream()
            .flatMap(e -> e
                    .getValue()
                    .stream()
                    .map(v -> new BasicNameValuePair(e.getKey(), v)))
            .collect(Collectors.toList());

控制 URI 编码

默认情况下，URL 字符串在发送请求之前被编码（参见 UriComponentsBuilder）到 URI 对象。在某些非标准 URI（例如 RabbitMQ REST API）的场景中，不希望执行编码。<http:outbound-gateway/> 和 <http:outbound-channel-adapter/> 提供了一个 encoding-mode 属性。要禁用 URL 编码，请将此属性设置为 NONE（默认情况下为 TEMPLATE_AND_VALUES）。如果您希望部分编码 URL 的某些部分，请在 <uri-variable/> 中使用 expression，如下面的示例所示

<http:outbound-gateway url="https://somehost/%2f/fooApps?bar={param}" encoding-mode="NONE">
          <http:uri-variable name="param"
            expression="T(org.apache.commons.httpclient.util.URIUtil)
                                             .encodeWithinQuery('Hello World!')"/>
</http:outbound-gateway>

使用 Java DSL，可以通过 BaseHttpMessageHandlerSpec.encodingMode() 选项控制此选项。相同的配置适用于 WebFlux 模块和 Web Services 模块中类似的出站组件。对于更复杂的场景，建议在外部提供的 RestTemplate 上配置 UriTemplateHandler；或者在 WebFlux 的情况下，使用 WebClient 及其 UriBuilderFactory。