From: Kai Moritz Date: Sun, 27 Oct 2024 21:08:53 +0000 (+0100) Subject: `ExampleConsumer` in eine Spring-Boot App umgebaut (ohne Spring Kafka) X-Git-Tag: consumer/spring-consumer--2025-03-18--19-42~1 X-Git-Url: https://juplo.de/gitweb/?a=commitdiff_plain;h=b7d9136e1c1d54ca559128dacf79a79aba94b2fc;p=demos%2Fkafka%2Ftraining `ExampleConsumer` in eine Spring-Boot App umgebaut (ohne Spring Kafka) * Consumerspezifische Properties werden in eigener nested Class verwaltet ** Dadurch wird der Code übersichtlicher, wenn spätere Implementierungen * _sowohl_ als Consumer, _als auch_ als Producer agieren! * Fix: `close()` muss noch vom `ExampleConsumer` aufgerufen werden ** Der Aufruf von `close()` löst die Abmeldung der Instanz bei dem * GroupCoordinator aus. ** Dieser Vorgang sollte noch unter der Kontrolle des Anwendungscodes * erfolgen! ** Wenn die Methode erst von Spring aufgerufen wird, werden dann ggf. noch * Seiteneffekte ausgelöst, die dann noch im Kontext der Instanz laufen, * obwohl diese eigentlich schon beendet wurde! * Ungefangene Exceptions im `ExampleConsumer` lösen das Beenden der App aus * Das Docker-Setup verwendet den `spring-producer` ** Die Konfiguration wurde außerdem so überarbeitet, dass der Producer mehr Nachrichten verschickt (ca. 10 Nachrichten pro Sekunde) und diese in Batches à ca. 6 Nachrichten verpackt. --- diff --git a/.dockerignore b/.dockerignore index 9127d15f..6de8137a 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,4 +1,3 @@ * !Dockerfile !target/*.jar -!target/libs/*.jar diff --git a/.maven-dockerinclude b/.maven-dockerinclude index a00c65ff..fd6cecd2 100644 --- a/.maven-dockerinclude +++ b/.maven-dockerinclude @@ -1,2 +1 @@ target/*.jar -target/libs/*.jar diff --git a/Dockerfile b/Dockerfile index 22819afe..9e196ff0 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,5 @@ FROM eclipse-temurin:21-jre VOLUME /tmp COPY target/*.jar /opt/app.jar -COPY target/libs /opt/libs ENTRYPOINT [ "java", "-jar", "/opt/app.jar" ] -CMD [ "kafka:9092", "test", "my-group", "DCKR" ] +CMD [] diff --git a/README.sh b/README.sh index 85b8f960..b46e2350 100755 --- a/README.sh +++ b/README.sh @@ -1,6 +1,6 @@ #!/bin/bash -IMAGE=juplo/simple-consumer:1.0-SNAPSHOT +IMAGE=juplo/spring-consumer:1.1-SNAPSHOT if [ "$1" = "cleanup" ] then diff --git a/build.gradle b/build.gradle index be0bc470..a8614fdf 100644 --- a/build.gradle +++ b/build.gradle @@ -8,7 +8,7 @@ plugins { } group = 'de.juplo.kafka' -version = '1.0-SNAPSHOT' +version = '1.1-SNAPSHOT' java { toolchain { @@ -28,9 +28,23 @@ repositories { dependencies { implementation 'org.apache.kafka:kafka-clients' - implementation 'ch.qos.logback:logback-classic' + implementation 'org.springframework.boot:spring-boot-starter-actuator' + implementation 'org.springframework.boot:spring-boot-starter-validation' + implementation 'org.springframework.boot:spring-boot-starter-web' compileOnly 'org.projectlombok:lombok' + developmentOnly 'org.springframework.boot:spring-boot-devtools' + annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor' annotationProcessor 'org.projectlombok:lombok' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testImplementation 'org.springframework.kafka:spring-kafka' + testImplementation 'org.springframework.kafka:spring-kafka-test' + testCompileOnly 'org.projectlombok:lombok' + testAnnotationProcessor 'org.projectlombok:lombok' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' +} + +tasks.named('test') { + useJUnitPlatform() } docker { diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml index 95539006..4fa2eade 100644 --- a/docker/docker-compose.yml +++ b/docker/docker-compose.yml @@ -136,12 +136,34 @@ services: - kafka-3 producer: - image: juplo/simple-producer:1.0-SNAPSHOT - command: kafka:9092 test producer + image: juplo/spring-producer:1.0-SNAPSHOT + environment: + juplo.bootstrap-server: kafka:9092 + juplo.client-id: producer + juplo.producer.topic: test + juplo.producer.linger-ms: 666 + juplo.producer.throttle-ms: 100 consumer: - image: juplo/simple-consumer:1.0-SNAPSHOT - command: kafka:9092 test my-group consumer + image: juplo/spring-consumer:1.1-SNAPSHOT + environment: + juplo.bootstrap-server: kafka:9092 + juplo.client-id: consumer + juplo.consumer.topic: test + + peter: + image: juplo/spring-consumer:1.1-SNAPSHOT + environment: + juplo.bootstrap-server: kafka:9092 + juplo.client-id: peter + juplo.consumer.topic: test + + ute: + image: juplo/spring-consumer:1.1-SNAPSHOT + environment: + juplo.bootstrap-server: kafka:9092 + juplo.client-id: ute + juplo.consumer.topic: test volumes: zookeeper-data: diff --git a/pom.xml b/pom.xml index a1007175..dd96d00f 100644 --- a/pom.xml +++ b/pom.xml @@ -12,16 +12,33 @@ de.juplo.kafka - simple-consumer - Simple Consumer-Group - Super Simple Consumer-Group, that is implemented as a plain Java-program - 1.0-SNAPSHOT + spring-consumer + Spring Consumer + Super Simple Consumer-Group, that is implemented as Spring-Boot application and configured by Spring Kafka + 1.1-SNAPSHOT 21 + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-actuator + + + org.springframework.boot + spring-boot-configuration-processor + true + + + org.springframework.boot + spring-boot-starter-validation + org.apache.kafka kafka-clients @@ -32,42 +49,35 @@ compile - ch.qos.logback - logback-classic + org.springframework.boot + spring-boot-starter-test + test + + + org.springframework.kafka + spring-kafka + test + + + org.springframework.kafka + spring-kafka-test + test - org.apache.maven.plugins - maven-dependency-plugin + org.springframework.boot + spring-boot-maven-plugin - copy-dependencies - package - copy-dependencies + build-info - - ${project.build.directory}/libs - - - org.apache.maven.plugins - maven-jar-plugin - - - - true - libs/ - de.juplo.kafka.ExampleConsumer - - - - pl.project13.maven git-commit-id-plugin diff --git a/settings.gradle b/settings.gradle index 71fb5737..cacb2d5a 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1 +1 @@ -rootProject.name = 'simple-consumer' +rootProject.name = 'spring-consumer' diff --git a/src/main/java/de/juplo/kafka/Application.java b/src/main/java/de/juplo/kafka/Application.java new file mode 100644 index 00000000..0069257f --- /dev/null +++ b/src/main/java/de/juplo/kafka/Application.java @@ -0,0 +1,14 @@ +package de.juplo.kafka; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + + +@SpringBootApplication +public class Application +{ + public static void main(String[] args) + { + SpringApplication.run(Application.class, args); + } +} diff --git a/src/main/java/de/juplo/kafka/ApplicationConfiguration.java b/src/main/java/de/juplo/kafka/ApplicationConfiguration.java new file mode 100644 index 00000000..b98c401d --- /dev/null +++ b/src/main/java/de/juplo/kafka/ApplicationConfiguration.java @@ -0,0 +1,55 @@ +package de.juplo.kafka; + +import org.apache.kafka.clients.consumer.Consumer; +import org.apache.kafka.clients.consumer.KafkaConsumer; +import org.apache.kafka.clients.consumer.StickyAssignor; +import org.apache.kafka.common.serialization.StringDeserializer; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import java.util.Properties; + + +@Configuration +@EnableConfigurationProperties(ApplicationProperties.class) +public class ApplicationConfiguration +{ + @Bean + public ExampleConsumer exampleConsumer( + Consumer kafkaConsumer, + ApplicationProperties properties, + ConfigurableApplicationContext applicationContext) + { + return + new ExampleConsumer( + properties.getClientId(), + properties.getConsumerProperties().getTopic(), + kafkaConsumer, + () -> applicationContext.close()); + } + + @Bean(destroyMethod = "") + public KafkaConsumer kafkaConsumer(ApplicationProperties properties) + { + Properties props = new Properties(); + props.put("bootstrap.servers", properties.getBootstrapServer()); + props.put("client.id", properties.getClientId()); + props.put("group.id", properties.getConsumerProperties().getGroupId()); + if (properties.getConsumerProperties().getAutoOffsetReset() != null) + { + props.put("auto.offset.reset", properties.getConsumerProperties().getAutoOffsetReset().name()); + } + if (properties.getConsumerProperties().getAutoCommitInterval() != null) + { + props.put("auto.commit.interval", properties.getConsumerProperties().getAutoCommitInterval()); + } + props.put("metadata.maxage.ms", 5000); // 5 Sekunden + props.put("partition.assignment.strategy", StickyAssignor.class.getName()); + props.put("key.deserializer", StringDeserializer.class.getName()); + props.put("value.deserializer", StringDeserializer.class.getName()); + + return new KafkaConsumer<>(props); + } +} diff --git a/src/main/java/de/juplo/kafka/ApplicationProperties.java b/src/main/java/de/juplo/kafka/ApplicationProperties.java new file mode 100644 index 00000000..c8193c9f --- /dev/null +++ b/src/main/java/de/juplo/kafka/ApplicationProperties.java @@ -0,0 +1,52 @@ +package de.juplo.kafka; + +import jakarta.validation.constraints.NotEmpty; +import jakarta.validation.constraints.NotNull; +import lombok.Getter; +import lombok.Setter; +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.validation.annotation.Validated; + +import java.time.Duration; + + +@ConfigurationProperties(prefix = "juplo") +@Validated +@Getter +@Setter +public class ApplicationProperties +{ + @NotNull + @NotEmpty + private String bootstrapServer; + @NotNull + @NotEmpty + private String clientId; + + @NotNull + private ConsumerProperties consumer; + + + public ConsumerProperties getConsumerProperties() + { + return consumer; + } + + + @Validated + @Getter + @Setter + static class ConsumerProperties + { + @NotNull + @NotEmpty + private String groupId; + @NotNull + @NotEmpty + private String topic; + private OffsetReset autoOffsetReset; + private Duration autoCommitInterval; + + enum OffsetReset { latest, earliest, none } + } +} diff --git a/src/main/java/de/juplo/kafka/ExampleConsumer.java b/src/main/java/de/juplo/kafka/ExampleConsumer.java index 891af891..4f7151fb 100644 --- a/src/main/java/de/juplo/kafka/ExampleConsumer.java +++ b/src/main/java/de/juplo/kafka/ExampleConsumer.java @@ -1,47 +1,46 @@ package de.juplo.kafka; import lombok.extern.slf4j.Slf4j; +import org.apache.kafka.clients.consumer.Consumer; import org.apache.kafka.clients.consumer.ConsumerRecord; import org.apache.kafka.clients.consumer.ConsumerRecords; -import org.apache.kafka.clients.consumer.Consumer; -import org.apache.kafka.clients.consumer.KafkaConsumer; import org.apache.kafka.common.errors.WakeupException; -import org.apache.kafka.common.serialization.StringDeserializer; import java.time.Duration; import java.util.Arrays; -import java.util.Properties; @Slf4j -public class ExampleConsumer +public class ExampleConsumer implements Runnable { private final String id; private final String topic; private final Consumer consumer; + private final Thread workerThread; + private final Runnable closeCallback; private volatile boolean running = false; private long consumed = 0; + public ExampleConsumer( - String broker, + String clientId, String topic, - String groupId, - String clientId) + Consumer consumer, + Runnable closeCallback) { - Properties props = new Properties(); - props.put("bootstrap.servers", broker); - props.put("group.id", groupId); // ID für die Offset-Commits - props.put("client.id", clientId); // Nur zur Wiedererkennung - props.put("key.deserializer", StringDeserializer.class.getName()); - props.put("value.deserializer", StringDeserializer.class.getName()); - this.id = clientId; this.topic = topic; - consumer = new KafkaConsumer<>(props); + this.consumer = consumer; + + workerThread = new Thread(this, "ExampleConsumer Worker-Thread"); + workerThread.start(); + + this.closeCallback = closeCallback; } + @Override public void run() { try @@ -50,7 +49,7 @@ public class ExampleConsumer consumer.subscribe(Arrays.asList(topic)); running = true; - while (true) + while (running) { ConsumerRecords records = consumer.poll(Duration.ofSeconds(1)); @@ -74,10 +73,11 @@ public class ExampleConsumer { log.error("{} - Unexpected error, unsubscribing!", id, e); consumer.unsubscribe(); + log.info("{} - Triggering exit of application!", id); + new Thread(closeCallback).start(); } finally { - running = false; log.info("{} - Closing the KafkaConsumer", id); consumer.close(); log.info("{}: Consumed {} messages in total, exiting!", id, consumed); @@ -96,50 +96,11 @@ public class ExampleConsumer } - public static void main(String[] args) throws Exception + public void shutdown() throws InterruptedException { - String broker = ":9092"; - String topic = "test"; - String groupId = "my-group"; - String clientId = "DEV"; - - switch (args.length) - { - case 4: - clientId = args[3]; - case 3: - groupId = args[2]; - case 2: - topic = args[1]; - case 1: - broker = args[0]; - } - - - ExampleConsumer instance = new ExampleConsumer(broker, topic, groupId, clientId); - - Runtime.getRuntime().addShutdownHook(new Thread(() -> - { - instance.consumer.wakeup(); - - while (instance.running) - { - log.info("Waiting for main-thread..."); - try - { - Thread.sleep(1000); - } - catch (InterruptedException e) {} - } - log.info("Shutdown completed."); - })); - - log.info( - "Running ExampleConsumer: broker={}, topic={}, group-id={}, client-id={}", - broker, - topic, - groupId, - clientId); - instance.run(); + log.info("{} joining the worker-thread...", id); + running = false; + consumer.wakeup(); + workerThread.join(); } } diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 00000000..7a06731c --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,37 @@ +juplo: + bootstrap-server: :9092 + client-id: DEV + consumer: + group-id: my-group + topic: test + auto-offset-reset: earliest + auto-commit-interval: 5s +management: + endpoint: + shutdown: + enabled: true + endpoints: + web: + exposure: + include: "*" + info: + env: + enabled: true + java: + enabled: true +info: + kafka: + bootstrap-server: ${juplo.bootstrap-server} + client-id: ${juplo.client-id} + consumer: + group-id: ${juplo.consumer.group-id} + topic: ${juplo.consumer.topic} + auto-offset-reset: ${juplo.consumer.auto-offset-reset} + auto-commit-interval: ${juplo.consumer.auto-commit-interval} +logging: + level: + root: INFO + de.juplo: DEBUG + org.springframework.kafka: INFO +server: + port: 8881 diff --git a/src/main/resources/logback.xml b/src/main/resources/logback.xml index 7a25e76f..9c7af767 100644 --- a/src/main/resources/logback.xml +++ b/src/main/resources/logback.xml @@ -7,8 +7,6 @@ - - diff --git a/src/test/java/de/juplo/kafka/ApplicationTests.java b/src/test/java/de/juplo/kafka/ApplicationTests.java new file mode 100644 index 00000000..ae119bff --- /dev/null +++ b/src/test/java/de/juplo/kafka/ApplicationTests.java @@ -0,0 +1,46 @@ +package de.juplo.kafka; + +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.kafka.test.context.EmbeddedKafka; +import org.springframework.test.web.servlet.MockMvc; + +import java.time.Duration; + +import static de.juplo.kafka.ApplicationTests.PARTITIONS; +import static de.juplo.kafka.ApplicationTests.TOPIC; +import static org.awaitility.Awaitility.await; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + + +@SpringBootTest( + properties = { + "juplo.bootstrap-server=${spring.embedded.kafka.brokers}", + "juplo.consumer.topic=" + TOPIC }) +@AutoConfigureMockMvc +@EmbeddedKafka(topics = TOPIC, partitions = PARTITIONS) +public class ApplicationTests +{ + static final String TOPIC = "FOO"; + static final int PARTITIONS = 10; + + @Autowired + MockMvc mockMvc; + + + + @Test + public void testApplicationStartup() + { + await("Application is healthy") + .atMost(Duration.ofSeconds(5)) + .untilAsserted(() -> mockMvc + .perform(get("/actuator/health")) + .andExpect(status().isOk()) + .andExpect(jsonPath("status").value("UP"))); + } +}