此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Integration 6.5.1！spring-doc.cadn.net.cn

HTTP 命名空间支持

Spring Integration 提供了一个http命名空间和相应的架构定义。要将其包含在配置中，请在应用程序上下文配置文件中提供以下命名空间声明：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-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. 以下示例演示如何配置一个：spring-doc.cadn.net.cn

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

要处理需要响应的请求，请使用inbound-gateway. 以下示例演示如何配置一个：spring-doc.cadn.net.cn

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

请求映射支持

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

HTTP 入站网关或 HTTP 入站通道适配器的解析会注册一个integrationRequestMappingHandlerMapping类型IntegrationRequestMappingHandlerMapping，以防尚未注册。这种特殊的实现HandlerMapping将其逻辑委托给RequestMappingInfoHandlerMapping. 该实现提供的功能类似于org.springframework.web.bind.annotation.RequestMappingSpring MVC 中的注释。spring-doc.cadn.net.cn

有关更多信息，请参阅映射请求@RequestMapping.

为此，Spring Integration 3.0 引入了<request-mapping>元素。您可以将此可选元素添加到<http:inbound-channel-adapter>和<http:inbound-gateway>. 它与path和supported-methods属性。以下示例演示如何在入站网关上配置它：spring-doc.cadn.net.cn

<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（如果不存在）和HttpRequestHandlingControllerbean 并与其关联一个实例RequestMapping. 这RequestMappinginstance 反过来转换为 Spring MVCRequestMappingInfo.spring-doc.cadn.net.cn

这<request-mapping>元素提供以下属性：spring-doc.cadn.net.cn

使用path和supported-methods属性<http:inbound-channel-adapter>或<http:inbound-gateway>,<request-mapping>属性直接转换为org.springframework.web.bind.annotation.RequestMappingSpring MVC 中的注释。spring-doc.cadn.net.cn

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

或者，您也可以仅声明一个HTTP入站端点，并在Spring Integration流中应用路由和过滤逻辑以实现相同的结果。这可以让您获得Message尽早进入流程。以下示例显示了如何执行此作：spring-doc.cadn.net.cn

<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 Framework Web Servlet 文档或 Spring Framework Web Reactive 文档。spring-doc.cadn.net.cn

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

跨域资源共享（CORS）支持

从 4.2 版开始，您可以配置<http:inbound-channel-adapter>和<http:inbound-gateway>使用<cross-origin>元素。它表示与 Spring MVC 的@CrossOrigin为@Controller注释，并允许为 Spring Integration HTTP 端点配置跨域资源共享（CORS）：spring-doc.cadn.net.cn

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

CORS Java 配置由org.springframework.integration.http.inbound.CrossOrigin类，其实例可以注入到HttpRequestHandlingEndpointSupport豆。spring-doc.cadn.net.cn

响应状态代码

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

<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>从http_statusCode回复的标题Message. 从 4.2 版开始，当reply-timeout是500 Internal Server Error. 有两种方法可以修改此行为：spring-doc.cadn.net.cn

添加一个reply-timeout-status-code-expression. 这与status-code-expression在入站适配器上。spring-doc.cadn.net.cn

添加一个error-channel并返回带有 HTTP 状态代码标头的相应消息，如以下示例所示：spring-doc.cadn.net.cn

<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. 一个好的候选项是异常的 message 属性，这是使用expression技术。spring-doc.cadn.net.cn

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

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

此外，从 V5.4 开始，在准备请求消息时遇到的错误将发送到错误通道（如果提供）。应通过检查异常在错误流中做出有关引发适当异常的决定。以前，任何异常都只是抛出，导致 HTTP 500 服务器错误响应状态，但在某些情况下，问题可能是由不正确的请求参数引起的，因此ResponseStatusException应引发 4xx 客户端错误状态。看ResponseStatusException了解更多信息。这ErrorMessage发送到此错误通道的包含原始异常作为分析的有效负载。spring-doc.cadn.net.cn

URI 模板变量和表达式

