转换器

消息转换器在实现消息生产者和消息消费者的松散耦合方面扮演着非常重要的角色。您无需让每个消息生产组件都了解下一个消费者期望的类型，而可以在这些组件之间添加转换器。通用的转换器，例如将 String 转换为 XML 文档的转换器，也具有高度可重用性。对于某些系统，最好提供一个规范数据模型，但 Spring Integration 的总体理念是不要求任何特定格式。相反，为了最大限度的灵活性，Spring Integration 旨在提供最简单的扩展模型。与其他端点类型一样，在 XML 或 Java 注解中使用声明式配置，使得简单的 POJO 能够适应消息转换器的角色。本章的其余部分描述了这些配置选项。

为了最大限度地提高灵活性，Spring 不要求基于 XML 的消息负载。然而，如果 XML 是您的应用程序的正确选择，框架确实提供了一些方便的转换器来处理基于 XML 的负载。有关这些转换器的更多信息，请参阅 XML 支持 - 处理 XML 负载。

使用 Java 和其他 DSL 配置转换器

对于简单的 Java 和注解配置，Spring bean POJO 方法必须用 @Transformer 注解标记，并且当消息从输入通道被消费时，框架会调用它：

public class SomeService {

    @Transformer(inputChannel = "transformChannel", outputChannel = "nextServiceChannel")
    public OutputData exampleTransformer(InputData payload) {
        ...
    }

}

更多信息请参阅注解支持。

对于 Java、Groovy 或 Kotlin DSL，IntegrationFlow 的 .transform() 运算符表示一个转换器端点：

Java DSL
Kotlin DSL
Groovy DSL

@Bean
public IntegrationFlow someFlow() {
    return IntegrationFlow
             .from("transformChannel")
             .transform(someService, "exampleTransformer")
             .channel("nextServiceChannel")
             .get();
}

@Bean
fun someFlow() =
    integrationFlow("transformChannel") {
        transform(someService, "exampleTransformer")
        channel("nextServiceChannel")
    }

@Bean
someFlow() {
    integrationFlow 'transformChannel',
            {
                transform someService, 'exampleTransformer'
                channel 'nextServiceChannel'
            }
}

有关 DSL 的更多信息，请参阅相关章节：

使用 XML 配置转换器

<transformer> 元素用于创建消息转换端点。除了 input-channel 和 output-channel 属性外，它还需要一个 ref 属性。 ref 可以指向包含单个方法上带有 @Transformer 注解的对象（请参阅 transformer-annotation），也可以与 method 属性中提供的显式方法名值结合使用。

<int:transformer id="testTransformer" ref="testTransformerBean" input-channel="inChannel"
             method="transform" output-channel="outChannel"/>
<beans:bean id="testTransformerBean" class="org.foo.TestTransformer" />

如果自定义转换器处理程序实现可以在其他 <transformer> 定义中重用，通常建议使用 ref 属性。但是，如果自定义转换器处理程序实现应仅限于 <transformer> 的单个定义，则可以定义一个内部 bean 定义，如下例所示：

<int:transformer id="testTransformer" input-channel="inChannel" method="transform"
                output-channel="outChannel">
  <beans:bean class="org.foo.TestTransformer"/>
</int:transformer>

在同一个 <transformer> 配置中同时使用 ref 属性和内部处理程序定义是不允许的，因为它会创建模糊条件并导致抛出异常。

如果 ref 属性引用扩展了 AbstractMessageProducingHandler 的 bean（例如框架本身提供的转换器），则通过将输出通道直接注入处理程序来优化配置。在这种情况下，每个 ref 必须指向一个单独的 bean 实例（或一个 prototype-scoped bean），或者使用内部 <bean/> 配置类型。如果您不小心从多个 bean 引用了同一个消息处理程序，则会收到配置异常。

使用 POJO 时，用于转换的方法可以预期 Message 类型或入站消息的负载类型。它还可以通过分别使用 @Header 和 @Headers 参数注解来接受单独的消息头值或完整的映射。方法的返回值可以是任何类型。如果返回值本身是 Message，则将其传递给转换器的输出通道。

