feat(build): Refactor infrastructure modules and establish single source of truth
This commit introduces a major refactoring of the build system and the core infrastructure modules. The primary goal is to establish a strict "Single Source of Truth" for all dependencies using Gradle Version Catalogs and to create a clean, maintainable, and scalable foundation for all current and future services. ### 1. Centralized Dependency Management (`libs.versions.toml`) - **Established Single Source of Truth:** All dependency versions are now exclusively managed in `gradle/libs.versions.toml`. Hardcoded versions have been removed from all build scripts. - **Introduced Gradle Bundles:** To simplify module dependencies, several bundles have been created (e.g., `testing-jvm`, `redis-cache`, `spring-cloud-gateway`, `monitoring-client`). This drastically reduces boilerplate in the `build.gradle.kts` files and improves readability. - **Cleaned up Aliases:** All library and plugin aliases have been standardized for consistency. ### 2. Infrastructure Module Refactoring All infrastructure modules (`core`, `platform`, `auth`, `cache`, `event-store`, `messaging`, `monitoring`, `gateway`) have been refactored to align with the new dependency management strategy. - **Simplified Build Scripts:** The `build.gradle.kts` for each module now uses the new bundles and aliases, making them significantly cleaner and easier to understand. - **Consistent Structure:** The architecture of each module now clearly follows the Port-Adapter pattern where applicable (e.g., `cache-api`/`redis-cache`). - **Standardized `platform-bom`:** The project's own Bill of Materials (`platform-bom`) now also includes the Spring Cloud BOM, ensuring version consistency for all Spring-related dependencies. ### 3. Added Infrastructure Documentation To improve onboarding and architectural understanding, a dedicated `README-*.md` file has been created for each refactored infrastructure module: - `README-CORE.md` - `README-PLATFORM.md` - `README-INFRA-AUTH.md` - `README-INFRA-CACHE.md` - `README-INFRA-EVENT-STORE.md` - `README-INFRA-MESSAGING.md` - `README-INFRA-MONITORING.md` - `README-INFRA-GATEWAY.md` These documents explain the purpose, architecture, and usage of each component within the system. This lays the groundwork for our "Tracer Bullet" development approach.
This commit is contained in:
stefan
@@ -0,0 +1,81 @@
|
||||
# Infrastructure/Messaging Module
|
||||
|
||||
## Überblick
|
||||
|
||||
Das **Messaging-Modul** stellt die Infrastruktur für die asynchrone Kommunikation zwischen den Microservices des Meldestelle-Systems bereit. Es nutzt **Apache Kafka** als hochperformanten, verteilten Message-Broker. Dieses Modul ist entscheidend für die Entkopplung von Services und die Implementierung von Mustern wie Publish/Subscribe, um eine skalierbare und resiliente Architektur zu ermöglichen.
|
||||
|
||||
## Architektur
|
||||
|
||||
Ähnlich wie andere Infrastruktur-Module ist auch dieses in zwei spezialisierte Komponenten aufgeteilt, um Konfiguration von der Client-Logik zu trennen:
|
||||
|
||||
|
||||
infrastructure/messaging/
|
||||
├── messaging-config/ # Stellt die zentrale Kafka-Konfiguration bereit
|
||||
└── messaging-client/ # Stellt wiederverwendbare Producer- und Consumer-Clients bereit
|
||||
|
||||
|
||||
### `messaging-config`
|
||||
|
||||
Dieses Modul ist die Basis für jede Kafka-Interaktion. Es ist dafür verantwortlich, die gesamte **Konfiguration** zu zentralisieren.
|
||||
|
||||
* **Zweck:** Definiert Spring-Beans für die grundlegende Kafka-Konfiguration. Dazu gehören:
|
||||
* Die Adresse der Kafka-Broker (`bootstrap-servers`).
|
||||
* Konfiguration für Serializer und Deserializer (z.B. `JsonSerializer` von Spring Kafka), um sicherzustellen, dass alle Services Nachrichten im selben Format (JSON) austauschen.
|
||||
* Konfiguration für Topics, Partitionen und Replikationsfaktoren.
|
||||
* **Vorteil:** Jeder Service, der Kafka nutzt, kann sich auf diese zentrale Konfiguration verlassen, was die Konsistenz sicherstellt und die Einrichtung neuer Producer oder Consumer vereinfacht.
|
||||
|
||||
### `messaging-client`
|
||||
|
||||
Dieses Modul baut auf `messaging-config` auf und stellt **wiederverwendbare High-Level-Komponenten** für die Interaktion mit Kafka bereit.
|
||||
|
||||
* **Zweck:** Stellt einfach zu verwendende Klassen oder Services zur Verfügung, z.B. einen `KafkaProducerService` zum Senden von Nachrichten und einen `KafkaConsumerService` zum Empfangen von Nachrichten. Es nutzt **Project Reactor** (`reactor-kafka`), um eine reaktive und nicht-blockierende Verarbeitung von Nachrichten zu ermöglichen.
|
||||
* **Vorteil:** Kapselt die Komplexität der Kafka-Producer- und -Consumer-API. Ein Fach-Service muss nur noch eine Methode wie `producer.sendMessage("topic", message)` aufrufen, ohne sich um die Details der Verbindung, Serialisierung oder Fehlerbehandlung kümmern zu müssen.
|
||||
|
||||
## Verwendung in anderen Modulen
|
||||
|
||||
Ein Microservice, der Nachrichten senden oder empfangen möchte, geht wie folgt vor:
|
||||
|
||||
1. **Abhängigkeit deklarieren:** Das Service-Modul (z.B. `events-service`) fügt eine `implementation`-Abhängigkeit zu `:infrastructure:messaging:messaging-client` in seiner `build.gradle.kts` hinzu.
|
||||
|
||||
2. **Client-Service injizieren:** Im Service-Code wird der `KafkaProducerService` oder `KafkaConsumerService` per Dependency Injection angefordert.
|
||||
|
||||
```kotlin
|
||||
// Beispiel für das Senden einer Nachricht
|
||||
@Service
|
||||
class EventNotificationService(
|
||||
private val kafkaProducer: KafkaProducerService
|
||||
) {
|
||||
fun notifyNewEvent(eventDetails: EventDetails) {
|
||||
val topic = "new-events-topic"
|
||||
// Einfacher Aufruf zum Senden der Nachricht.
|
||||
// Die Komplexität der Serialisierung und des Sendens ist gekapselt.
|
||||
kafkaProducer.sendMessage(topic, eventDetails.id, eventDetails)
|
||||
.subscribe(
|
||||
{ result -> logger.info("Message sent successfully to topic '{}'", topic) },
|
||||
{ error -> logger.error("Failed to send message to topic '{}'", topic, error) }
|
||||
)
|
||||
}
|
||||
}
|
||||
```kotlin
|
||||
// Beispiel für das Empfangen von Nachrichten
|
||||
@Component
|
||||
class EventListener(
|
||||
private val kafkaConsumer: KafkaConsumerService
|
||||
) {
|
||||
@PostConstruct
|
||||
fun listenForEvents() {
|
||||
val topic = "new-events-topic"
|
||||
// Reaktiv auf eingehende Nachrichten lauschen.
|
||||
kafkaConsumer.receiveMessages<EventDetails>(topic)
|
||||
.subscribe { event ->
|
||||
logger.info("Received new event with ID: {}", event.id)
|
||||
// Geschäftslogik zur Verarbeitung des Events...
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Diese Architektur ermöglicht eine saubere, robuste und hochgradig entkoppelte Kommunikation zwischen den Diensten.
|
||||
|
||||
---
|
||||
**Letzte Aktualisierung**: 31. Juli 2025
|
||||
@@ -1,25 +1,23 @@
|
||||
// Dieses Modul stellt High-Level-Clients (Producer/Consumer) für die
|
||||
// Interaktion mit Apache Kafka bereit. Es baut auf der `messaging-config` auf.
|
||||
plugins {
|
||||
// kotlin("jvm")
|
||||
// kotlin("plugin.spring")
|
||||
|
||||
alias(libs.plugins.kotlin.jvm)
|
||||
alias(libs.plugins.kotlin.spring)
|
||||
|
||||
// KORREKTUR: Dieses Plugin ist entscheidend. Es schaltet den `springBoot`-Block
|
||||
// und alle Spring-Boot-spezifischen Gradle-Tasks frei.
|
||||
alias(libs.plugins.spring.boot)
|
||||
|
||||
// Dependency Management für konsistente Spring-Versionen
|
||||
alias(libs.plugins.spring.dependencyManagement)
|
||||
}
|
||||
|
||||
dependencies {
|
||||
// Stellt sicher, dass alle Versionen aus der zentralen BOM kommen.
|
||||
implementation(platform(projects.platform.platformBom))
|
||||
// Stellt gemeinsame Abhängigkeiten bereit.
|
||||
implementation(projects.platform.platformDependencies)
|
||||
// Baut auf der zentralen Kafka-Konfiguration auf und erbt deren Abhängigkeiten.
|
||||
implementation(projects.infrastructure.messaging.messagingConfig)
|
||||
|
||||
implementation("org.springframework.kafka:spring-kafka")
|
||||
implementation("io.projectreactor.kafka:reactor-kafka")
|
||||
implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
|
||||
// Fügt die reaktive Kafka-Implementierung hinzu (Project Reactor).
|
||||
implementation(libs.reactor.kafka)
|
||||
|
||||
// Stellt alle Test-Abhängigkeiten gebündelt bereit.
|
||||
testImplementation(projects.platform.platformTesting)
|
||||
}
|
||||
|
||||
@@ -1,25 +1,23 @@
|
||||
// Dieses Modul stellt die zentrale, wiederverwendbare Konfiguration
|
||||
// für die Verbindung mit Apache Kafka bereit (z.B. Bootstrap-Server, Serializer).
|
||||
plugins {
|
||||
// kotlin("jvm")
|
||||
// kotlin("plugin.spring")
|
||||
|
||||
alias(libs.plugins.kotlin.jvm)
|
||||
alias(libs.plugins.kotlin.spring)
|
||||
|
||||
// KORREKTUR: Dieses Plugin ist entscheidend. Es schaltet den `springBoot`-Block
|
||||
// und alle Spring-Boot-spezifischen Gradle-Tasks frei.
|
||||
alias(libs.plugins.spring.boot)
|
||||
|
||||
// Dependency Management für konsistente Spring-Versionen
|
||||
alias(libs.plugins.spring.dependencyManagement)
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation(projects.platform.platformDependencies)
|
||||
// Stellt sicher, dass alle Versionen aus der zentralen BOM kommen.
|
||||
api(platform(projects.platform.platformBom))
|
||||
// Stellt gemeinsame Abhängigkeiten bereit.
|
||||
api(projects.platform.platformDependencies)
|
||||
|
||||
implementation("org.springframework.kafka:spring-kafka")
|
||||
implementation("org.springframework.boot:spring-boot-starter-json")
|
||||
implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
|
||||
implementation("com.fasterxml.jackson.datatype:jackson-datatype-jsr310")
|
||||
// OPTIMIERUNG: Verwendung des `kafka-config`-Bundles.
|
||||
// `api` wird verwendet, damit der `messaging-client` diese Konfigurationen
|
||||
// und Abhängigkeiten (wie Jackson) direkt nutzen kann.
|
||||
api(libs.bundles.kafka.config)
|
||||
|
||||
// Stellt alle Test-Abhängigkeiten gebündelt bereit.
|
||||
testImplementation(projects.platform.platformTesting)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user