内容丰富器

有时，您可能需要使用比目标系统提供的更多信息来增强请求。 数据丰富器 模式描述了各种场景以及允许您解决此类需求的组件（丰富器）。

Spring Integration Core 模块包含两个丰富器

它还包含三个适配器特定的头丰富器

有关这些适配器的更多信息，请参阅本参考手册的适配器特定部分。

有关表达式支持的更多信息，请参阅 Spring 表达式语言 (SpEL)。

头丰富器

如果您只需要向消息添加头，并且头不是由消息内容动态确定的，那么引用自定义的转换器实现可能太过复杂。出于这个原因，Spring Integration 提供了对头丰富器模式的支持。它通过 <header-enricher> 元素公开。以下示例展示了如何使用它

<int:header-enricher input-channel="in" output-channel="out">
    <int:header name="foo" value="123"/>
    <int:header name="bar" ref="someBean"/>
</int:header-enricher>

标头丰富器还提供有用的子元素来设置众所周知的标头名称，如下例所示

<int:header-enricher input-channel="in" output-channel="out">
    <int:error-channel ref="applicationErrorChannel"/>
    <int:reply-channel ref="quoteReplyChannel"/>
    <int:correlation-id value="123"/>
    <int:priority value="HIGHEST"/>
    <routing-slip value="channel1; routingSlipRoutingStrategy; request.headers[myRoutingSlipChannel]"/>
    <int:header name="bar" ref="someBean"/>
</int:header-enricher>

前面的配置表明，对于众所周知的标头（例如errorChannel、correlationId、priority、replyChannel、routing-slip等），您可以使用方便的子元素直接设置这些值，而不是使用通用的<header>子元素，在该元素中您需要同时提供标头“名称”和“值”。

从 4.1 版本开始，标头丰富器提供了一个routing-slip子元素。有关更多信息，请参阅路由单。

POJO 支持

通常，标头值无法静态定义，必须根据消息中的某些内容动态确定。这就是标头丰富器允许您使用ref和method属性指定 Bean 引用原因。指定的方法计算标头值。考虑以下配置和一个修改String的方法的 Bean

<int:header-enricher input-channel="in" output-channel="out">
    <int:header name="something" method="computeValue" ref="myBean"/>
</int:header-enricher>

<bean id="myBean" class="thing1.thing2.MyBean"/>
public class MyBean {

    public String computeValue(String payload){
        return payload.toUpperCase() + "_US";
    }
}

您也可以将 POJO 配置为内部 Bean，如下例所示

<int:header-enricher  input-channel="inputChannel" output-channel="outputChannel">
    <int:header name="some_header">
        <bean class="org.MyEnricher"/>
    </int:header>
</int:header-enricher>

您也可以类似地指向 Groovy 脚本，如下例所示

<int:header-enricher  input-channel="inputChannel" output-channel="outputChannel">
    <int:header name="some_header">
        <int-groovy:script location="org/SampleGroovyHeaderEnricher.groovy"/>
    </int:header>
</int:header-enricher>

SpEL 支持

在 Spring Integration 2.0 中，我们引入了Spring 表达式语言 (SpEL)的便利性，以帮助配置许多不同的组件。标头丰富器就是其中之一。再次查看前面显示的 POJO 示例。您可以看到确定标头值的计算逻辑非常简单。一个自然的问题是：“是否有更简单的方法来实现这一点？”。这就是 SpEL 展现其真正力量的地方。考虑以下示例

<int:header-enricher input-channel="in" output-channel="out">
    <int:header name="foo" expression="payload.toUpperCase() + '_US'"/>
</int:header-enricher>

通过在这些简单情况下使用 SpEL，您不再需要提供单独的类并在应用程序上下文中配置它。您所需要做的就是使用有效的 SpEL 表达式配置expression属性。'payload' 和 'headers' 变量绑定到 SpEL 评估上下文，让您可以完全访问传入消息。

使用 Java 配置配置标头丰富器

以下两个示例展示了如何使用 Java 配置来配置标头丰富器

@Bean
@Transformer(inputChannel = "enrichHeadersChannel", outputChannel = "emailChannel")
public HeaderEnricher enrichHeaders() {
    Map<String, ? extends HeaderValueMessageProcessor<?>> headersToAdd =
            Collections.singletonMap("emailUrl",
                      new StaticHeaderValueMessageProcessor<>(this.imapUrl));
    HeaderEnricher enricher = new HeaderEnricher(headersToAdd);
    return enricher;
}