从 Spring Integration 2.0 开始，消息转换器的转换方法不能再返回 null。返回 null 会导致异常，因为消息转换器应该始终期望将每个源消息转换为有效的目标消息。换句话说，消息转换器不应该用作消息过滤器，因为为此有一个专门的 <filter> 选项。但是，如果您确实需要这种类型的行为（组件可能返回 null 并且不应该被视为错误），您可以使用服务激活器。它的 requires-reply 值默认为 false，但可以将其设置为 true，以便在 null 返回值时抛出异常，就像转换器一样。

转换器和 Spring 表达式语言 (SpEL)

与路由器、聚合器和其他组件一样，从 Spring Integration 2.0 开始，当转换逻辑相对简单时，转换器也可以受益于 SpEL 支持。以下示例演示了如何使用 SpEL 表达式：

<int:transformer input-channel="inChannel"
	output-channel="outChannel"
	expression="payload.toUpperCase() + '- [' + T(System).currentTimeMillis() + ']'"/>

前面的示例在不编写自定义转换器的情况下转换了负载。我们的负载（假定为 String）被转换为大写，与当前时间戳连接，并应用了一些格式。

常见转换器

Spring Integration 提供了一些转换器实现。

对象到字符串转换器

由于使用 Object 的 toString() 表示形式相当常见，Spring Integration 提供了一个 ObjectToStringTransformer（也请参阅 Transformers 工厂），其中输出是一个带有 String payload 的 Message。该 String 是在入站 Message 的 payload 上调用 toString() 操作的结果。以下示例演示了如何声明对象到字符串转换器的实例：

Java DSL
Kotlin DSL
Groovy DSL
XML

@Bean
public IntegrationFlow someFlow() {
    return IntegrationFlow
             .from("in")
             .transform(Transformers.objectToString())
             .channel("out")
             .get();
}

@Bean
fun someFlow() =
    integrationFlow("in") {
        transform(Transformers.objectToString())
        channel("out")
    }

@Bean
someFlow() {
    integrationFlow 'in',
            {
                transform Transformers.objectToString()
                channel 'out'
            }
}

<int:object-to-string-transformer input-channel="in" output-channel="out"/>

此转换器的一个潜在用途是将一些任意对象发送到 file 命名空间中的“出站通道适配器”。尽管该通道适配器默认仅支持 String、字节数组或 java.io.File 负载，但在适配器之前立即添加此转换器可以处理必要的转换。只要 toString() 调用的结果是您想要写入文件的内容，这就很有效。否则，您可以使用前面所示的通用“转换器”元素提供自定义的基于 POJO 的转换器。

调试时，通常不需要此转换器，因为 logging-channel-adapter 能够记录消息负载。有关详细信息，请参阅 Wire Tap。

对象到字符串转换器非常简单。它对入站负载调用 toString()。从 Spring Integration 3.0 开始，此规则有两个例外：

如果负载是 char[]，它会调用 new String(payload)。
如果负载是 byte[]，它会调用 new String(payload, charset)，其中 charset 默认为 UTF-8。 charset 可以通过在转换器上提供 charset 属性来修改。

为了更复杂（例如在运行时动态选择字符集），您可以改用基于 SpEL 表达式的转换器，如下例所示：

Java DSL
XML

@Bean
public IntegrationFlow someFlow() {
    return IntegrationFlow
             .from("in")
             .transform("new String(payload, headers['myCharset']")
             .channel("out")
             .get();
}

<int:transformer input-channel="in" output-channel="out"
       expression="new String(payload, headers['myCharset']" />

如果您需要将 Object 序列化为字节数组或将字节数组反序列化回 Object，Spring Integration 提供了对称的序列化转换器。这些转换器默认使用标准 Java 序列化，但您可以使用 serializer 和 deserializer 属性分别提供 Spring Serializer 或 Deserializer 策略的实现。另请参阅 Transformers 工厂类。以下示例演示了如何使用 Spring 的序列化器和反序列化器：

Java DSL
XML

