Skip to content

Commit 4a762bd

Browse files
Add docs for new feature
Signed-off-by: Sanghyeok An <ojt90902@naver.com>
1 parent c9c360e commit 4a762bd

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

spring-kafka-docs/src/main/antora/modules/ROOT/pages/kafka/headers.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,3 +179,27 @@ MessagingMessageConverter converter() {
179179

180180
If using Spring Boot, it will auto configure this converter bean into the auto-configured `KafkaTemplate`; otherwise you should add this converter to the template.
181181

182+
[[multi-value-header]]
183+
== Support multi-value header
184+
185+
Spring for Apache Kafka 4.0 supports multi-value header.
186+
To use multi-value header, the patterns for multi-value should be configured to `HeaderMapper`.
187+
If no patterns are configured to `HeaderMapper`, iterable header values under same header name will be handled like single value.
188+
189+
If there are use cases in which multi-value headers are required, use this:
190+
191+
[source, java]
192+
----
193+
@Bean
194+
public void KafkaListenerContainerFactory<Integer, String> containerFactory() {
195+
ConcurrentKafkaListenerContainerFactory<Integer, String> factory =
196+
new ConcurrentKafkaListenerContainerFactory<>();
197+
198+
DefaultKafkaHeaderMapper headerMapper = new DefaultKafkaHeaderMapper();
199+
headerMapper.setMultiValueHeaderPatterns("test-multi-value1", "test-multi-value2");
200+
201+
MessagingMessageConverter converter = new MessagingMessageConverter(headerMapper);
202+
factory.setRecordMessageConverter(converter);
203+
return factory;
204+
}
205+
----

spring-kafka-docs/src/main/antora/modules/ROOT/pages/whats-new.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,9 @@ Several deprecated items have been removed:
7070

7171
Spring for Apache Kafka 4.0 supports Kafka 4.0’s new consumer rebalance protocol - https://cwiki.apache.org/confluence/display/KAFKA/KIP-848%3A+The+Next+Generation+of+the+Consumer+Rebalance+Protocol[KIP-848].
7272
For details, see xref:kafka/receiving-messages/rebalance-listeners.adoc#new-rebalalcne-protocol[New Consumer Rebalace Protocol docs].
73+
74+
[[x40-multi-value-header]]
75+
=== Support multi-value header
76+
77+
Spring for Apache Kafka 4.0 supports multi-value header for Kafka Record.
78+
For details, see xref:kafka/headers.adoc#multi-value-header[Support multi-value header].

0 commit comments

Comments
 (0)