@Bean
@Transformer(inputChannel="enrichHeadersChannel", outputChannel="emailChannel")
public HeaderEnricher enrichHeaders() {
    Map<String, HeaderValueMessageProcessor<?>> headersToAdd = new HashMap<>();
    headersToAdd.put("emailUrl", new StaticHeaderValueMessageProcessor<String>(this.imapUrl));
    Expression expression = new SpelExpressionParser().parseExpression("payload.from[0].toString()");
    headersToAdd.put("from",
               new ExpressionEvaluatingHeaderValueMessageProcessor<>(expression, String.class));
    HeaderEnricher enricher = new HeaderEnricher(headersToAdd);
    return enricher;
}

第一个示例添加了一个单一的文字标头。第二个示例添加了两个标头，一个文字标头和一个基于 SpEL 表达式的标头。

使用 Java DSL 配置标头丰富器

以下示例展示了标头丰富器的 Java DSL 配置

@Bean
public IntegrationFlow enrichHeadersInFlow() {
    return f -> f
                ...
                .enrichHeaders(h -> h.header("emailUrl", this.emailUrl)
                                     .headerExpression("from", "payload.from[0].toString()"))
                .handle(...);
}

标头通道注册表

从 Spring Integration 3.0 开始，提供了一个新的子元素<int:header-channels-to-string/>。它没有属性。这个新的子元素将现有的replyChannel和errorChannel标头（当它们是MessageChannel时）转换为String，并将通道存储在注册表中，以便在需要发送回复或处理错误时进行解析。这对于标头可能丢失的情况很有用，例如，当将消息序列化到消息存储中或通过 JMS 传输消息时。如果标头不存在，或者它不是MessageChannel，则不会进行任何更改。

使用此功能需要存在一个HeaderChannelRegistry bean。默认情况下，框架会创建一个DefaultHeaderChannelRegistry，其默认过期时间为 60 秒。通道会在该时间后从注册表中移除。要更改此行为，请定义一个id为integrationHeaderChannelRegistry的 bean，并使用构造函数参数（以毫秒为单位）配置所需的默认延迟。

从 4.1 版本开始，您可以在<bean/>定义中将名为removeOnGet的属性设置为true，映射条目将在首次使用时立即移除。这在高流量环境中以及通道仅使用一次时可能很有用，而不是等待清理器将其移除。

HeaderChannelRegistry有一个size()方法来确定注册表的当前大小。runReaper()方法会取消当前的计划任务并立即运行清理器。然后，该任务会根据当前延迟重新安排运行。这些方法可以通过获取对注册表的引用直接调用，或者您可以将一条消息（例如，包含以下内容）发送到控制总线

"@integrationHeaderChannelRegistry.runReaper()"

此子元素是一个便利元素，等效于指定以下配置

<int:reply-channel
    expression="@integrationHeaderChannelRegistry.channelToChannelName(headers.replyChannel)"
    overwrite="true" />
<int:error-channel
    expression="@integrationHeaderChannelRegistry.channelToChannelName(headers.errorChannel)"
    overwrite="true" />

从 4.1 版本开始，您现在可以覆盖注册表配置的清理器延迟，以便通道映射至少保留指定的时间，而不管清理器延迟如何。以下示例展示了如何执行此操作

<int:header-enricher input-channel="inputTtl" output-channel="next">
    <int:header-channels-to-string time-to-live-expression="120000" />
</int:header-enricher>

<int:header-enricher input-channel="inputCustomTtl" output-channel="next">
    <int:header-channels-to-string
        time-to-live-expression="headers['channelTTL'] ?: 120000" />
</int:header-enricher>

在第一种情况下，每个头通道映射的生存时间将为两分钟。在第二种情况下，生存时间在消息头中指定，并使用 Elvis 操作符，如果不存在头，则使用两分钟。

有效载荷增强器

在某些情况下，前面讨论的头增强器可能不足够，并且有效载荷本身可能需要使用其他信息进行增强。例如，进入 Spring Integration 消息系统的订单消息必须根据提供的客户编号查找订单的客户，然后使用该信息来增强原始有效载荷。