@Bean
public IntegrationFlow someFlow() {
    return IntegrationFlow
             .from("objectsIn")
             .transform(Transformers.serializer())
             .channel("bytesOut")
             .channel("bytesIn")
             .transform(Transformers.deserializer("com.mycom.*", "com.yourcom.*"))
             .channel("objectsOut")
             .get();
}

<int:payload-serializing-transformer input-channel="objectsIn" output-channel="bytesOut"/>

<int:payload-deserializing-transformer input-channel="bytesIn" output-channel="objectsOut"
    allow-list="com.mycom.*,com.yourcom.*"/>

当从不受信任的源反序列化数据时，您应该考虑添加包和类模式的 allow-list。默认情况下，所有类都将被反序列化。

`Object` 到 `Map` 和 `Map` 到 `Object` 转换器

Spring Integration 还提供了 Object 到 Map 和 Map 到 Object 转换器，它们使用 JSON 序列化和反序列化对象图。对象层次结构被内省到最原始的类型（String、int 等）。此类型的路径用 SpEL 描述，它成为转换后的 Map 中的 key。原始类型成为值。

考虑以下示例：

public class Parent{
    private Child child;
    private String name;
    // setters and getters are omitted
}

public class Child{
    private String name;
    private List<String> nickNames;
    // setters and getters are omitted
}

前面示例中的两个类被转换为以下 Map：

{person.name=George, person.child.name=Jenna, person.child.nickNames[0]=Jen ...}

基于 JSON 的 Map 允许您描述对象结构而不共享实际类型，这让您可以将对象图恢复并重建为不同类型的对象图，只要您保持结构。

例如，前面的结构可以使用 Map 到 Object 转换器恢复到以下对象图：

public class Father {
    private Kid child;
    private String name;
    // setters and getters are omitted
}

public class Kid {
    private String name;
    private List<String> nickNames;
    // setters and getters are omitted
}

如果您需要创建一个“结构化”映射，您可以提供 flatten 属性。默认值为“true”。如果将其设置为“false”，则结构是 Map 对象的 Map。

考虑以下示例：

public class Parent {
	private Child child;
	private String name;
	// setters and getters are omitted
}

public class Child {
	private String name;
	private List<String> nickNames;
	// setters and getters are omitted
}

前面示例中的两个类被转换为以下 Map：

{name=George, child={name=Jenna, nickNames=[Bimbo, ...]}}

为了配置这些转换器，Spring Integration 提供了相应的 XML 组件和 Java DSL 工厂：

Java DSL
XML

@Bean
public IntegrationFlow someFlow() {
    return IntegrationFlow
             .from("directInput")
             .transform(Transformers.toMap())
             .channel("output")
             .get();
}

<int:object-to-map-transformer input-channel="directInput" output-channel="output"/>

您还可以将 flatten 属性设置为 false，如下所示：

Java DSL
XML

@Bean
public IntegrationFlow someFlow() {
    return IntegrationFlow
             .from("directInput")
             .transform(Transformers.toMap(false))
             .channel("output")
             .get();
}

<int:object-to-map-transformer input-channel="directInput" output-channel="output" flatten="false"/>

Spring Integration 为 Map-to-Object 提供了 XML 命名空间支持，Java DSL 工厂具有 fromMap() 方法，如下例所示：

Java DSL
XML

@Bean
public IntegrationFlow someFlow() {
    return IntegrationFlow
             .from("input")
             .transform(Transformers.fromMap(org.something.Person.class))
             .channel("output")
             .get();
}

<int:map-to-object-transformer input-channel="input"
                         output-channel="output"
                         type="org.something.Person"/>

或者，您可以使用 ref 属性和原型范围的 bean，如下例所示：

Java DSL
XML

@Bean
IntegrationFlow someFlow() {
    return IntegrationFlow
             .from("inputA")
             .transform(Transformers.fromMap("person"))
             .channel("outputA")
             .get();
}

@Bean
@Scope("prototype")
Person person() {
    return new Person();
}

<int:map-to-object-transformer input-channel="inputA"
                               output-channel="outputA"
                               ref="person"/>
