Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 4.14 KB

Readme.md

File metadata and controls

54 lines (41 loc) · 4.14 KB
Raw

Spring boot & Kafka

This project showcases how to leverage Apache Kafka with Spring Boot and Java applications. It provides a comprehensive guide on:

  • Deploying Kafka with Docker and Docker Compose: Streamline development and testing with a readily available Kafka instance.
  • Building Spring Kafka Producers and Consumers: Facilitate seamless communication between application components.
  • Implementing Error Handling and Retry Strategies: Ensure message delivery and data integrity by handling potential errors and retry mechanisms.
  • Utilizing Avro and Schema Registry: Enhance data management with Avro serialization and centralized schema management through Schema Registry.
  • Advance Producer and Consumer: Customization Producer and Consumer to more flexible for real project

This project empowers developers to gain practical knowledge of Kafka and its integration with Spring Boot Java applications. Getting Started

To run this project, ensure you have Docker and Docker Compose installed on your system.

Version of Tools and Frameworks

  • Spring boot: 3.3.4
  • Kafka: 3.8.1

Prerequisites:

  • Java 21
  • Docker
  • Docker Compose

Instructions:

  • There is some guideLines, hints and command that you need to know to how to use kafka and which options provide by Spring team The name of document is kafka-guideline.md
  • Also, There are few Docker composer that prepare to run Kafka and Kafka-UI at your local machine
    • use kafka-compose.yml to run kafka on your local machine
    • use kafka-cluster-compose.yml to have experience about run kafka at cluster
    • use kafka-service-registry-compose.yml to test schema registry
    • use kafka-ui-compose.yml to run Kafka-ui
  • For Testing, you can find a simple setup that show how to use Testcontainer for test Kafka. you can find it at simple-producer-consumer Project

Exploring the Project

The project demonstrates essential Kafka functionalities through code examples:

1. Simple Producer-Consumer: Demonstrating how to send and receive messages from/to Kafka topics with basic configuration
2. Error Handling: Implemented within the producer and consumer to manage potential errors and ensure message delivery. also show how to use Blocking and Non Blocking Retry Strategy for Dead Letter Topic (DLT)
3. Service Registry (Avro): Integrated for efficient data serialization and centralized schema management by using Avro and schema registry
4. Testcontainer: Demonstrating how to use Testcontainer to test producer and consumer. you can find it under src/test/java/ir/bigz/kafka package in Simple Producer-Consumer module
5. RoutingKafkaTemplate: Demonstrating how to config Spring Kafka that allows you to dynamically route messages to different topics based on message content. advance-producer-consumer project
6. DelegatingByTopicDeserializer: Demonstrating how to config Spring Kafka that allows you to dynamically deserialize message based on different topics. advance-producer-consumer project
7. CustomizeDeserializer: Demonstrating how to define custom deserializer and use it. you can find it under producer at advance-producer-consumer project.
8. CustomizeContainerFactory: Demonstrating how to define a customize container factory and attach to specific @KafkaListener. you can find it under producer at advance-producer-consumer project.
9. Batch Listener: Demonstrating how to enable batch listener and customize it. the name of the method is kafkaBatchListenerContainerFactory. you can find it under consumer at advance-producer-consumer project.
10. Idempotence: A demonstration of how to configure Kafka producers and consumers to ensure idempotent message delivery and prevent duplicate message processing. you can find it at idempotent project. also you can check Springboot & Kafka section at kafka-guideline to get steps you need to use to add idempotency to your project.

Contributing

We welcome contributions to this project. Feel free to fork the repository, make changes, and submit pull requests.