Spring Integration 2.1 引入了有效载荷增强器。有效载荷增强器定义了一个端点，该端点将Message传递到公开的请求通道，然后期望一个回复消息。然后，回复消息将成为用于评估表达式以增强目标有效载荷的根对象。

有效载荷增强器通过enricher元素提供完整的 XML 命名空间支持。为了发送请求消息，有效载荷增强器有一个request-channel属性，允许您将消息调度到请求通道。

基本上，通过定义请求通道，有效载荷增强器充当网关，等待发送到请求通道的消息返回。然后，增强器使用回复消息提供的数据来增强消息的有效载荷。

当向请求通道发送消息时，您还可以选择使用request-payload-expression属性仅发送原始有效负载的子集。

有效负载的丰富是通过 SpEL 表达式配置的，提供了最大的灵活性。因此，您不仅可以使用来自回复通道的Message的直接值来丰富有效负载，还可以使用 SpEL 表达式从该消息中提取子集或应用额外的内联转换，让您进一步操作数据。

如果您只需要使用静态值来丰富有效负载，则无需提供request-channel属性。

丰富器是转换器的变体。在许多情况下，您可以使用有效负载丰富器或通用转换器实现来向您的消息有效负载添加更多数据。您应该熟悉 Spring Integration 提供的所有支持转换的组件，并仔细选择语义上最适合您的业务案例的实现。

配置

以下示例显示了有效负载丰富器的所有可用配置选项

<int:enricher request-channel=""                           (1)
              auto-startup="true"                          (2)
              id=""                                        (3)
              order=""                                     (4)
              output-channel=""                            (5)
              request-payload-expression=""                (6)
              reply-channel=""                             (7)
              error-channel=""                             (8)
              send-timeout=""                              (9)
              should-clone-payload="false">                (10)
    <int:poller></int:poller>                              (11)
    <int:property name="" expression="" null-result-expression="'Could not determine the name'"/>   (12)
    <int:property name="" value="23" type="java.lang.Integer" null-result-expression="'0'"/>
    <int:header name="" expression="" null-result-expression=""/>   (13)
    <int:header name="" value="" overwrite="" type="" null-result-expression=""/>
</int:enricher>
1 将消息发送到的通道，以获取用于丰富的数据。可选。
2 生命周期属性，指示该组件是否应在应用程序上下文启动期间启动。默认为 true。可选。
3 底层 bean 定义的 ID，它是一个EventDrivenConsumer或一个PollingConsumer。可选。
4 指定当此端点作为订阅者连接到通道时调用的顺序。当该通道使用“故障转移”调度策略时，这尤其重要。当此端点本身是具有队列的通道的轮询消费者时，它没有影响。可选。
5 标识消息通道，在消息被此端点处理后将消息发送到该通道。可选。
6 默认情况下，原始消息的有效负载用作发送到request-channel的有效负载。通过将 SpEL 表达式指定为request-payload-expression属性的值，您可以使用原始有效负载的子集、标题值或任何其他可解析的 SpEL 表达式作为发送到请求通道的有效负载的基础。对于表达式求值，完整的消息可用作“根对象”。例如，以下 SpEL 表达式（除其他外）是可能的：payload.something、headers.something、new java.util.Date()、'thing1' + 'thing2'
7 预期回复消息的通道。这是可选的。通常，自动生成的临时回复通道就足够了。可选。
8 如果request-channel下游发生Exception，将ErrorMessage发送到的通道。这使您能够返回一个备用对象以用于丰富。如果未设置，则会向调用者抛出Exception。可选。
9 将消息发送到通道时等待的最大时间（以毫秒为单位），如果通道可能阻塞。例如，队列通道可以阻塞，直到有空间可用，如果其最大容量已达到。在内部，send()超时在MessagingTemplate上设置，并在调用MessageChannel上的发送操作时最终应用。默认情况下，send()超时设置为“30”。可选。
10 布尔值，指示是否应在将实现 Cloneable 的任何有效负载发送到请求通道以获取丰富数据之前对其进行克隆。克隆版本将用作最终回复的目标有效负载。默认值为 false。可选。
11 如果此端点是轮询使用者，则允许您配置消息轮询器。可选。
12 每个 property 子元素都提供属性的名称（通过必需的 name 属性）。该属性应该可以在目标有效负载实例上设置。还必须提供 value 或 expression 属性中的一个，前者用于设置文字值，后者用于评估 SpEL 表达式。评估上下文的根对象是此丰富器启动的流程返回的消息，如果没有请求通道，则为输入消息，或者为应用程序上下文（使用 @<beanName>.<beanProperty> SpEL 语法）。从版本 4.0 开始，在指定 value 属性时，还可以指定一个可选的 type 属性。当目标是类型化 setter 方法时，框架会适当地强制转换值（只要存在 PropertyEditor 来处理转换）。但是，如果目标有效负载是 Map，则条目将使用值填充，而不会进行转换。例如，type 属性允许您将包含数字的 String 转换为目标有效负载中的 Integer 值。从版本 4.1 开始，您还可以指定一个可选的 null-result-expression 属性。当 enricher 返回 null 时，它将被评估，并且评估的输出将被返回。
13 每个 header 子元素都提供消息头的名称（通过必需的 name 属性）。还必须提供 value 或 expression 属性中的一个，前者用于设置文字值，后者用于评估 SpEL 表达式。评估上下文的根对象是此丰富器启动的流程返回的消息，如果没有请求通道，则为输入消息，或者为应用程序上下文（使用 '@<beanName>.<beanProperty>' SpEL 语法）。请注意，与 <header-enricher> 类似，<enricher> 元素的 header 元素具有 type 和 overwrite 属性。但是，一个关键区别是，对于 <enricher>，overwrite 属性默认值为 true，以与 <enricher> 元素的 <property> 子元素保持一致。从版本 4.1 开始，您还可以指定一个可选的 null-result-expression 属性。当 enricher 返回 null 时，它将被评估，并且评估的输出将被返回。