<bean id="person" class="org.something.Person" scope="prototype"/>

ref 和 type 属性是互斥的。此外，如果您使用 ref 属性，则必须指向“prototype”范围的 bean。否则，会抛出 BeanCreationException。

从 5.0 版本开始，您可以为 ObjectToMapTransformer 提供一个自定义的 JsonObjectMapper——当您需要特殊日期格式或空集合的 null 值（以及其他用途）时。有关 JsonObjectMapper 实现的更多信息，请参阅 json-transformers。

流转换器

StreamTransformer 将 InputStream 负载转换为 byte[]（如果提供了 charset，则转换为 String）。

以下示例演示了如何在 XML 中使用 stream-transformer 元素：

Java DSL
XML

@Bean
public IntegrationFlow someFlow() {
    return IntegrationFlow
             .from("input")
             .transform(Transformers.fromStream("UTF-8"))
             .channel("output")
             .get();
}

<int:stream-transformer input-channel="directInput" output-channel="output"/> <!-- byte[] -->

<int:stream-transformer id="withCharset" charset="UTF-8"
    input-channel="charsetChannel" output-channel="output"/> <!-- String -->

以下示例演示了如何使用 StreamTransformer 类和 @Transformer 注解在 Java 中配置流转换器：

@Bean
@Transformer(inputChannel = "stream", outputChannel = "data")
public StreamTransformer streamToBytes() {
    return new StreamTransformer(); // transforms to byte[]
}

@Bean
@Transformer(inputChannel = "stream", outputChannel = "data")
public StreamTransformer streamToString() {
    return new StreamTransformer("UTF-8"); // transforms to String
}

JSON 转换器

Spring Integration 提供对象到 JSON 和 JSON 到对象转换器。以下两组示例演示了如何在 XML 中声明它们：

<int:object-to-json-transformer input-channel="objectMapperInput"/>

<int:json-to-object-transformer input-channel="objectMapperInput"
    type="foo.MyDomainObject"/>

默认情况下，前面列表中的转换器使用普通的 JsonObjectMapper。它基于类路径中的实现。您可以提供自己的自定义 JsonObjectMapper 实现，具有适当的选项或基于所需的库（例如 GSON），如下例所示：

<int:json-to-object-transformer input-channel="objectMapperInput"
    type="something.MyDomainObject" object-mapper="customObjectMapper"/>

从 3.0 版本开始，object-mapper 属性引用新的策略接口 JsonObjectMapper 的实例。这种抽象允许使用 JSON 映射器的多种实现。提供了包装 Jackson 2 的实现，版本在类路径上检测。该类分别是 Jackson2JsonObjectMapper。

您可能希望考虑使用 FactoryBean 或工厂方法创建具有所需特征的 JsonObjectMapper。以下示例演示了如何使用此类工厂：

public class ObjectMapperFactory {

    public static Jackson2JsonObjectMapper getMapper() {
        ObjectMapper mapper = new ObjectMapper();
        mapper.configure(JsonParser.Feature.ALLOW_COMMENTS, true);
        return new Jackson2JsonObjectMapper(mapper);
    }
}

以下示例演示了如何在 XML 中执行相同的操作：

<bean id="customObjectMapper" class="something.ObjectMapperFactory"
            factory-method="getMapper"/>

从 2.2 版本开始，如果输入消息没有 content-type 头，object-to-json-transformer 默认将 content-type 头设置为 application/json。如果您希望将 content-type 头设置为其他值，或者显式覆盖任何现有头（包括 application/json），请使用 content-type 属性。如果您希望抑制头的设置，请将 content-type 属性设置为空字符串 ("")。这样做会导致消息没有 content-type 头，除非输入消息中存在此类头。

从 3.0 版本开始，ObjectToJsonTransformer 会将反映源类型的头添加到消息中。类似地，JsonToObjectTransformer 在将 JSON 转换为对象时可以使用这些类型头。这些头在 AMQP 适配器中映射，以便它们与 Spring-AMQP JsonMessageConverter 完全兼容。

这使得以下流程无需任何特殊配置即可工作：

