序列化、反序列化和消息转换

概述

Apache Kafka 提供了一个高级 API 用于序列化和反序列化记录值以及它们的键。它与 org.apache.kafka.common.serialization.Serializer<T>org.apache.kafka.common.serialization.Deserializer<T> 抽象一起出现,并提供了一些内置实现。同时,我们可以使用 ProducerConsumer 配置属性来指定序列化器和反序列化器类。以下示例展示了如何做到这一点

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)提供了重载的构造函数来接受 SerializerDeserializer 实例,分别用于 keysvalues

当您使用此 API 时,DefaultKafkaProducerFactoryDefaultKafkaConsumerFactory 还提供属性(通过构造函数或 setter 方法)将自定义 SerializerDeserializer 实例注入到目标 ProducerConsumer 中。此外,您还可以通过构造函数传入 Supplier<Serializer>Supplier<Deserializer> 实例 - 这些 Supplier 在创建每个 ProducerConsumer 时被调用。

字符串序列化

从 2.5 版本开始,Spring for Apache Kafka 提供了 ToStringSerializerParseStringDeserializer 类,它们使用实体的字符串表示形式。它们依赖于方法 toString 和一些 Function<String>BiFunction<String, Headers> 来解析字符串并填充实例的属性。通常,这将调用类上的某些静态方法,例如 parse

ToStringSerializer<Thing> thingSerializer = new ToStringSerializer<>();
//...
ParseStringDeserializer<Thing> deserializer = new ParseStringDeserializer<>(Thing::parse);

默认情况下,ToStringSerializer 被配置为在记录 Headers 中传递关于序列化实体的类型信息。您可以通过将 addTypeInfo 属性设置为 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[] 或从 byte[] 转换回 String 的字符集,默认值为 UTF-8

您可以使用 ConsumerConfig 属性配置反序列化器,指定解析器方法的名称。

  • ParseStringDeserializer.KEY_PARSER

  • ParseStringDeserializer.VALUE_PARSER

这些属性必须包含类的完全限定名称,后跟方法名称,用句点 . 分隔。该方法必须是静态方法,并且签名必须为 (String, Headers)(String)

还提供了一个 ToFromStringSerde,用于与 Kafka Streams 一起使用。

JSON

Spring for Apache Kafka 还提供了基于 Jackson JSON 对象映射器的 JsonSerializerJsonDeserializer 实现。JsonSerializer 允许将任何 Java 对象写入 JSON byte[]JsonDeserializer 需要一个额外的 Class<?> targetType 参数,以允许将消耗的 byte[] 反序列化为正确的目标对象。以下示例展示了如何创建一个 JsonDeserializer

JsonDeserializer<Thing> thingDeserializer = new JsonDeserializer<>(Thing.class);

您可以使用 ObjectMapper 自定义 JsonSerializerJsonDeserializer。您还可以扩展它们,在 configure(Map<String, ?> configs, boolean isKey) 方法中实现一些特定的配置逻辑。

从 2.3 版本开始,所有 JSON 感知组件默认配置为使用 JacksonUtils.enhancedObjectMapper() 实例,该实例禁用了 MapperFeature.DEFAULT_VIEW_INCLUSIONDeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES 功能。此外,该实例还提供了一些用于自定义数据类型的知名模块,例如 Java 时间和 Kotlin 支持。有关更多信息,请参阅 JacksonUtils.enhancedObjectMapper() JavaDocs。此方法还注册了一个 org.springframework.kafka.support.JacksonMimeTypeModule,用于将 org.springframework.util.MimeType 对象序列化为纯字符串,以便在网络上实现跨平台兼容性。JacksonMimeTypeModule 可以作为 bean 注册到应用程序上下文,它将被自动配置到 Spring Boot ObjectMapper 实例 中。

从 2.3 版本开始,JsonDeserializer 还提供了基于 TypeReference 的构造函数,以便更好地处理目标泛型容器类型。

从 2.1 版本开始,您可以在 Headers 记录中传递类型信息,从而允许处理多种类型。此外,您可以使用以下 Kafka 属性配置序列化器和反序列化器。如果您分别为 KafkaConsumerKafkaProducer 提供了 SerializerDeserializer 实例,则这些属性无效。

