refactoring(infra-messaging)

This commit is contained in:
2025-08-15 22:35:13 +02:00
parent d2172229b1
commit 69ca3faf91
2 changed files with 584 additions and 12 deletions
@@ -6,6 +6,16 @@ Das **Messaging-Modul** stellt die Infrastruktur für die asynchrone, reaktive K
Das Modul implementiert moderne **Domain-Driven Design (DDD)** Prinzipien mit expliziter Fehlerbehandlung über das **Result Pattern** und bietet sowohl suspending Coroutine-APIs als auch reaktive Stream-APIs für maximale Flexibilität.
### Kernfeatures
- **🎯 Result Pattern APIs**: Typsichere Fehlerbehandlung ohne Exceptions
- **⚡ Reactive Streams**: Hochperformante, nicht-blockierende I/O-Operationen
- **🔄 Intelligent Retry Logic**: Differenzierte Retry-Strategien basierend auf Fehlertypen
- **📊 Batch Processing**: Optimierte Verarbeitung mehrerer Events mit kontrollierbarer Parallelität
- **🔒 Security Features**: Sichere Deserialisierung mit Trusted-Package-Validierung
- **📈 Observability**: Umfassendes Logging und Monitoring für Production-Ready-Deployment
- **🧪 Comprehensive Testing**: Integration Tests mit Testcontainers und fokussierte Unit Tests
## Architektur
Das Modul ist in zwei spezialisierte Komponenten aufgeteilt, um Konfiguration von der Client-Logik zu trennen:
@@ -27,16 +37,42 @@ Dieses Modul zentralisiert die grundlegende Kafka-Konfiguration für das gesamte
Dieses Modul baut auf der Konfiguration auf und stellt wiederverwendbare High-Level-Komponenten für die Interaktion mit Kafka bereit.
* **Zweck:**
* **`EventPublisher` Interface**: Definiert moderne APIs für das Publizieren von Domain Events mit expliziter Fehlerbehandlung über das Result Pattern.
* **`KafkaEventPublisher`**: Implementierung des EventPublisher mit sowohl modernen suspending Coroutine-APIs als auch Legacy-reaktiven APIs. Nutzt den `ReactiveKafkaProducerTemplate` von Spring.
* **`KafkaEventConsumer`**: Ein reaktiver Service zum Empfangen von Nachrichten. Er kapselt die Komplexität von `reactor-kafka` und gibt einen kontinuierlichen `Flux`-Stream von Events zurück.
* **`MessagingError`**: Domain-spezifische Fehlertypen für typsichere Fehlerbehandlung (SerializationError, ConnectionError, TimeoutError, AuthenticationError, etc.).
* **Vorteil:**
* Moderne **Result Pattern** APIs für typsichere Fehlerbehandlung ohne Exceptions
* Sowohl **Coroutine-basierte** als auch **reaktive** APIs verfügbar
* Kapselt die Komplexität der Kafka-API mit domain-spezifischen Abstraktionen
* Umfassendes Retry-Management mit intelligenter Retry-Logik
#### Kern-Komponenten:
* **`EventPublisher` Interface**: Definiert moderne APIs für das Publizieren von Domain Events
* **Moderne APIs**: `publishEvent()` und `publishEvents()` mit Result Pattern
* **Legacy APIs**: `publishEventReactive()` und `publishEventsReactive()` (deprecated)
* **`EventConsumer` Interface**: Definiert APIs für das Empfangen von Domain Events
* **Moderne APIs**: `receiveEventsWithResult()` mit Flow<Result<T>> für typsichere Fehlerbehandlung
* **Legacy APIs**: `receiveEvents()` mit Flux<T> (deprecated)
* **`KafkaEventPublisher`**: Implementierung des EventPublisher mit umfassendem Feature-Set
* Reaktive, nicht-blockierende Kafka-Integration mit `ReactiveKafkaProducerTemplate`
* Intelligente Retry-Logic mit exponential backoff
* Optimierte Batch-Verarbeitung mit kontrollierbarer Parallelität (10 concurrent operations)
* Comprehensive Logging und Progress-Tracking
* **`KafkaEventConsumer`**: Implementierung des EventConsumer mit erweiterten Funktionen
* Connection-Pooling zur Wiederverwendung von KafkaReceiver-Instanzen
* Sichere Deserialisierung mit Trusted-Package-Validierung
* Manual Acknowledgment Control für bessere Kontrolle über Commit-Verhalten
* Consumer-Cache-Management für Ressourcenoptimierung
* **`MessagingError` Hierarchie**: Domain-spezifische Fehlertypen für strukturierte Fehlerbehandlung
* `SerializationError`, `DeserializationError`: Serialization-/Deserialization-Probleme
* `ConnectionError`: Netzwerk- und Verbindungsfehler
* `TimeoutError`: Zeitüberschreitungen
* `AuthenticationError`: Authentifizierungs-/Autorisierungsfehler
* `TopicConfigurationError`: Topic-Konfigurationsprobleme
* `UnexpectedError`: Allgemeine unerwartete Fehler
#### Vorteile:
* **Typsichere Fehlerbehandlung**: Result Pattern eliminiert unerwartete Exceptions
* **Flexible APIs**: Sowohl moderne Coroutine-basierte als auch Legacy reaktive APIs
* **Production-Ready**: Umfassendes Retry-Management, Observability und Ressourcenoptimierung
* **Domain-Driven Design**: Explizite Fehlertypen und saubere Abstraktionen
## Verwendung
@@ -76,6 +112,106 @@ class EventNotificationService(
}
```
**Beispiel für das Empfangen von Nachrichten mit typsicherer Fehlerbehandlung:**
```kotlin
@Component
class ModernEventListener(
private val eventConsumer: EventConsumer
) {
private val logger = LoggerFactory.getLogger(ModernEventListener::class.java)
@PostConstruct
fun startListening() {
val topic = "new-events-topic"
// Moderne Result-basierte API mit Flow<Result<T>>
eventConsumer.receiveEventsWithResult(topic, EventDetails::class.java)
.asFlow()
.collect { result ->
result
.onSuccess { event ->
logger.info("Successfully received event with ID: {}", event.id)
processEvent(event)
}
.onFailure { error ->
when (error) {
is MessagingError.DeserializationError -> {
logger.error("Failed to deserialize event from topic '{}': {}", topic, error.message)
// Deserialization-Fehler sind meist permanent - keine weiteren Versuche
handlePoisonMessage(topic, error)
}
is MessagingError.ConnectionError -> {
logger.warn("Connection issue while consuming from topic '{}': {}", topic, error.message)
// Connection-Fehler sind oft temporär - Consumer wird automatisch retries
}
is MessagingError.TimeoutError -> {
logger.warn("Timeout while consuming from topic '{}': {}", topic, error.message)
// Timeout-Fehler können retries bekommen
}
else -> {
logger.error("Unexpected error consuming from topic '{}': {}", topic, error.message, error)
handleUnexpectedError(topic, error)
}
}
}
}
}
private suspend fun processEvent(event: EventDetails) {
// Geschäftslogik zur Verarbeitung des Events
logger.debug("Processing event: {}", event)
}
private suspend fun handlePoisonMessage(topic: String, error: MessagingError.DeserializationError) {
// Poison Messages in separates Topic oder Dead Letter Queue verschieben
logger.warn("Moving poison message from topic '{}' to dead letter queue", topic)
}
private suspend fun handleUnexpectedError(topic: String, error: MessagingError) {
// Monitoring/Alerting für unerwartete Fehler
logger.error("Alerting monitoring system for unexpected error in topic '{}'", topic)
}
}
```
**Beispiel für Consumer mit Coroutines und strukturierter Parallelität:**
```kotlin
@Service
class BatchEventProcessor(
private val eventConsumer: EventConsumer
) {
private val logger = LoggerFactory.getLogger(BatchEventProcessor::class.java)
suspend fun processBatchEvents(topic: String): Result<Int> = withContext(Dispatchers.IO) {
try {
var processedCount = 0
var errorCount = 0
eventConsumer.receiveEventsWithResult(topic, EventDetails::class.java)
.asFlow()
.take(100) // Verarbeite maximal 100 Events pro Batch
.collect { result ->
result
.onSuccess { event ->
processedCount++
logger.debug("Processed event {}/{}", processedCount, 100)
}
.onFailure { error ->
errorCount++
logger.warn("Error processing event: {}", error.message)
}
}
logger.info("Batch processing completed: {} processed, {} errors", processedCount, errorCount)
Result.success(processedCount)
} catch (exception: Exception) {
logger.error("Batch processing failed", exception)
Result.failure(MessagingError.UnexpectedError("Batch processing failed: ${exception.message}", exception))
}
}
}
```
### Legacy Reactive API - **Wird depreciert**
**Beispiel für das Senden einer Nachricht (reaktiv, nicht-blockierend):**
@@ -116,6 +252,182 @@ class EventListener(
}
```
## Konfiguration
Das Messaging-Modul bietet umfassende Konfigurationsmöglichkeiten über die `KafkaConfig`-Klasse mit automatischer Validierung und optimierten Standardwerten für Production-Ready-Deployments.
### Basis-Konfiguration
```kotlin
@Configuration
class MessagingConfiguration {
@Bean
fun kafkaConfig(): KafkaConfig {
return KafkaConfig().apply {
// Kafka-Cluster-Verbindung
bootstrapServers = "kafka-cluster:9092" // oder "localhost:9092" für lokale Entwicklung
// Consumer-Gruppierung
defaultGroupIdPrefix = "myapp-messaging"
// Sicherheitseinstellungen
trustedPackages = "com.mycompany.*,at.mocode.*"
enableSecurityFeatures = true
// Performance-Tuning
connectionPoolSize = 20 // Für hochfrequente Anwendungen
}
}
}
```
### Konfigurationsoptionen
| Parameter | Typ | Standard | Beschreibung |
|-----------|-----|----------|--------------|
| `bootstrapServers` | String | "localhost:9092" | Kafka-Cluster-Endpunkte. Unterstützt `host:port` und `PROTOCOL://host:port` Formate |
| `defaultGroupIdPrefix` | String | "messaging-client" | Präfix für automatisch generierte Consumer-Gruppen |
| `trustedPackages` | String | "at.mocode.*" | Comma-separated List von Packages für sichere JSON-Deserialisierung |
| `enableSecurityFeatures` | Boolean | true | Aktiviert erweiterte Sicherheitsfeatures für Production |
| `connectionPoolSize` | Int | 10 | Anzahl der gleichzeitigen Kafka-Verbindungen im Pool |
### Production-Konfiguration
Für Production-Umgebungen empfohlene Konfiguration:
```kotlin
@Configuration
@Profile("production")
class ProductionMessagingConfiguration {
@Bean
fun kafkaConfig(): KafkaConfig {
return KafkaConfig().apply {
// Hochverfügbares Kafka-Cluster
bootstrapServers = "kafka-01.prod:9092,kafka-02.prod:9092,kafka-03.prod:9092"
// Environment-spezifische Gruppierung
defaultGroupIdPrefix = "${System.getenv("APP_NAME")}-${System.getenv("ENVIRONMENT")}"
// Restriktive Sicherheitseinstellungen
trustedPackages = "com.mycompany.events.*,com.mycompany.domain.*"
enableSecurityFeatures = true
// Optimiert für hohe Parallelität
connectionPoolSize = 50
}
}
}
```
### Umgebungsvariablen
Das Modul unterstützt Konfiguration über Umgebungsvariablen für Container-Deployments:
```bash
# Docker/Kubernetes Environment Variables
KAFKA_BOOTSTRAP_SERVERS=kafka-cluster:9092
KAFKA_GROUP_ID_PREFIX=myapp-prod
KAFKA_TRUSTED_PACKAGES=com.mycompany.*
KAFKA_CONNECTION_POOL_SIZE=25
KAFKA_ENABLE_SECURITY=true
```
### Erweiterte Producer-Konfiguration
Die `KafkaConfig` stellt optimierte Producer-Eigenschaften bereit:
```kotlin
// Automatisch konfigurierte Producer-Eigenschaften:
// - Batch-Verarbeitung (32KB Batches, 5ms Linger)
// - Snappy-Komprimierung für bessere Performance
// - Idempotenz für Exactly-Once-Semantics
// - Intelligente Retry-Logik (3 Versuche, 1s Backoff)
// - 30s Delivery-Timeout mit 10s Request-Timeout
```
### Erweiterte Consumer-Konfiguration
Consumer werden automatisch mit optimierten Einstellungen konfiguriert:
```kotlin
// Automatisch konfigurierte Consumer-Eigenschaften:
// - Manual Commit für bessere Kontrolle
// - Optimierte Fetch-Größen (1KB min, 1MB max)
// - 500ms Max-Wait für Fetch-Operationen
// - Session-Timeout: 30s, Heartbeat: 3s
// - Automatic Offset Reset: earliest
// - Max 500 Records pro Poll
```
### Monitoring und Observability
```kotlin
@Component
class MessagingHealthIndicator(
private val kafkaConfig: KafkaConfig
) : HealthIndicator {
override fun health(): Health {
return try {
// Kafka-Cluster-Konnektivität prüfen
val adminClient = AdminClient.create(kafkaConfig.producerConfigs())
val clusterMetadata = adminClient.describeCluster()
val nodeCount = clusterMetadata.nodes().get(5, TimeUnit.SECONDS).size
Health.up()
.withDetail("kafka.cluster.nodes", nodeCount)
.withDetail("kafka.bootstrap.servers", kafkaConfig.bootstrapServers)
.withDetail("kafka.connection.pool.size", kafkaConfig.connectionPoolSize)
.build()
} catch (exception: Exception) {
Health.down()
.withDetail("kafka.error", exception.message)
.withException(exception)
.build()
}
}
}
```
## Dependency Management
### Gradle-Konfiguration
Das Messaging-Modul nutzt eine saubere Modularisierung über Gradle Composite Builds:
```kotlin
// In einem Service-Modul
dependencies {
// Hauptabhängigkeit für messaging functionality
implementation(projects.infrastructure.messaging.messagingClient)
// Die messaging-config wird transitiv eingebunden
// Alle benötigten Kafka-, Spring- und Reactive-Dependencies sind enthalten
}
```
### Verfügbare Module
| Modul | Zweck | Transitive Dependencies |
|--------|--------|------------------------|
| `messaging-config` | Zentrale Kafka-Konfiguration | Spring Kafka, Jackson, Kafka Clients |
| `messaging-client` | High-Level Publisher/Consumer APIs | Reactor Kafka, Kotlinx Coroutines, messaging-config |
### Version-Management
```kotlin
// platform/platform-bom/build.gradle.kts - Zentrale Versionsverwaltung
dependencies {
constraints {
api("org.springframework.kafka:spring-kafka:3.1.4")
api("io.projectreactor.kafka:reactor-kafka:1.3.22")
api("org.apache.kafka:kafka-clients:3.6.1")
}
}
```
## Testing-Strategie
Die Zuverlässigkeit des Moduls wird durch eine mehrstufige Teststrategie sichergestellt, die sowohl Unit- als auch Integrationstests umfasst:
@@ -170,6 +482,237 @@ Die Zuverlässigkeit des Moduls wird durch eine mehrstufige Teststrategie sicher
* **StepVerifier Korrekturen**: Korrigierte reaktive Test-Assertions für `Mono<Unit>` Rückgabetypen
* **Reduced Test Complexity**: Entfernung unnötiger Performance- und Logging-Tests zugunsten fokussierter Funktionstests
## Troubleshooting
### Häufige Probleme und Lösungen
#### 1. Connection-Fehler zu Kafka
**Problem**: `MessagingError.ConnectionError` beim Senden oder Empfangen von Nachrichten
**Mögliche Ursachen und Lösungen**:
1. **Kafka-Cluster-Erreichbarkeit prüfen**:
```bash
# Teste Verbindung zu Kafka-Cluster
telnet kafka-cluster 9092
# Oder mit nc (netcat)
nc -zv kafka-cluster 9092
```
2. **Bootstrap-Server-Konfiguration validieren**:
```kotlin
// Multiple Broker für High Availability
kafkaConfig.bootstrapServers = "kafka-01:9092,kafka-02:9092,kafka-03:9092"
```
3. **Netzwerk-Timeouts erhöhen für langsame Verbindungen**:
```kotlin
// Producer-Konfiguration erweitern
override fun producerConfigs(): Map<String, Any> = super.producerConfigs() + mapOf(
ProducerConfig.REQUEST_TIMEOUT_MS_CONFIG to 30000, // 30 Sekunden
ProducerConfig.DELIVERY_TIMEOUT_MS_CONFIG to 60000 // 1 Minute
)
```
#### 2. Deserialization-Fehler
**Problem**: `MessagingError.DeserializationError` beim Empfangen von Nachrichten
**Lösungsansätze**:
```kotlin
// 1. Trusted Packages erweitern
kafkaConfig.trustedPackages = "at.mocode.*,com.mycompany.*,java.util.*"
// 2. Event-Schema-Kompatibilität prüfen
@JsonIgnoreProperties(ignoreUnknown = true)
data class EventDetails(
val id: String,
val version: Int = 1 // Schema-Versionierung
)
// 3. Dead Letter Queue für Poison Messages implementieren
private suspend fun handlePoisonMessage(topic: String, error: MessagingError.DeserializationError) {
val dlqTopic = "${topic}.dlq"
eventPublisher.publishEvent(dlqTopic, "error", error.message)
}
```
#### 3. Performance-Probleme
**Problem**: Langsame Message-Verarbeitung oder hohe Latenz
**Optimierungsstrategien**:
```kotlin
// 1. Connection Pool vergrößern
kafkaConfig.connectionPoolSize = 50
// 2. Batch-Verarbeitung nutzen
suspend fun processEventsBatch(events: List<EventDetails>) {
val batchSize = 100
events.chunked(batchSize).forEach { batch ->
// Parallele Verarbeitung pro Batch
batch.map { event ->
async { processEvent(event) }
}.awaitAll()
}
}
// 3. Consumer-Parallelität erhöhen
// Mehrere Consumer-Instanzen mit unterschiedlichen Group-IDs
```
#### 4. Memory-Leaks bei Consumers
**Problem**: Speicherverbrauch steigt kontinuierlich
**Lösungen**:
```kotlin
// 1. Consumer-Cache korrekt verwalten
@PreDestroy
fun cleanup() {
eventConsumer.cleanup() // Cached receivers freigeben
}
// 2. Flow-Streams korrekt beenden
eventConsumer.receiveEventsWithResult(topic, EventDetails::class.java)
.asFlow()
.take(1000) // Streams begrenzen
.catch { exception ->
logger.error("Stream error", exception)
}
.collect { /* process */ }
// 3. Subscription Management
val subscription = eventConsumer.receiveEvents<EventDetails>(topic)
.take(Duration.ofMinutes(5)) // Auto-Timeout nach 5 Minuten
.subscribe()
```
### Best Practices
#### 1. Error Handling
```kotlin
// Strukturierte Fehlerbehandlung mit spezifischen Aktionen
suspend fun handleMessagingError(error: MessagingError, topic: String) {
when (error) {
is MessagingError.SerializationError,
is MessagingError.DeserializationError -> {
// Keine Retries - permanente Fehler
alertMonitoring("Schema compatibility issue", error)
}
is MessagingError.ConnectionError,
is MessagingError.TimeoutError -> {
// Retries möglich - temporäre Fehler
scheduleRetry(error, topic)
}
is MessagingError.AuthenticationError -> {
// Security-Issue - sofortige Attention erforderlich
alertSecurity("Authentication failed", error)
}
else -> {
// Unbekannte Fehler - Investigation erforderlich
alertDevelopment("Unknown messaging error", error)
}
}
}
```
#### 2. Monitoring und Alerting
```kotlin
// Umfassendes Monitoring einrichten
@Component
class MessagingMetrics(
private val meterRegistry: MeterRegistry
) {
private val publishedEvents = Counter.builder("messaging.events.published")
.register(meterRegistry)
private val consumedEvents = Counter.builder("messaging.events.consumed")
.register(meterRegistry)
private val errorCounter = Counter.builder("messaging.errors")
.tag("type", "unknown")
.register(meterRegistry)
fun recordPublishedEvent(topic: String) {
publishedEvents.increment(Tags.of("topic", topic))
}
fun recordError(error: MessagingError, topic: String) {
errorCounter.increment(
Tags.of(
"error.type", error.javaClass.simpleName,
"topic", topic
)
)
}
}
```
#### 3. Testing von Messaging-Code
```kotlin
// Integration Test mit Testcontainers
@TestMethodOrder(OrderAnnotation::class)
class MessagingIntegrationTest {
companion object {
@Container
val kafka = KafkaContainer(DockerImageName.parse("confluentinc/cp-kafka:latest"))
}
@Test
@Order(1)
fun `should publish and consume events successfully`() = runTest {
// Given
val topic = "test-topic"
val event = EventDetails("test-id", "test-data")
// When
val publishResult = eventPublisher.publishEvent(topic, event.id, event)
val consumedEvents = mutableListOf<Result<EventDetails>>()
eventConsumer.receiveEventsWithResult(topic, EventDetails::class.java)
.asFlow()
.take(1)
.collect { result -> consumedEvents.add(result) }
// Then
publishResult.shouldBeSuccess()
consumedEvents.shouldHaveSize(1)
consumedEvents.first().getOrNull()?.id shouldBe event.id
}
}
```
### Häufig gestellte Fragen (FAQ)
**Q: Wie unterscheidet sich die moderne API von der Legacy-API?**
A: Die moderne API nutzt das Result Pattern für explizite Fehlerbehandlung und Kotlin Coroutines für bessere Performance. Legacy APIs verwenden reaktive Streams mit Exception-basierter Fehlerbehandlung.
**Q: Wann sollte ich Batch-Verarbeitung verwenden?**
A: Batch-Verarbeitung ist empfohlen bei:
- Mehr als 10 Events pro Sekunde
- Hoher Netzwerk-Latenz zum Kafka-Cluster
- Events, die zusammen verarbeitet werden können
**Q: Wie handle ich Backpressure bei hohem Event-Durchsatz?**
A: Nutzen Sie die eingebauten Flow-Operatoren:
```kotlin
eventConsumer.receiveEventsWithResult(topic, EventType::class.java)
.asFlow()
.buffer(1000) // Puffering für Backpressure-Handling
.flowOn(Dispatchers.IO) // Separater Dispatcher
.collect { /* process */ }
```
---
**Letzte Aktualisierung**: 15. August 2025
@@ -33,9 +33,12 @@ class KafkaEventConsumer(
return receiveEvents(topic, eventType)
.map<Result<T>> { event -> Result.success(event) }
.onErrorContinue { error, _ ->
.onErrorResume { exception ->
logger.warn("Error occurred while consuming events from topic '{}' for event type '{}': {}",
topic, eventType.simpleName, error.message)
topic, eventType.simpleName, exception.message)
// Map exception to appropriate MessagingError and return as Result.failure
val messagingError = mapToMessagingError(exception)
reactor.core.publisher.Mono.just(Result.failure<T>(messagingError))
}
.doOnError { exception ->
logger.error("Fatal error in consumer stream for topic '{}' and event type '{}': {}",
@@ -121,6 +124,32 @@ class KafkaEventConsumer(
return KafkaReceiver.create(receiverOptions)
}
/**
* Maps generic exceptions to domain-specific MessagingError types.
* Consumer-focused error mapping with emphasis on deserialization errors.
*/
private fun mapToMessagingError(exception: Throwable): MessagingError {
return when {
exception.message?.contains("deserializ", ignoreCase = true) == true ||
exception.message?.contains("parse", ignoreCase = true) == true ||
exception.message?.contains("json", ignoreCase = true) == true ->
MessagingError.DeserializationError("Deserialization failed: ${exception.message}", exception)
exception.message?.contains("timeout", ignoreCase = true) == true ||
exception is java.util.concurrent.TimeoutException ->
MessagingError.TimeoutError("Operation timed out: ${exception.message}", exception)
exception.message?.contains("connection", ignoreCase = true) == true ||
exception.message?.contains("network", ignoreCase = true) == true ||
exception is java.net.ConnectException ||
exception is java.io.IOException ->
MessagingError.ConnectionError("Connection failed: ${exception.message}", exception)
exception.message?.contains("auth", ignoreCase = true) == true ->
MessagingError.AuthenticationError("Authentication failed: ${exception.message}", exception)
exception.message?.contains("topic", ignoreCase = true) == true ->
MessagingError.TopicConfigurationError("Topic configuration error: ${exception.message}", exception)
else -> MessagingError.UnexpectedError("Unexpected error: ${exception.message}", exception)
}
}
/**
* Cleanup method to clear cached receivers on application shutdown.
* Reactive receivers will be automatically cleaned up when their streams complete.