Conditional (content-based) routing on Kafka headers in Spring Cloud Stream

Question

I'm using Spring Cloud Stream 3.x in Spring Boot 2.x application to consume messages from a Kafka topic.

I want to have a listener that consumes messages conditionally on some custom header value, as per doc:

@StreamListener(value = "someTopic", condition = "headers['SomeHeader']=='SomeHeaderValue'")
public void onMessage(Message<?> message) {
  LOGGER.info("Received: {}", message);
}

However listener never gets notified, and if condition is removed I see the following in the log:

Received: ... SomeHeader: [B@1055e4af ...

It turns out that custom headers are left in Kafka byte array raw format, making them not eligible for condition evaluation.

Is some additional configuration needed or am I missing something?

Oleg Efimov Oleg Efimov · Accepted Answer · 2020-12-17T08:19:17

After some digging in sources and stackoveflow I have found the following:

Spring Cloud Stream delegates to Spring Kafka message and headers conversion (KafkaMessageChannelBinder ~ getHeaderMapper)
Headers are left in raw format by default headers conversion implementation (BinderHeaderMapper)
Spring Cloud Stream allows customization of headers mapping and particularly conversion of headers from byte array to String (How can I map incoming headers as String instead of byte[] in my Spring Cloud Stream project?)

So I added my custom header mapper bean (bean name is important, it allows to omit additional configuration property), which maps my custom header to String:

@Bean
public KafkaHeaderMapper kafkaBinderHeaderMapper() {
    SimpleKafkaHeaderMapper headerMapper = new SimpleKafkaHeaderMapper();
    headerMapper.setRawMappedHeaders(Map.of(
        "SomeHeader", true
    ));
    return headerMapper;
}

That fixed the problem:

Received: ... SomeHeader: SomeHeaderValue ...

P.S. It seems like a bug in Spring Cloud Stream:

It introduces its own implementation of header mapper (BinderHeaderMapper), but the latter doesn't respect conditional routing feature.
Header mapper is subclassed in KafkaMessageChannelBinder, this added behaviour is non-obvious and will be lost if custom header mapper is provided.

Conditional (content-based) routing on Kafka headers in Spring Cloud Stream

1 Answers