转换器

消息转换器在实现消息生产者和消息消费者的松散耦合中发挥着非常重要的作用。您可以添加转换器在这些组件之间，而不是要求每个消息生成组件知道下一个消费者期望的类型。通用转换器（例如将 String 转换为 XML 文档的转换器）也具有很高的可重用性。

对于某些系统，最好提供规范数据模型，但 Spring Integration 的一般理念是不需要任何特定格式。相反，为了最大程度的灵活性，Spring Integration 旨在为扩展提供最简单的可能模型。与其他端点类型一样，在 XML 或 Java 注释中使用声明式配置可以使简单的 POJO 适应消息转换器的角色。本章的其余部分描述了这些配置选项。

为了最大程度地提高灵活性，Spring 不要求基于 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 注释的对象（请参阅使用注释配置转换器），或者可以与 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"/>
</transformer>

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

如果 ref 属性引用扩展 AbstractMessageProducingHandler 的 bean（例如框架本身提供的转换器），则通过将输出通道直接注入到处理程序中来优化配置。在这种情况下，每个 ref 必须指向一个单独的 bean 实例（或 prototype 作用域的 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 是对入站消息有效负载调用 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 命名空间中的“outbound-channel-adapter”。虽然该通道适配器默认仅支持 String、字节数组或 java.io.File 有效负载，但在适配器之前添加此转换器可以立即处理必要的转换。只要 toString() 调用的结果是您想要写入文件的内容，这种方法就可以正常工作。否则，您可以使用前面显示的通用“transformer”元素提供基于 POJO 的自定义转换器。

在调试时，此转换器通常不是必需的，因为 logging-channel-adapter 能够记录消息有效负载。有关更多详细信息，请参阅监听。

对象到字符串转换器非常简单。它在入站有效负载上调用 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.*"/>

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

`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 到 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，以满足对日期的特殊格式或空集合的空值（以及其他用途）的需求。有关 JsonObjectMapper 实现的更多信息，请参阅 JSON 转换器。

流转换器

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 -->

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

@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 版本开始，如果输入消息尚未具有该头，则 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 数据属性的 SpEL 表达式时，节点 JSON 表示形式可有效使用 JsonPropertyAccessor。有关详细信息，请参阅属性访问器。

从 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，这些类型 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 方法。这允许生产者和消费者分离，其中发送者可以将标头设置为表示类型的某个令牌，然后消费者将该令牌映射到类型。

协议缓冲区转换器

版本 6.1 添加了对从协议缓冲区数据内容转换以及转换到协议缓冲区数据内容的支持。

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> 元素的部分中描述的完全相同。以下示例展示了如何使用 @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 转换器

协议缓冲区转换器

使用注释配置转换器

标头过滤器

基于编解码器的转换器

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