通过使用path属性与payload-expression属性和header元素，则具有高度的灵活性来映射入站请求数据。spring-doc.cadn.net.cn

在以下示例配置中，入站通道适配器配置为使用以下 URI 接受请求：spring-doc.cadn.net.cn

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

当您使用payload-expression属性，则{firstName}URI 模板变量映射为Message有效负载，而{lastName}URI 模板变量映射到lnamemessage 标头，如以下示例中定义：spring-doc.cadn.net.cn

<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-doc.cadn.net.cn

自 Spring Integration 3.0 以来，除了现有的#pathVariables和#requestParams变量在有效负载和标头表达式中可用，我们添加了其他有用的表达式变量：spring-doc.cadn.net.cn

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

请注意，所有这些值（和其他值）都可以通过ThreadLocal org.springframework.web.context.request.RequestAttributes变量，如果该消息流是单线程的并且位于请求线程中。以下示例配置一个使用expression属性：spring-doc.cadn.net.cn

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

出境

若要配置出站网关，可以使用命名空间支持。以下代码片段显示了出站 HTTP 网关的可用配置选项：spring-doc.cadn.net.cn

<int-http:outbound-gateway id="example"
    request-channel="requests"
    url="http://localhost/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-doc.cadn.net.cn

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

从 Spring Integration 2.2 开始，默认情况下不再启用基于 HTTP 的 Java 序列化。以前，在设置expected-response-type属性设置为Serializable对象，则Accept标头设置不正确。从 Spring Integration 2.2 开始，SerializingHttpMessageConverter现已更新，以将Acceptheader 到application/x-java-serialized-object.spring-doc.cadn.net.cn

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

从 Spring Integration 2.2 开始，您还可以使用 SpEL 和http-method-expression属性。请注意，此属性与http-method. 您还可以使用expected-response-type-expression属性而不是expected-response-type并提供确定响应类型的任何有效 SpEL 表达式。以下配置示例使用expected-response-type-expression:spring-doc.cadn.net.cn

<int-http:outbound-gateway id="example"
    request-channel="requests"
    url="http://localhost/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相反。这意味着成功的响应执行时不会向回复通道发送任何消息。如果出现任何不成功的响应状态代码，它会引发异常。该配置看起来与网关非常相似，如以下示例所示：spring-doc.cadn.net.cn

<int-http:outbound-channel-adapter id="example"
    url="http://localhost/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 变量的占位符。spring-doc.cadn.net.cn

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

映射 URI 变量

如果您的 URL 包含 URI 变量，您可以使用uri-variable元素。此元素可用于 HTTP 出站网关和 HTTP 出站通道适配器。以下示例映射了zipCodeURI 变量添加到表达式中：spring-doc.cadn.net.cn

<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-doc.cadn.net.cn

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

<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可以定义如下：spring-doc.cadn.net.cn

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通过在出站上下文中使用这些表达式来进一步解析 URI 变量占位符Message.

重要这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.spring-doc.cadn.net.cn

可以使用自定义url-expression以及一些用于构建和编码 URL 参数的实用程序。以下示例显示了如何执行此作：spring-doc.cadn.net.cn

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

这queryParams()方法需要一个MultiValueMap<String, String>作为参数，因此您可以在执行请求之前提前构建一组真实的 URL 查询参数。spring-doc.cadn.net.cn

整体queryString也可以作为uri-variable，如以下示例所示：spring-doc.cadn.net.cn

<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()为此目的。如前所述，手动构建的MultiValueMap<String, String>可以转换为List<NameValuePair> format()method 参数，使用以下 Java Streams 代码段：spring-doc.cadn.net.cn

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 的某些部分进行部分编码，请使用expression在<uri-variable/>，如以下示例所示：spring-doc.cadn.net.cn

<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 服务模块中的类似出站组件。对于非常复杂的方案，建议配置UriTemplateHandler在外部提供的RestTemplate;或者如果是 WebFlux -WebClient有了它UriBuilderFactory.spring-doc.cadn.net.cn