配置属性

  • 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.utiljava.lang):允许反序列化的包模式的逗号分隔列表。* 表示反序列化所有。

  • JsonDeserializer.TYPE_MAPPINGS(默认值为 empty):请参阅 映射类型

  • JsonDeserializer.KEY_TYPE_METHOD(默认值为 empty):请参阅 使用方法确定类型

  • JsonDeserializer.VALUE_TYPE_METHOD(默认值为 empty):请参阅 使用方法确定类型

从 2.2 版本开始,反序列化器会移除类型信息标头(如果由序列化器添加)。您可以通过将 removeTypeHeaders 属性设置为 false 来恢复到之前的行为,无论是在反序列化器上直接设置还是使用前面描述的配置属性。

从 2.8 版本开始,如果您按照 程序化构建 中所示的方式以编程方式构建序列化器或反序列化器,只要您没有显式设置任何属性(使用 set*() 方法或使用流畅的 API),工厂就会应用上述属性。以前,在以编程方式创建时,配置属性永远不会应用;如果您直接在对象上显式设置属性,情况仍然如此。

映射类型

从 2.2 版本开始,在使用 JSON 时,您现在可以使用前面列表中的属性提供类型映射。以前,您必须在序列化器和反序列化器中自定义类型映射器。映射由以逗号分隔的 token:className 对列表组成。在传出时,有效负载的类名将映射到相应的令牌。在传入时,类型标头中的令牌将映射到相应的类名。

以下示例创建一组映射

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

您只能使用属性执行简单的配置。对于更高级的配置(例如在序列化器和反序列化器中使用自定义 ObjectMapper),您应该使用接受预构建序列化器和反序列化器的生产者和消费者工厂构造函数。以下 Spring Boot 示例覆盖了默认工厂

@Bean
public ConsumerFactory<?, ?> kafkaConsumerFactory(JsonDeserializer customValueDeserializer) {
    Map<String, Object> properties = new HashMap<>();
    // properties.put(..., ...)
    // ...
    return new DefaultKafkaConsumerFactory<>(properties,
        new StringDeserializer(), customValueDeserializer);
}

@Bean
public ProducerFactory<?, ?> kafkaProducerFactory(JsonSerializer customValueSerializer) {
    return new DefaultKafkaProducerFactory<>(properties.buildProducerProperties(),
        new StringSerializer(), customValueSerializer);
}

还提供了设置器,作为使用这些构造函数的替代方法。

在使用 Spring Boot 并覆盖 ConsumerFactoryProducerFactory(如上所示)时,需要将通配符泛型类型与 bean 方法返回类型一起使用。如果提供具体的泛型类型,则 Spring Boot 将忽略这些 bean 并且仍然使用默认 bean。

从 2.2 版本开始,您可以通过使用具有布尔型 useHeadersIfPresent 参数(默认值为 true)的重载构造函数之一,显式配置反序列化器以使用提供的目标类型并忽略标头中的类型信息。以下示例展示了如何做到这一点

DefaultKafkaConsumerFactory<Integer, Cat1> cf = new DefaultKafkaConsumerFactory<>(props,
        new IntegerDeserializer(), new JsonDeserializer<>(Cat1.class, false));

使用方法确定类型

从 2.5 版本开始,您现在可以通过属性配置反序列化器,以调用方法来确定目标类型。如果存在,这将覆盖上面讨论的任何其他技术。如果数据由不使用 Spring 序列化器的应用程序发布,并且您需要根据数据或其他标头将数据反序列化为不同的类型,这将非常有用。将这些属性设置为方法名称 - 全限定类名后跟方法名称,用句点 . 分隔。该方法必须声明为 public static,具有以下三种签名之一 (String topic, byte[] data, Headers headers)(byte[] data, Headers headers)(byte[] data),并返回 Jackson JavaType

  • 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或类似方法,但确定类型的测试越简单,过程效率就越高。

以下是以编程方式创建反序列化器(在构造函数中向消费者工厂提供反序列化器时)的示例。