示例

本节包含在各种情况下使用有效负载丰富器的几个示例。

此处显示的代码示例是 Spring Integration Samples 项目的一部分。请参阅 Spring Integration Samples。

在以下示例中，一个 User 对象作为 Message 的有效负载传递。

<int:enricher id="findUserEnricher"
              input-channel="findUserEnricherChannel"
              request-channel="findUserServiceChannel">
    <int:property name="email"    expression="payload.email"/>
    <int:property name="password" expression="payload.password"/>
</int:enricher>

User 具有多个属性，但最初只设置了 username。enrichers 的 request-channel 属性被配置为将 User 传递给 findUserServiceChannel。

通过隐式设置的 reply-channel，返回一个 User 对象，并使用 property 子元素，从回复中提取属性并用于丰富原始有效负载。

如何只将数据的子集传递给请求通道？

当使用 request-payload-expression 属性时，可以将有效负载的单个属性而不是完整消息传递给请求通道。在以下示例中，username 属性被传递给请求通道。

<int:enricher id="findUserByUsernameEnricher"
              input-channel="findUserByUsernameEnricherChannel"
              request-channel="findUserByUsernameServiceChannel"
              request-payload-expression="payload.username">
    <int:property name="email"    expression="payload.email"/>
    <int:property name="password" expression="payload.password"/>
</int:enricher>

请记住，虽然只传递了用户名，但发送到请求通道的结果消息包含完整的 MessageHeaders 集。

如何丰富包含集合数据的有效负载？

在以下示例中，传递的是一个 Map，而不是一个 User 对象。

<int:enricher id="findUserWithMapEnricher"
              input-channel="findUserWithMapEnricherChannel"
              request-channel="findUserByUsernameServiceChannel"
              request-payload-expression="payload.username">
    <int:property name="user" expression="payload"/>
</int:enricher>

Map 在 username 映射键下包含用户名。只有 username 被传递给请求通道。回复包含一个完整的 User 对象，该对象最终被添加到 Map 中的 user 键下。

如何在不使用请求通道的情况下用静态信息丰富有效负载？

以下示例根本不使用请求通道，而是仅仅用静态值丰富消息的有效负载。

<int:enricher id="userEnricher"
              input-channel="input">
    <int:property name="user.updateDate" expression="new java.util.Date()"/>
    <int:property name="user.firstName" value="William"/>
    <int:property name="user.lastName"  value="Shakespeare"/>
    <int:property name="user.age"       value="42"/>
</int:enricher>

请注意，此处“静态”一词的使用比较宽泛。您仍然可以使用 SpEL 表达式来设置这些值。