Spring for Apache Kafka


Gary Russell , Artem Bilan , Biju Kunjummen


Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.

Table of Contents

1. Preface
2. What’s new?
2.1. What’s new in 2.2 Since 2.1
2.1.1. Kafka Client Version
2.1.2. Class/Package Changes
2.1.3. After rollback processing
2.1.4. ConcurrentKafkaListenerContainerFactory changes
2.1.5. Listener Container Changes
2.1.6. @KafkaListener Changes
2.1.7. Header Mapping Changes
2.1.8. Embedded Kafka Changes
2.1.9. JsonSerializer/Deserializer Enhancements
2.1.10. Kafka Streams Changes
2.1.11. Transactional Id
3. Introduction
3.1. Quick Tour for the Impatient
3.1.1. Introduction
Very, Very Quick
With Java Configuration
Even Quicker, with Spring Boot
4. Reference
4.1. Using Spring for Apache Kafka
4.1.1. Configuring Topics
4.1.2. Sending Messages
4.1.3. Receiving Messages
Message Listeners
Message Listener Containers
@KafkaListener Annotation
Container Thread Naming
@KafkaListener on a Class
@KafkaListener Lifecycle Management
Rebalance Listeners
Forwarding Listener Results using @SendTo
Filtering Messages
Retrying Deliveries
Stateful Retry
Detecting Idle and Non-Responsive Consumers
Topic/Partition Initial Offset
Seeking to a Specific Offset
Container factory
Thread Safety
4.1.4. Pausing/Resuming Listener Containers
4.1.5. Serialization/Deserialization and Message Conversion
Spring Messaging Message Conversion
Payload Conversion with Batch Listeners
ConversionService Customization
4.1.6. Message Headers
4.1.7. Null Payloads and Log Compaction Tombstone Records
4.1.8. Handling Exceptions
Listener Error Handlers
Container Error Handlers
Consumer-Aware Container Error Handlers
Seek To Current Container Error Handlers
Container Stopping Error Handlers
After Rollback Processor
Publishing Dead-Letter Records
4.1.9. Kerberos
4.2. Kafka Streams Support
4.2.1. Introduction
4.2.2. Basics
4.2.3. Spring Management
4.2.4. JSON Serdes
4.2.5. Configuration
4.2.6. Kafka Streams Example
4.3. Testing Applications
4.3.1. Introduction
4.3.2. JUnit
4.3.3. Using the Same Broker(s) for Multiple Test Classes
4.3.4. @EmbeddedKafka Annotation
4.3.5. Hamcrest Matchers
4.3.6. AssertJ Conditions
4.3.7. Example
5. Spring Integration
5.1. Spring Integration for Apache Kafka
5.1.1. Introduction
5.1.2. Outbound Channel Adapter
5.1.3. Message Driven Channel Adapter
5.1.4. Outbound Gateway
5.1.5. Inbound Gateway
5.1.6. Message Conversion
5.1.7. What’s New in Spring Integration for Apache Kafka
6. Other Resources
A. Change History
A.1. Changes between 2.0 and 2.1
A.1.1. Kafka Client Version
A.1.2. JSON Improvements
A.1.3. Container Stopping Error Handlers
A.1.4. Pausing/Resuming Containers
A.1.5. Stateful Retry
A.1.6. Client ID
A.1.7. Logging Offset Commits
A.1.8. Default @KafkaHandler
A.1.9. ReplyingKafkaTemplate
A.1.10. ChainedKafkaTransactionManager
A.1.11. Migration Guide from 2.0
A.2. Changes Between 1.3 and 2.0
A.2.1. Spring Framework and Java Versions
A.2.2. @KafkaListener Changes
A.2.3. Message Listeners
A.2.4. ConsumerAwareRebalanceListener
A.3. Changes Between 1.2 and 1.3
A.3.1. Support for Transactions
A.3.2. Support for Headers
A.3.3. Creating Topics
A.3.4. Support for Kafka timestamps
A.3.5. @KafkaListener Changes
A.3.6. @EmbeddedKafka Annotation
A.3.7. Kerberos Configuration
A.4. Changes between 1.1 and 1.2
A.5. Changes between 1.0 and 1.1
A.5.1. Kafka Client
A.5.2. Batch Listeners
A.5.3. Null Payloads
A.5.4. Initial Offset
A.5.5. Seek