JsonDeserializer<Object> deser = new JsonDeserializer<>()
        .trustedPackages("*")
        .typeResolver(SomeClass::thing1Thing2JavaTypeForTopic);

...

public static JavaType thing1Thing2JavaTypeForTopic(String topic, byte[] data, Headers headers) {
    ...
}

编程构造

从 2.3 版开始,在以编程方式构造序列化器/反序列化器以供生产者/消费者工厂使用时,您可以使用流畅的 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);

或者,只要您不使用流畅的 API 来配置属性,或不使用set*()方法设置属性,工厂就会使用配置属性来配置序列化器/反序列化器;请参阅配置属性

委托序列化器和反序列化器

使用标题

2.3 版引入了DelegatingSerializerDelegatingDeserializer,它们允许使用不同的键和/或值类型来生成和使用记录。生产者必须将标题DelegatingSerializer.VALUE_SERIALIZATION_SELECTOR设置为选择器值,该值用于选择用于值的序列化器,并将DelegatingSerializer.KEY_SERIALIZATION_SELECTOR设置为键;如果找不到匹配项,则会抛出IllegalStateException

对于传入的记录,反序列化器使用相同的标题来选择要使用的反序列化器;如果找不到匹配项或标题不存在,则返回原始byte[]

您可以通过构造函数配置选择器到Serializer/Deserializer的映射,也可以通过 Kafka 生产者/消费者属性使用键DelegatingSerializer.VALUE_SERIALIZATION_SELECTOR_CONFIGDelegatingSerializer.KEY_SERIALIZATION_SELECTOR_CONFIG来配置它。对于序列化器,生产者属性可以是Map<String, Object>,其中键是选择器,值是Serializer实例、序列化器Class或类名。该属性也可以是逗号分隔的映射条目的字符串,如下所示。

对于反序列化器,消费者属性可以是Map<String, Object>,其中键是选择器,值是Deserializer实例、反序列化器Class或类名。该属性也可以是逗号分隔的映射条目的字符串,如下所示。

要使用属性进行配置,请使用以下语法

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 头设置为 thing1thing2

此技术支持将不同类型发送到同一个主题(或不同的主题)。

从 2.5.1 版本开始,如果类型(键或值)是 Serdes 支持的标准类型之一(LongInteger 等),则无需设置选择器头。相反,序列化器会将头设置为类型的类名。无需为这些类型配置序列化器或反序列化器,它们将被动态创建(一次)。

有关将不同类型发送到不同主题的另一种技术,请参阅 使用 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,例如 LinkedHashMap

按主题

