此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring for Apache Kafka 3.3.0! |
序列化、反序列化和消息转换
概述
Apache Kafka 提供了一个高级 API,用于序列化和反序列化记录值及其键。
它与org.apache.kafka.common.serialization.Serializer<T>
和org.apache.kafka.common.serialization.Deserializer<T>
abstractions 的 API。
同时,我们可以使用Producer
或Consumer
configuration 属性。
以下示例显示了如何执行此作:
props.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, IntegerDeserializer.class);
props.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class);
...
props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, IntegerSerializer.class);
props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, StringSerializer.class);
对于更复杂或特殊的情况,KafkaConsumer
(因此,KafkaProducer
) 提供重载的
要接受的构造函数Serializer
和Deserializer
instances 的keys
和values
分别。
当您使用此 API 时,DefaultKafkaProducerFactory
和DefaultKafkaConsumerFactory
还提供属性(通过构造函数或 setter 方法)来注入自定义Serializer
和Deserializer
实例到目标Producer
或Consumer
.
此外,您还可以传入Supplier<Serializer>
或Supplier<Deserializer>
实例 - 这些Supplier
s 在创建每个Producer
或Consumer
.
字符串序列化
从 2.5 版本开始, Spring for Apache Kafka 提供了ToStringSerializer
和ParseStringDeserializer
使用实体的 String 表示的类。
他们依赖于方法toString
还有一些Function<String>
或BiFunction<String, Headers>
解析实例的 String 并填充属性。
通常,这会在类上调用一些静态方法,例如parse
:
ToStringSerializer<Thing> thingSerializer = new ToStringSerializer<>();
//...
ParseStringDeserializer<Thing> deserializer = new ParseStringDeserializer<>(Thing::parse);
默认情况下,ToStringSerializer
配置为传达有关记录中序列化实体的类型信息Headers
.
您可以通过设置addTypeInfo
property 设置为false
.
此信息可由ParseStringDeserializer
在接收方。
-
ToStringSerializer.ADD_TYPE_INFO_HEADERS
(默认true
):您可以将其设置为false
要在ToStringSerializer
(将addTypeInfo
属性)。
ParseStringDeserializer<Object> deserializer = new ParseStringDeserializer<>((str, headers) -> {
byte[] header = headers.lastHeader(ToStringSerializer.VALUE_TYPE).value();
String entityType = new String(header);
if (entityType.contains("Thing")) {
return Thing.parse(str);
}
else {
// ...parsing logic
}
});
您可以配置Charset
用于转换String
往返byte[]
默认值为UTF-8
.
你可以使用 parser 方法的名称来配置反序列化器ConsumerConfig
性能:
-
ParseStringDeserializer.KEY_PARSER
-
ParseStringDeserializer.VALUE_PARSER
属性必须包含类的完全限定名称,后跟方法名称,用句点分隔.
.
该方法必须是静态的,并且具有(String, Headers)
或(String)
.
一个ToFromStringSerde
,用于 Kafka Streams。
JSON 格式
Spring for Apache Kafka 还提供JsonSerializer
和JsonDeserializer
基于
Jackson JSON 对象映射器。
这JsonSerializer
允许将任何 Java 对象编写为 JSONbyte[]
.
这JsonDeserializer
需要额外的Class<?> targetType
参数以允许对 consumedbyte[]
添加到正确的目标对象中。
以下示例演示如何创建JsonDeserializer
:
JsonDeserializer<Thing> thingDeserializer = new JsonDeserializer<>(Thing.class);
您可以自定义两者JsonSerializer
和JsonDeserializer
替换为ObjectMapper
.
您还可以扩展它们以实现configure(Map<String, ?> configs, boolean isKey)
方法。
从版本 2.3 开始,默认情况下,所有 JSON 感知组件都使用JacksonUtils.enhancedObjectMapper()
实例,它附带了MapperFeature.DEFAULT_VIEW_INCLUSION
和DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES
功能已禁用。
此外,此类实例还提供了用于自定义数据类型的众所周知的模块,例如 Java 时间和 Kotlin 支持。
看JacksonUtils.enhancedObjectMapper()
JavaDocs 了解更多信息。
此方法还会注册一个org.springframework.kafka.support.JacksonMimeTypeModule
为org.springframework.util.MimeType
对象序列化为纯字符串,以便通过网络实现平台间兼容性。
一个JacksonMimeTypeModule
可以在应用程序上下文中注册为 bean,并且它将被自动配置到Spring BootObjectMapper
实例.
同样从版本 2.3 开始,JsonDeserializer
提供TypeReference
的构造函数,以便更好地处理目标泛型容器类型。
从版本 2.1 开始,您可以在 record 中传达类型信息Headers
,允许处理多种类型。
此外,您可以使用以下 Kafka 属性配置序列化程序和反序列化程序。
如果您提供了Serializer
和Deserializer
instances 的KafkaConsumer
和KafkaProducer
分别。
配置属性
-
JsonSerializer.ADD_TYPE_INFO_HEADERS
(默认true
):您可以将其设置为false
要在JsonSerializer
(将addTypeInfo
属性)。 -
JsonSerializer.TYPE_MAPPINGS
(默认empty
):请参阅映射类型。 -
JsonDeserializer.USE_TYPE_INFO_HEADERS
(默认true
):您可以将其设置为false
忽略序列化程序设置的标头。 -
JsonDeserializer.REMOVE_TYPE_INFO_HEADERS
(默认true
):您可以将其设置为false
保留序列化程序设置的标头。 -
JsonDeserializer.KEY_DEFAULT_TYPE
:如果不存在标头信息,则用于键反序列化的回退类型。 -
JsonDeserializer.VALUE_DEFAULT_TYPE
:如果不存在标头信息,则用于反序列化值的回退类型。 -
JsonDeserializer.TRUSTED_PACKAGES
(默认java.util
,java.lang
):允许反序列化的包模式的逗号分隔列表。 意味着反序列化 all。*
-
JsonDeserializer.TYPE_MAPPINGS
(默认empty
):请参阅映射类型。 -
JsonDeserializer.KEY_TYPE_METHOD
(默认empty
):请参阅使用方法确定类型。 -
JsonDeserializer.VALUE_TYPE_METHOD
(默认empty
):请参阅使用方法确定类型。
从版本 2.2 开始,类型信息 Headers(如果由序列化器添加)由反序列化器删除。
您可以通过设置removeTypeHeaders
property 设置为false
,可以直接在 deserializer 上或使用前面描述的 configuration 属性。
从版本 2.8 开始,如果你以编程方式构造序列化器或反序列化器,如 编程构造 中所示,只要你没有显式设置任何属性(使用set*() 方法或使用 Fluent API)。
以前,以编程方式创建时,从不应用配置属性;如果您直接在对象上显式设置属性,则仍然会出现这种情况。 |
映射类型
从版本 2.2 开始,在使用 JSON 时,您现在可以使用前面列表中的属性来提供类型映射。
以前,您必须在序列化器和反序列化器中自定义类型映射器。
映射由逗号分隔的token:className
对。
在出站时,有效负载的类名将映射到相应的令牌。
在入站时,type 标头中的令牌将映射到相应的类名。
以下示例创建一组映射:
senderProps.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, JsonSerializer.class);
senderProps.put(JsonSerializer.TYPE_MAPPINGS, "cat:com.mycat.Cat, hat:com.myhat.Hat");
...
consumerProps.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, JsonDeserializer.class);
consumerProps.put(JsonDeserializer.TYPE_MAPPINGS, "cat:com.yourcat.Cat, hat:com.yourhat.Hat");
相应的对象必须兼容。 |
如果使用 Spring Boot,则可以在application.properties
(或 yaml)文件。
以下示例显示了如何执行此作:
spring.kafka.producer.value-serializer=org.springframework.kafka.support.serializer.JsonSerializer
spring.kafka.producer.properties.spring.json.type.mapping=cat:com.mycat.Cat,hat:com.myhat.Hat
您只能使用属性执行简单配置。
对于更高级的配置(例如使用自定义的
还提供了 Setter,作为使用这些构造函数的替代方法。 |
当使用 Spring Boot 并覆盖ConsumerFactory 和ProducerFactory 如上所示,通配符泛型类型需要与 Bean 方法返回类型一起使用。
如果提供了具体的泛型类型,则 Spring Boot 将忽略这些 bean 并仍然使用默认 bean。 |
从版本 2.2 开始,你可以显式地将反序列化器配置为使用提供的目标类型,并通过使用具有布尔值的重载构造函数之一来忽略 Headers 中的类型信息useHeadersIfPresent
参数(即true
默认情况下)。
以下示例显示了如何执行此作:
DefaultKafkaConsumerFactory<Integer, Cat1> cf = new DefaultKafkaConsumerFactory<>(props,
new IntegerDeserializer(), new JsonDeserializer<>(Cat1.class, false));
使用方法确定类型
从版本 2.5 开始,您现在可以通过 properties 配置反序列化器,以调用方法来确定目标类型。
如果存在,这将覆盖上面讨论的任何其他技术。
如果数据是由不使用 Spring 序列化器的应用程序发布的,并且您需要根据数据或其他 Headers 反序列化为不同的类型,那么这可能很有用。
将这些属性设置为方法名称 - 一个完全限定的类名,后跟方法名称,用句点分隔.
.
该方法必须声明为public static
具有三个签名之一(String topic, byte[] data, Headers headers)
,(byte[] data, Headers headers)
或(byte[] data)
并返回 JacksonJavaType
.
-
JsonDeserializer.KEY_TYPE_METHOD
:spring.json.key.type.method
-
JsonDeserializer.VALUE_TYPE_METHOD
:spring.json.value.type.method
您可以使用任意标头或检查数据以确定类型。
JavaType thing1Type = TypeFactory.defaultInstance().constructType(Thing1.class);
JavaType thing2Type = TypeFactory.defaultInstance().constructType(Thing2.class);
public static JavaType thingOneOrThingTwo(byte[] data, Headers headers) {
// {"thisIsAFieldInThing1":"value", ...
if (data[21] == '1') {
return thing1Type;
}
else {
return thing2Type;
}
}
对于更复杂的数据检查,请考虑使用JsonPath
或类似的,但是,用于确定类型的测试越简单,过程的效率就越高。
以下是以编程方式创建反序列化器的示例(在构造函数中为 Consumer Factory 提供反序列化器时):
JsonDeserializer<Object> deser = new JsonDeserializer<>()
.trustedPackages("*")
.typeResolver(SomeClass::thing1Thing2JavaTypeForTopic);
...
public static JavaType thing1Thing2JavaTypeForTopic(String topic, byte[] data, Headers headers) {
...
}
程序化构建
当以编程方式构造序列化器/反序列化器以在 producer/consumer 工厂中使用时,从版本 2.3 开始,你可以使用 Fluent API,这简化了配置。
@Bean
public ProducerFactory<MyKeyType, MyValueType> pf() {
Map<String, Object> props = new HashMap<>();
// props.put(..., ...)
// ...
DefaultKafkaProducerFactory<MyKeyType, MyValueType> pf = new DefaultKafkaProducerFactory<>(props,
new JsonSerializer<MyKeyType>()
.forKeys()
.noTypeInfo(),
new JsonSerializer<MyValueType>()
.noTypeInfo());
return pf;
}
@Bean
public ConsumerFactory<MyKeyType, MyValueType> cf() {
Map<String, Object> props = new HashMap<>();
// props.put(..., ...)
// ...
DefaultKafkaConsumerFactory<MyKeyType, MyValueType> cf = new DefaultKafkaConsumerFactory<>(props,
new JsonDeserializer<>(MyKeyType.class)
.forKeys()
.ignoreTypeHeaders(),
new JsonDeserializer<>(MyValueType.class)
.ignoreTypeHeaders());
return cf;
}
要以编程方式提供类型映射,类似于使用方法确定类型,请使用typeFunction
财产。
JsonDeserializer<Object> deser = new JsonDeserializer<>()
.trustedPackages("*")
.typeFunction(MyUtils::thingOneOrThingTwo);
或者,只要您不使用 Fluent API 来配置属性,或使用set*()
方法,工厂将使用配置属性配置序列化器/反序列化器;请参阅配置属性。
委托序列化器和反序列化器
使用标头
版本 2.3 引入了DelegatingSerializer
和DelegatingDeserializer
,这允许生成和使用具有不同键和/或值类型的记录。
创建者必须设置一个 headerDelegatingSerializer.VALUE_SERIALIZATION_SELECTOR
设置为选择器值,该值用于选择用于值的序列化程序,并将DelegatingSerializer.KEY_SERIALIZATION_SELECTOR
对于密钥;如果未找到匹配项,则IllegalStateException
被抛出。
对于传入记录,反序列化器使用相同的 Headers 来选择要使用的反序列化器;如果未找到匹配项或标头不存在,则 RAWbyte[]
返回。
您可以将 selector 的映射配置为Serializer
/ Deserializer
通过构造函数,或者您可以通过 Kafka 生产者/消费者属性使用键DelegatingSerializer.VALUE_SERIALIZATION_SELECTOR_CONFIG
和DelegatingSerializer.KEY_SERIALIZATION_SELECTOR_CONFIG
.
对于序列化程序,producer 属性可以是Map<String, Object>
其中 key 是 selector,值是Serializer
instance、序列化器Class
或类名。
该属性也可以是逗号分隔的映射条目的 String,如下所示。
对于反序列化器,consumer 属性可以是Map<String, Object>
其中 key 是 selector,值是Deserializer
instance、一个反序列化器Class
或类名。
该属性也可以是逗号分隔的映射条目的 String,如下所示。
要使用 properties 进行配置,请使用以下语法:
producerProps.put(DelegatingSerializer.VALUE_SERIALIZATION_SELECTOR_CONFIG,
"thing1:com.example.MyThing1Serializer, thing2:com.example.MyThing2Serializer")
consumerProps.put(DelegatingDeserializer.VALUE_SERIALIZATION_SELECTOR_CONFIG,
"thing1:com.example.MyThing1Deserializer, thing2:com.example.MyThing2Deserializer")
然后,创建者会将DelegatingSerializer.VALUE_SERIALIZATION_SELECTOR
header 设置为thing1
或thing2
.
此技术支持向同一主题(或不同主题)发送不同类型的内容。
从版本 2.5.1 开始,如果类型(键或值)是Serdes (Long ,Integer 等)。
相反,序列化程序会将标头设置为类型的类名。
没有必要为这些类型配置 serializer 或 deserializers,它们将动态创建(一次)。 |
有关将不同类型的 CAN 发送到不同主题的另一种技术,请参阅用RoutingKafkaTemplate
.
按类型
版本 2.8 引入了DelegatingByTypeSerializer
.
@Bean
public ProducerFactory<Integer, Object> producerFactory(Map<String, Object> config) {
return new DefaultKafkaProducerFactory<>(config,
null, new DelegatingByTypeSerializer(Map.of(
byte[].class, new ByteArraySerializer(),
Bytes.class, new BytesSerializer(),
String.class, new StringSerializer())));
}
从版本 2.8.3 开始,你可以配置序列化器来检查是否可以从目标对象分配 map 键,这在委托序列化器可以序列化子类时很有用。
在这种情况下,如果存在不明确的匹配项,则排序的Map
,例如LinkedHashMap
应该提供。
按主题
从版本 2.8 开始,DelegatingByTopicSerializer
和DelegatingByTopicDeserializer
允许根据 topic name 选择 serializer/deserializer。
正则表达式Pattern
s 用于查找要使用的实例。
可以使用构造函数或通过属性(以逗号分隔的pattern:serializer
).
producerConfigs.put(DelegatingByTopicSerializer.VALUE_SERIALIZATION_TOPIC_CONFIG,
"topic[0-4]:" + ByteArraySerializer.class.getName()
+ ", topic[5-9]:" + StringSerializer.class.getName());
...
consumerConfigs.put(DelegatingByTopicDeserializer.VALUE_SERIALIZATION_TOPIC_CONFIG,
"topic[0-4]:" + ByteArrayDeserializer.class.getName()
+ ", topic[5-9]:" + StringDeserializer.class.getName());
用KEY_SERIALIZATION_TOPIC_CONFIG
当将其用于键时。
@Bean
public ProducerFactory<Integer, Object> producerFactory(Map<String, Object> config) {
return new DefaultKafkaProducerFactory<>(config,
new IntegerSerializer(),
new DelegatingByTopicSerializer(Map.of(
Pattern.compile("topic[0-4]"), new ByteArraySerializer(),
Pattern.compile("topic[5-9]"), new StringSerializer())),
new JsonSerializer<Object>()); // default
}
您可以使用DelegatingByTopicSerialization.KEY_SERIALIZATION_TOPIC_DEFAULT
和DelegatingByTopicSerialization.VALUE_SERIALIZATION_TOPIC_DEFAULT
.
附加属性DelegatingByTopicSerialization.CASE_SENSITIVE
(默认true
),当设置为false
使 Topic lookup 不区分大小写。
重试 Deserializer
这RetryingDeserializer
使用委托Deserializer
和RetryTemplate
在反序列化期间,当委托可能存在暂时性错误(如网络问题)时重试反序列化。
ConsumerFactory cf = new DefaultKafkaConsumerFactory(myConsumerConfigs,
new RetryingDeserializer(myUnreliableKeyDeserializer, retryTemplate),
new RetryingDeserializer(myUnreliableValueDeserializer, retryTemplate));
从 version 开始3.1.2
一个RecoveryCallback
可以在RetryingDeserializer
选择。
请参阅 spring-retry 项目,了解RetryTemplate
使用 retry policy、back off policy 等。
Spring 消息传递消息转换
尽管Serializer
和Deserializer
API 与低级 Kafka 相比非常简单灵活Consumer
和Producer
perspective,那么在使用@KafkaListener
或 Spring Integration 的 Apache Kafka 支持。
让您轻松转换org.springframework.messaging.Message
,Spring for Apache Kafka 提供了一个MessageConverter
abstraction 替换为MessagingMessageConverter
implementation 及其JsonMessageConverter
(和子类)自定义。
您可以注入MessageConverter
转换为KafkaTemplate
实例,以及使用AbstractKafkaListenerContainerFactory
bean 定义@KafkaListener.containerFactory()
财产。
以下示例显示了如何执行此作:
@Bean
public KafkaListenerContainerFactory<?> kafkaJsonListenerContainerFactory() {
ConcurrentKafkaListenerContainerFactory<Integer, String> factory =
new ConcurrentKafkaListenerContainerFactory<>();
factory.setConsumerFactory(consumerFactory());
factory.setRecordMessageConverter(new JsonMessageConverter());
return factory;
}
...
@KafkaListener(topics = "jsonData",
containerFactory = "kafkaJsonListenerContainerFactory")
public void jsonListener(Cat cat) {
...
}
使用 Spring Boot 时,只需将转换器定义为@Bean
Spring Boot 自动配置会将其连接到自动配置的模板和容器工厂中。
当您使用@KafkaListener
,则参数类型将提供给消息转换器以协助进行转换。
只有当 |
在消费者端,您可以配置 在生产者端,当您使用 Spring Integration 或
同样,使用 为方便起见,从版本 2.3 开始,框架还提供了一个 |
从版本 2.7.1 开始,可以将消息有效负载转换委托给spring-messaging
SmartMessageConverter
;例如,这使得转换可以基于MessageHeaders.CONTENT_TYPE
页眉。
这KafkaMessageConverter.fromMessage() 方法将出站转化转换为ProducerRecord 将消息负载设在ProducerRecord.value() 财产。
这KafkaMessageConverter.toMessage() method 用于入站转化ConsumerRecord 其中 payload 是ConsumerRecord.value() 财产。
这SmartMessageConverter.toMessage() method 创建新的出站Message<?> 从Message 传递给fromMessage() (通常通过KafkaTemplate.send(Message<?> msg) ).
同样,在KafkaMessageConverter.toMessage() 方法,在转换器创建新的Message<?> 从ConsumerRecord 这SmartMessageConverter.fromMessage() 方法,然后使用新转换的有效负载创建最终入站消息。
在任何一种情况下,如果SmartMessageConverter 返回null ,则使用原始消息。 |
当在KafkaTemplate
和 Listener Container Factory 中,您可以配置SmartMessageConverter
通过调用setMessagingConverter()
在模板上,通过contentTypeConverter
属性@KafkaListener
方法。
例子:
template.setMessagingConverter(mySmartConverter);
@KafkaListener(id = "withSmartConverter", topics = "someTopic",
contentTypeConverter = "mySmartConverter")
public void smart(Thing thing) {
...
}
使用 Spring Data Projection 接口
从版本 2.1.1 开始,你可以将 JSON 转换为 Spring Data Projection 接口,而不是具体类型。 这允许对数据进行非常有选择性的低耦合绑定,包括从 JSON 文档中的多个位置查找值。 例如,可以将以下接口定义为消息有效负载类型:
interface SomeSample {
@JsonPath({ "$.username", "$.user.name" })
String getUsername();
}
@KafkaListener(id="projection.listener", topics = "projection")
public void projection(SomeSample in) {
String username = in.getUsername();
...
}
默认情况下,将使用访问器方法在接收到的 JSON 文档中查找属性名称作为字段。
这@JsonPath
expression 允许自定义值查找,甚至定义多个 JSON 路径表达式,以便从多个位置查找值,直到表达式返回实际值。
要启用此功能,请使用ProjectingMessageConverter
配置了适当的委托转换器(用于出站转换和转换非投影接口)。
您还必须添加spring-data:spring-data-commons
和com.jayway.jsonpath:json-path
添加到 Classpath 中。
当用作@KafkaListener
方法,接口类型会像往常一样自动传递给转换器。
用ErrorHandlingDeserializer
当反序列化器无法反序列化消息时, Spring 无法处理该问题,因为它发生在poll()
返回。
为了解决这个问题,ErrorHandlingDeserializer
已引入。
此 deserializer 委托给真正的 deserializer (key 或 value)。
如果委托无法反序列化记录内容,则ErrorHandlingDeserializer
返回null
value 和DeserializationException
在包含 Cause 和 Raw 字节的标头中。
当您使用记录级别的MessageListener
,如果ConsumerRecord
包含一个DeserializationException
标头中,容器的ErrorHandler
调用失败的ConsumerRecord
.
记录不会传递给侦听器。
或者,您也可以配置ErrorHandlingDeserializer
要通过提供failedDeserializationFunction
,它是一个Function<FailedDeserializationInfo, T>
.
调用此函数以创建T
,它以通常的方式传递给侦听器。
类型为FailedDeserializationInfo
,其中包含所有上下文信息。
您可以找到DeserializationException
(作为序列化的 Java 对象)在 Headers 中。
请参阅 Javadoc 以获取ErrorHandlingDeserializer
了解更多信息。
您可以使用DefaultKafkaConsumerFactory
接受 key 和 value 的构造函数Deserializer
对象和连线ErrorHandlingDeserializer
实例。
或者,您可以使用使用者配置属性(由ErrorHandlingDeserializer
) 实例化委托。
属性名称包括ErrorHandlingDeserializer.KEY_DESERIALIZER_CLASS
和ErrorHandlingDeserializer.VALUE_DESERIALIZER_CLASS
.
属性值可以是类或类名。
以下示例显示如何设置这些属性:
... // other props
props.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, ErrorHandlingDeserializer.class);
props.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, ErrorHandlingDeserializer.class);
props.put(ErrorHandlingDeserializer.KEY_DESERIALIZER_CLASS, JsonDeserializer.class);
props.put(JsonDeserializer.KEY_DEFAULT_TYPE, "com.example.MyKey")
props.put(ErrorHandlingDeserializer.VALUE_DESERIALIZER_CLASS, JsonDeserializer.class.getName());
props.put(JsonDeserializer.VALUE_DEFAULT_TYPE, "com.example.MyValue")
props.put(JsonDeserializer.TRUSTED_PACKAGES, "com.example")
return new DefaultKafkaConsumerFactory<>(props);
以下示例使用failedDeserializationFunction
.
public class BadThing extends Thing {
private final FailedDeserializationInfo failedDeserializationInfo;
public BadThing(FailedDeserializationInfo failedDeserializationInfo) {
this.failedDeserializationInfo = failedDeserializationInfo;
}
public FailedDeserializationInfo getFailedDeserializationInfo() {
return this.failedDeserializationInfo;
}
}
public class FailedThingProvider implements Function<FailedDeserializationInfo, Thing> {
@Override
public Thing apply(FailedDeserializationInfo info) {
return new BadThing(info);
}
}
前面的示例使用以下配置:
...
consumerProps.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, ErrorHandlingDeserializer.class);
consumerProps.put(ErrorHandlingDeserializer.VALUE_DESERIALIZER_CLASS, JsonDeserializer.class);
consumerProps.put(ErrorHandlingDeserializer.VALUE_FUNCTION, FailedThingProvider.class);
...
如果使用者配置了ErrorHandlingDeserializer ,配置KafkaTemplate 及其 producer 及其序列化器,该序列化器可以处理普通对象和原始对象byte[] 值,这是由反序列化异常引起的。
模板的 generic value type 应为Object .
一种方法是使用DelegatingByTypeSerializer ;示例如下: |
@Bean
public ProducerFactory<String, Object> producerFactory() {
return new DefaultKafkaProducerFactory<>(producerConfiguration(), new StringSerializer(),
new DelegatingByTypeSerializer(Map.of(byte[].class, new ByteArraySerializer(),
MyNormalObject.class, new JsonSerializer<Object>())));
}
@Bean
public KafkaTemplate<String, Object> kafkaTemplate() {
return new KafkaTemplate<>(producerFactory());
}
当使用ErrorHandlingDeserializer
使用批处理侦听器时,必须检查消息标头中的反序列化异常。
当与DefaultBatchErrorHandler
,您可以使用该标头来确定异常失败的记录,并通过BatchListenerFailedException
.
@KafkaListener(id = "test", topics = "test")
void listen(List<Thing> in, @Header(KafkaHeaders.BATCH_CONVERTED_HEADERS) List<Map<String, Object>> headers) {
for (int i = 0; i < in.size(); i++) {
Thing thing = in.get(i);
if (thing == null
&& headers.get(i).get(SerializationUtils.VALUE_DESERIALIZER_EXCEPTION_HEADER) != null) {
try {
DeserializationException deserEx = SerializationUtils.byteArrayToDeserializationException(this.logger,
headers.get(i).get(SerializationUtils.VALUE_DESERIALIZER_EXCEPTION_HEADER));
if (deserEx != null) {
logger.error(deserEx, "Record at index " + i + " could not be deserialized");
}
}
catch (Exception ex) {
logger.error(ex, "Record at index " + i + " could not be deserialized");
}
throw new BatchListenerFailedException("Deserialization", deserEx, i);
}
process(thing);
}
}
SerializationUtils.byteArrayToDeserializationException()
可用于将标头转换为DeserializationException
.
消费List<ConsumerRecord<?, ?>
,SerializationUtils.getExceptionFromHeader()
替换为:
@KafkaListener(id = "kgh2036", topics = "kgh2036")
void listen(List<ConsumerRecord<String, Thing>> in) {
for (int i = 0; i < in.size(); i++) {
ConsumerRecord<String, Thing> rec = in.get(i);
if (rec.value() == null) {
DeserializationException deserEx = SerializationUtils.getExceptionFromHeader(rec,
SerializationUtils.VALUE_DESERIALIZER_EXCEPTION_HEADER, this.logger);
if (deserEx != null) {
logger.error(deserEx, "Record at offset " + rec.offset() + " could not be deserialized");
throw new BatchListenerFailedException("Deserialization", deserEx, i);
}
}
process(rec.value());
}
}
如果您还使用DeadLetterPublishingRecoverer ,则为DeserializationException 将具有record.value() 的类型byte[] ;这不应该被序列化。
考虑使用DelegatingByTypeSerializer 配置为使用ByteArraySerializer 为byte[] 以及所有其他类型的普通序列化程序(Json、Avro 等)。 |
从版本 3.1 开始,您可以添加Validator
到ErrorHandlingDeserializer
.
如果委托Deserializer
成功反序列化对象,但该对象未通过验证,则会引发异常,类似于发生的反序列化异常。
这允许将原始原始数据传递给错误处理程序。
当自己创建反序列化器时,只需调用setValidator
;如果使用 properties 配置序列化器,请将 Consumer Configuration 属性ErrorHandlingDeserializer.VALIDATOR_CLASS
更改为 class 或完全限定的类名Validator
.
使用 Spring Boot 时,此属性名称为spring.kafka.consumer.properties.spring.deserializer.validator.class
.
使用批量侦听器进行有效负载转换
您还可以使用JsonMessageConverter
在BatchMessagingMessageConverter
在使用 Batch Listener Container Factory 时转换 Batch 消息。
有关更多信息,请参见序列化、反序列化和消息转换和 Spring 消息传递消息转换。
默认情况下,转换的类型是从 listener 参数推断的。
如果配置JsonMessageConverter
替换为DefaultJackson2TypeMapper
它有它的TypePrecedence
设置为TYPE_ID
(而不是默认的INFERRED
),则转换器会改用 Headers 中的 type 信息(如果存在)。
例如,这允许使用接口而不是具体类来声明侦听器方法。
此外,类型转换器支持映射,因此反序列化可以是与源不同的类型(只要数据兼容)。
当您使用类级别@KafkaListener
实例其中,有效负载必须已转换,以确定要调用的方法。
下面的示例创建使用此方法的 bean:
@Bean
public KafkaListenerContainerFactory<?> kafkaListenerContainerFactory() {
ConcurrentKafkaListenerContainerFactory<Integer, String> factory =
new ConcurrentKafkaListenerContainerFactory<>();
factory.setConsumerFactory(consumerFactory());
factory.setBatchListener(true);
factory.setBatchMessageConverter(new BatchMessagingMessageConverter(converter()));
return factory;
}
@Bean
public JsonMessageConverter converter() {
return new JsonMessageConverter();
}
请注意,要使其正常工作,转换目标的方法签名必须是具有单个泛型参数类型的容器对象,如下所示:
@KafkaListener(topics = "blc1")
public void listen(List<Foo> foos, @Header(KafkaHeaders.OFFSET) List<Long> offsets) {
...
}
请注意,您仍然可以访问批处理标头。
如果批处理转换器具有支持它的记录转换器,则您还可以接收一个消息列表,其中的有效负载根据泛型类型进行转换。 以下示例显示了如何执行此作:
@KafkaListener(topics = "blc3", groupId = "blc3")
public void listen(List<Message<Foo>> fooMessages) {
...
}
如果无法转换批处理中的记录,则其有效负载设置为null
进入目标payloads
列表。
转换异常将记录为此记录的警告,并存储在KafkaHeaders.CONVERSION_FAILURES
header 作为List<ConversionException>
.
目标@KafkaListener
方法可以执行 JavaStream
用于过滤掉这些null
值,或者对 conversion exceptions 标头执行一些作:
@KafkaListener(id = "foo", topics = "foo", autoStartup = "false")
public void listen(List<Foo> list,
@Header(KafkaHeaders.CONVERSION_FAILURES) List<ConversionException> conversionFailures) {
for (int i = 0; i < list.size(); i++) {
if (conversionFailures.get(i) != null) {
throw new BatchListenerFailedException("Conversion Failed", conversionFailures.get(i), i);
}
}
}
ConversionService
定制
从版本 2.1.1 开始,org.springframework.core.convert.ConversionService
默认使用org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory
为了解析用于调用侦听器方法的参数,所有实现以下任何接口的 bean 都提供了该方法:
-
org.springframework.core.convert.converter.Converter
-
org.springframework.core.convert.converter.GenericConverter
-
org.springframework.format.Formatter
这使您可以进一步自定义侦听器反序列化,而无需更改ConsumerFactory
和KafkaListenerContainerFactory
.
设置自定义MessageHandlerMethodFactory 在KafkaListenerEndpointRegistrar 通过KafkaListenerConfigurer Bean 禁用此功能。 |
添加自定义HandlerMethodArgumentResolver
自@KafkaListener
从版本 2.4.2 开始,您可以添加自己的HandlerMethodArgumentResolver
并解析自定义方法参数。
您只需实施KafkaListenerConfigurer
和使用方法setCustomMethodArgumentResolvers()
来自类KafkaListenerEndpointRegistrar
.
@Configuration
class CustomKafkaConfig implements KafkaListenerConfigurer {
@Override
public void configureKafkaListeners(KafkaListenerEndpointRegistrar registrar) {
registrar.setCustomMethodArgumentResolvers(
new HandlerMethodArgumentResolver() {
@Override
public boolean supportsParameter(MethodParameter parameter) {
return CustomMethodArgument.class.isAssignableFrom(parameter.getParameterType());
}
@Override
public Object resolveArgument(MethodParameter parameter, Message<?> message) {
return new CustomMethodArgument(
message.getHeaders().get(KafkaHeaders.RECEIVED_TOPIC, String.class)
);
}
}
);
}
}
您还可以通过添加自定义MessageHandlerMethodFactory
到KafkaListenerEndpointRegistrar
豆。
如果您执行此作,并且您的应用程序需要处理逻辑删除记录,则使用null
value()
(例如,来自压缩的主题),您应该添加一个KafkaNullAwarePayloadArgumentResolver
到工厂;它必须是最后一个解析器,因为它支持所有类型,并且可以匹配没有@Payload
注解。
如果您使用的是DefaultMessageHandlerMethodFactory
,将此解析程序设置为最后一个自定义解析程序;工厂将确保此解析器在标准PayloadMethodArgumentResolver
,它不知道KafkaNull
负载。