…→amqp-outbound-adapter---→
---→amqp-inbound-adapter→json-to-object-transformer→…`其中出站适配器配置有 `JsonMessageConverter，入站适配器使用默认的 SimpleMessageConverter。
…→object-to-json-transformer→amqp-outbound-adapter---→
---→amqp-inbound-adapter→…`其中出站适配器配置有 `SimpleMessageConverter，入站适配器使用默认的 JsonMessageConverter。
…→object-to-json-transformer→amqp-outbound-adapter---→
---→amqp-inbound-adapter→json-to-object-transformer→`其中两个适配器都配置有 `SimpleMessageConverter。

当使用头来确定类型时，您不应该提供 class 属性，因为它优先于头。

除了 JSON 转换器，Spring Integration 还提供了内置的 #jsonPath SpEL 函数，用于表达式。更多信息请参阅 Spring 表达式语言 (SpEL)。

从 3.0 版本开始，Spring Integration 还提供了内置的 #xpath SpEL 函数，用于表达式。更多信息请参阅 #xpath SpEL 函数。

从 4.0 版本开始，ObjectToJsonTransformer 支持 resultType 属性，用于指定节点 JSON 表示。结果节点树表示取决于提供的 JsonObjectMapper 的实现。默认情况下，ObjectToJsonTransformer 使用 Jackson2JsonObjectMapper 并将对象到节点树的转换委托给 ObjectMapper#valueToTree 方法。节点 JSON 表示提供了使用 JsonPropertyAccessor 的效率，当下游消息流使用 SpEL 表达式访问 JSON 数据的属性时。有关更多信息，请参阅属性访问器。

从 5.1 版本开始，resultType 可以配置为 BYTES，以生成带有 byte[] 负载的消息，以便于使用处理此数据类型的下游处理程序。

从 5.2 版本开始，JsonToObjectTransformer 可以配置一个 ResolvableType，以支持目标 JSON 处理器在反序列化期间的泛型。此外，此组件现在首先检查请求消息头中是否存在 JsonHeaders.RESOLVABLE_TYPE 或 JsonHeaders.TYPE_ID，否则回退到配置的类型。 ObjectToJsonTransformer 现在还会根据请求消息负载填充 JsonHeaders.RESOLVABLE_TYPE 头，以用于任何可能的下游场景。

从 5.2.6 版本开始，JsonToObjectTransformer 可以提供一个 valueTypeExpression，以在运行时根据请求消息解析要从 JSON 转换的负载的 ResolvableType。默认情况下，它会查询请求消息中的 JsonHeaders。如果此表达式返回 null 或 ResolvableType 构建抛出 ClassNotFoundException，则转换器会回退到提供的 targetType。此逻辑作为表达式存在，因为 JsonHeaders 可能没有实际的类值，而是一些必须根据某些外部注册表映射到目标类的类型 ID。

Apache Avro 转换器

5.2 版本增加了简单的转换器，用于转换为/从 Apache Avro。

它们不够复杂，因为没有模式注册表；转换器只使用从 Avro 模式生成的 SpecificRecord 实现中嵌入的模式。

发送到 SimpleToAvroTransformer 的消息的负载必须实现 SpecificRecord；转换器可以处理多种类型。 SimpleFromAvroTransformer 必须配置一个 SpecificRecord 类，该类用作默认反序列化类型。您还可以指定一个 SpEL 表达式，通过 setTypeExpression 方法确定要反序列化的类型。默认的 SpEL 表达式是 headers[avro_type] (AvroHeaders.TYPE)，默认情况下，SimpleToAvroTransformer 会用源类的完全限定类名填充它。如果表达式返回 null，则使用 defaultType。

SimpleToAvroTransformer 也有一个 setTypeExpression 方法。这允许解耦生产者和消费者，发送者可以将头设置为表示类型的某个令牌，然后消费者将该令牌映射到类型。

Protocol Buffers 转换器

6.1 版本增加了对从 Protocol Buffers 数据内容进行转换的支持。