从 2.8 版本开始,DelegatingByTopicSerializerDelegatingByTopicDeserializer 允许根据主题名称选择序列化器/反序列化器。正则表达式 Pattern 用于查找要使用的实例。可以使用构造函数或通过属性(以逗号分隔的 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_DEFAULTDelegatingByTopicSerialization.VALUE_SERIALIZATION_TOPIC_DEFAULT

另一个属性 DelegatingByTopicSerialization.CASE_SENSITIVE(默认值为 true),当设置为 false 时,会使主题查找不区分大小写。

重试反序列化器

RetryingDeserializer 使用委托 DeserializerRetryTemplate 在委托可能在反序列化期间出现瞬态错误(例如网络问题)时重试反序列化。

ConsumerFactory cf = new DefaultKafkaConsumerFactory(myConsumerConfigs,
    new RetryingDeserializer(myUnreliableKeyDeserializer, retryTemplate),
    new RetryingDeserializer(myUnreliableValueDeserializer, retryTemplate));

3.1.2 版本开始,可以在 RetryingDeserializer 上可选地设置 RecoveryCallback

有关使用重试策略、回退策略等配置 RetryTemplate 的信息,请参阅 spring-retry 项目。

Spring 消息转换

虽然 SerializerDeserializer API 从低级 Kafka ConsumerProducer 的角度来看非常简单灵活,但在使用 @KafkaListenerSpring Integration 的 Apache Kafka 支持 时,您可能需要在 Spring Messaging 级别获得更多灵活性。为了让您轻松地进行 org.springframework.messaging.Message 的转换,Spring for Apache Kafka 提供了一个 MessageConverter 抽象,以及 MessagingMessageConverter 实现及其 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 时,参数类型将提供给消息转换器以帮助进行转换。

这种类型推断只有在 @KafkaListener 注释在方法级别声明时才能实现。使用类级别的 @KafkaListener 时,有效载荷类型用于选择要调用的 @KafkaHandler 方法,因此它必须在选择方法之前完成转换。

在消费者端,您可以配置一个 JsonMessageConverter;它可以处理类型为 byte[]BytesStringConsumerRecord 值,因此应与 ByteArrayDeserializerBytesDeserializerStringDeserializer 结合使用。(byte[]Bytes 更有效率,因为它们避免了不必要的 byte[]String 的转换)。如果您愿意,还可以配置与反序列化器相对应的 JsonMessageConverter 的特定子类。

在生产者端,当您使用 Spring Integration 或 KafkaTemplate.send(Message<?> message) 方法(请参阅 使用 KafkaTemplate)时,您必须配置一个与已配置的 Kafka Serializer 兼容的消息转换器。

  • StringJsonMessageConverterStringSerializer

  • BytesJsonMessageConverterBytesSerializer

  • ByteArrayJsonMessageConverterByteArraySerializer

再次,使用 byte[]Bytes 更有效率,因为它们避免了 Stringbyte[] 的转换。

为了方便起见,从 2.3 版本开始,框架还提供了一个 StringOrBytesSerializer,它可以序列化所有三种值类型,因此它可以与任何消息转换器一起使用。

从 2.7.1 版本开始,消息有效负载转换可以委托给 spring-messaging SmartMessageConverter;这使得转换可以基于 MessageHeaders.CONTENT_TYPE 标头,例如。

KafkaMessageConverter.fromMessage() 方法用于传出转换为 ProducerRecord,消息有效负载位于 ProducerRecord.value() 属性中。KafkaMessageConverter.toMessage() 方法用于从 ConsumerRecord 进行传入转换,有效负载为 ConsumerRecord.value() 属性。SmartMessageConverter.toMessage() 方法用于从传递给 fromMessage()Message 创建新的传出 Message<?>(通常由 KafkaTemplate.send(Message<?> msg))。类似地,在 KafkaMessageConverter.toMessage() 方法中,在转换器从 ConsumerRecord 创建新的 Message<?> 后,会调用 SmartMessageConverter.fromMessage() 方法,然后使用新转换的有效负载创建最终的传入消息。在这两种情况下,如果 SmartMessageConverter 返回 null,则使用原始消息。

当在 KafkaTemplate 和监听器容器工厂中使用默认转换器时,您可以通过在模板上调用 setMessagingConverter() 以及通过 @KafkaListener 方法上的 contentTypeConverter 属性来配置 SmartMessageConverter

示例

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 表达式允许自定义值查找,甚至可以定义多个 JSON Path 表达式,从多个地方查找值,直到表达式返回实际值。

要启用此功能,请使用配置了适当的委托转换器(用于出站转换和转换非投影接口)的 ProjectingMessageConverter。您还必须将 spring-data:spring-data-commonscom.jayway.jsonpath:json-path 添加到类路径。

当用作 @KafkaListener 方法的参数时,接口类型会像往常一样自动传递给转换器。

使用 ErrorHandlingDeserializer

当反序列化器无法反序列化消息时,Spring 无法处理该问题,因为它发生在 poll() 返回之前。为了解决这个问题,引入了 ErrorHandlingDeserializer。此反序列化器委托给一个真正的反序列化器(键或值)。如果委托无法反序列化记录内容,ErrorHandlingDeserializer 将返回一个 null 值和一个 DeserializationException,该异常位于包含原因和原始字节的标头中。当您使用记录级 MessageListener 时,如果 ConsumerRecord 包含键或值的 DeserializationException 标头,则容器的 ErrorHandler 将使用失败的 ConsumerRecord 调用。记录不会传递给侦听器。

或者,您可以配置 `ErrorHandlingDeserializer` 以通过提供一个 `failedDeserializationFunction` 来创建自定义值,该函数是一个 `Function`。此函数被调用以创建 `T` 的实例,该实例以通常的方式传递给监听器。一个包含所有上下文信息的 `FailedDeserializationInfo` 类型对象将被提供给该函数。您可以在标题中找到 `DeserializationException`(作为序列化后的 Java 对象)。有关 `ErrorHandlingDeserializer` 的更多信息,请参阅 Javadoc

您可以使用 `DefaultKafkaConsumerFactory` 构造函数,该构造函数接受键和值 `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`,则必须使用可以处理普通对象以及来自反序列化异常的原始 `byte[]` 值的序列化器来配置 `KafkaTemplate` 及其生产者。模板的泛型值类型应为 `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>` 时,使用 `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,将其配置为对 byte[] 使用 ByteArraySerializer,而对所有其他类型使用普通序列化器(JSON、Avro 等)。

从 3.1 版本开始,您可以向 ErrorHandlingDeserializer 添加 Validator。如果委托 Deserializer 成功反序列化对象,但该对象验证失败,则会抛出异常,类似于发生反序列化异常。这允许将原始原始数据传递给错误处理程序。当您自己创建反序列化器时,只需调用 setValidator;如果您使用属性配置序列化器,请将使用者配置属性 ErrorHandlingDeserializer.VALIDATOR_CLASS 设置为您的 Validator 的类或完全限定类名。使用 Spring Boot 时,此属性名称为 spring.kafka.consumer.properties.spring.deserializer.validator.class

使用批处理监听器的有效负载转换

您还可以在 BatchMessagingMessageConverter 中使用 JsonMessageConverter 来转换批处理消息,当您使用批处理监听器容器工厂时。有关更多信息,请参阅 序列化、反序列化和消息转换Spring 消息传递消息转换

默认情况下,转换类型是从监听器参数推断出来的。如果您使用 DefaultJackson2TypeMapper 配置 JsonMessageConverter,该映射器将其 TypePrecedence 设置为 TYPE_ID(而不是默认的 INFERRED),则转换器使用标头中的类型信息(如果存在)。例如,这允许监听器方法使用接口而不是具体类来声明。此外,类型转换器支持映射,因此反序列化可以是与源类型不同的类型(只要数据兼容)。当您使用 类级 @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) {
    ...
}

ConversionService 自定义

从 2.1.1 版本开始,默认的 org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory 使用的 org.springframework.core.convert.ConversionService 来解析监听器方法调用参数,它会提供所有实现以下任何接口的 bean:

  • org.springframework.core.convert.converter.Converter

  • org.springframework.core.convert.converter.GenericConverter

  • org.springframework.format.Formatter

这使您无需更改 ConsumerFactoryKafkaListenerContainerFactory 的默认配置,即可进一步自定义监听器反序列化。

通过 KafkaListenerConfigurer bean 在 KafkaListenerEndpointRegistrar 上设置自定义 MessageHandlerMethodFactory 会禁用此功能。

@KafkaListener 中添加自定义 HandlerMethodArgumentResolver

从 2.4.2 版本开始,您可以添加自己的 HandlerMethodArgumentResolver 来解析自定义方法参数。您只需要实现 KafkaListenerConfigurer 并使用 KafkaListenerEndpointRegistrar 类中的 setCustomMethodArgumentResolvers() 方法即可。

@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)
                    );
                }
            }
        );
    }

}

您还可以通过向 KafkaListenerEndpointRegistrar bean 添加自定义 MessageHandlerMethodFactory 来完全替换框架的参数解析。如果您这样做,并且您的应用程序需要处理带有 null value() 的墓碑记录(例如来自压缩主题),您应该向工厂添加一个 KafkaNullAwarePayloadArgumentResolver;它必须是最后一个解析器,因为它支持所有类型,并且可以匹配没有 @Payload 注释的参数。如果您使用的是 DefaultMessageHandlerMethodFactory,请将此解析器设置为最后一个自定义解析器;工厂将确保在标准 PayloadMethodArgumentResolver 之前使用此解析器,而标准 PayloadMethodArgumentResolver 不了解 KafkaNull 负载。