Codec
Spring Integration 4.2 版本引入了 Codec
抽象。
Codec 将对象编码和解码为 byte[]
。
它们提供了 Java 序列化的替代方案。
一个优点是,通常情况下,对象无需实现 Serializable
接口。
我们提供了一个使用 Kryo 进行序列化的实现,但你可以提供自己的实现,用于以下任何组件:
-
EncodingPayloadTransformer
-
DecodingTransformer
-
CodecMessageConverter
EncodingPayloadTransformer
此转换器使用编解码器将有效载荷编码为 byte[]
。
它不影响消息头。
有关更多信息,请参阅 Javadoc。
DecodingTransformer
此转换器使用编解码器解码 byte[]
。
它需要配置解码目标 Class
(或解析为 Class
的表达式)。
如果结果对象是 Message<?>
,则不保留入站消息头。
有关更多信息,请参阅 Javadoc。
CodecMessageConverter
某些端点(例如 TCP 和 Redis)没有消息头的概念。
它们支持使用 MessageConverter
,并且 CodecMessageConverter
可用于将消息转换为 byte[]
或从 byte[]
转换消息以进行传输。
有关更多信息,请参阅 Javadoc。
Kryo
目前,这是 Codec
的唯一实现,它提供了两种 Codec
:
-
PojoCodec
:用于转换器中 -
MessageCodec
:用于CodecMessageConverter
中
框架提供了几个自定义序列化器:
-
FileSerializer
-
MessageHeadersSerializer
-
MutableMessageHeadersSerializer
第一个可以与 PojoCodec
配合使用,通过使用 FileKryoRegistrar
进行初始化。
第二个和第三个与 MessageCodec
配合使用,MessageCodec
使用 MessageKryoRegistrar
进行初始化。
自定义 Kryo
默认情况下,Kryo 将未知 Java 类型委托给其 FieldSerializer
。
Kryo 还为每种原始类型以及 String
、Collection
和 Map
注册默认序列化器。
FieldSerializer
使用反射来遍历对象图。
一种更有效的方法是实现一个自定义序列化器,该序列化器了解对象的结构并可以直接序列化选定的原始字段。
以下示例展示了这样一个序列化器:
public class AddressSerializer extends Serializer<Address> {
@Override
public void write(Kryo kryo, Output output, Address address) {
output.writeString(address.getStreet());
output.writeString(address.getCity());
output.writeString(address.getCountry());
}
@Override
public Address read(Kryo kryo, Input input, Class<Address> type) {
return new Address(input.readString(), input.readString(), input.readString());
}
}
Serializer
接口暴露了 Kryo
、Input
和 Output
,它们提供了对包含哪些字段和其他内部设置的完全控制,如 Kryo 文档 中所述。
注册自定义序列化器时,你需要一个注册 ID。 注册 ID 是任意的。 但是,在我们的例子中,ID 必须明确定义,因为分布式应用程序中的每个 Kryo 实例都必须使用相同的 ID。 Kryo 推荐使用小的正整数,并保留了一些 ID(值 < 10)。 Spring Integration 目前默认使用 40、41 和 42(用于前面提到的文件和消息头序列化器)。 我们建议你从 60 开始,以便为框架的扩展留出空间。 你可以通过配置前面提到的注册器来覆盖这些框架默认值。 |
使用自定义 Kryo 序列化器
如果需要自定义序列化,请参阅 Kryo 文档,因为你需要使用原生 API 进行自定义。
例如,请参阅 org.springframework.integration.codec.kryo.MessageCodec
实现。
实现 KryoSerializable
如果你对领域对象源代码具有 write
访问权限,则可以按照 此处 所述实现 KryoSerializable
。
在这种情况下,类本身提供序列化方法,无需进一步配置。
但是,基准测试表明这不如显式注册自定义序列化器高效。
以下示例展示了一个自定义 Kryo 序列化器:
public class Address implements KryoSerializable {
@Override
public void write(Kryo kryo, Output output) {
output.writeString(this.street);
output.writeString(this.city);
output.writeString(this.country);
}
@Override
public void read(Kryo kryo, Input input) {
this.street = input.readString();
this.city = input.readString();
this.country = input.readString();
}
}
你也可以使用此技术来包装 Kryo 以外的序列化库。
使用 @DefaultSerializer
注解
Kryo 还提供了一个 @DefaultSerializer
注解,如 此处 所述。
@DefaultSerializer(SomeClassSerializer.class)
public class SomeClass {
// ...
}
如果你对领域对象具有 write
访问权限,这可能是指定自定义序列化器的一种更简单的方法。
请注意,这不会用 ID 注册类,这可能会使该技术在某些情况下无用。