ToProtobufTransformer 将 com.google.protobuf.Message 消息负载转换为原生字节数组或 JSON 文本负载。 application/x-protobuf 内容类型（默认使用）生成字节数组输出负载。如果内容类型是 application/json，并且在类路径上找到了 com.google.protobuf:protobuf-java-util，则输出是文本 JSON 负载。如果未设置内容类型头，ToProtobufTransformer 默认为 application/x-protobuf。

FromProtobufTransformer 将字节数组或文本 protobuf 负载（取决于内容类型）转换回 com.google.protobuf.Message 实例。 FromProtobufTransformer 应该显式指定预期的类类型（使用 setExpectedType 方法）或使用 SpEL 表达式通过 setExpectedTypeExpression 方法确定要反序列化的类型。默认的 SpEL 表达式是 headers[proto_type] (ProtoHeaders.TYPE)，它由 ToProtobufTransformer 用源 com.google.protobuf.Message 类的完全限定类名填充。

例如，编译以下 IDL：

syntax = "proto2";
package tutorial;

option java_multiple_files = true;
option java_package = "org.example";
option java_outer_classname = "MyProtos";

message MyMessageClass {
  optional string foo = 1;
  optional string bar = 2;
}

将生成一个新的 org.example.MyMessageClass 类。

然后使用：

// Transforms a MyMessageClass instance into a byte array.
ToProtobufTransformer toTransformer = new ToProtobufTransformer();

MyMessageClass test = MyMessageClass.newBuilder()
                                .setFoo("foo")
                                .setBar("bar")
                                .build();
// message1 payload is byte array protocol buffer wire format.
Message message1 = toTransformer.transform(new GenericMessage<>(test));

// Transforms a byte array payload into a MyMessageClass instance.
FromProtobufTransformer fromTransformer = new FromProtobufTransformer();

// message2 payload == test
Message message2 =  fromTransformer.transform(message1);

使用注解配置转换器

您可以将 @Transformer 注解添加到预期 Message 类型或消息负载类型的方法中。返回值的处理方式与前面 transformer-namespace 中所述完全相同。以下示例演示了如何使用 @Transformer 注解将 String 转换为 Order：

@Transformer
Order generateOrder(String productId) {
    return new Order(productId);
}

转换器方法还可以接受 @Header 和 @Headers 注解，如 注解支持 中所述。以下示例演示了如何使用 @Header 注解：

@Transformer
Order generateOrder(String productId, @Header("customerName") String customer) {
    return new Order(productId, customer);
}

另请参阅使用注解建议端点。

消息头过滤器

有时，您的转换用例可能像删除几个消息头一样简单。对于此类用例，Spring Integration 提供了一个消息头过滤器，允许您指定应从输出消息中删除的某些消息头名称（例如，出于安全原因删除消息头或仅临时需要的值）。基本上，消息头过滤器与消息头丰富器相反。后者在消息头丰富器中讨论。以下示例定义了一个消息头过滤器：

Java DSL
XML

@Bean
public IntegrationFlow someFlow() {
    return IntegrationFlow
             .from("inputChannel")
             .headerFilter("lastName", "state")
             .channel("outputChannel")
             .get();
}

<int:header-filter input-channel="inputChannel"
		output-channel="outputChannel" header-names="lastName, state"/>

如您所见，消息头过滤器的配置非常简单。它是一个典型的端点，具有输入和输出通道以及 header-names 属性。该属性接受需要删除的消息头名称（如果有多个，则用逗号分隔）。因此，在前面的示例中，名为“lastName”和“state”的消息头不会出现在出站消息中。

基于编解码器的转换器

请参阅编解码器。

转换器

使用 Java 和其他 DSL 配置转换器

使用 XML 配置转换器

转换器和 Spring 表达式语言 (SpEL)

常见转换器

对象到字符串转换器

Object 到 Map 和 Map 到 Object 转换器

流转换器

JSON 转换器

Apache Avro 转换器

Protocol Buffers 转换器

使用注解配置转换器

消息头过滤器

基于编解码器的转换器

`Object` 到 `Map` 和 `Map` 到 `Object` 转换器