GH-248 - Support to automatically externalize events.

We now allow externalizing application events to a variety of message brokers through the addition of Spring Modulith modules for Kafka, AMQP and JMS to a user project's classpath. Which events shall be externalized and how they're supposed to be routed to the message broker can be configured through either annotations or via a configuration API declared as Spring bean.

In case Jackson is on the classpath, we also add auto-configuration to use a Boot-configured ObjectMapper instance with the corresponding message broker client APIs to properly serialize and deserialize messages to JSON.

spring-modulith-examples/spring-modulith-example-kafka/src/main/java/example/Application.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package example;
+
+import example.order.Order;
+import example.order.OrderManagement;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@SpringBootApplication
+public class Application {
+
+	public static void main(String[] args) {
+		SpringApplication.run(Application.class, args)
+				.getBean(OrderManagement.class)
+				.complete(new Order());
+	}
+}

spring-modulith-examples/spring-modulith-example-kafka/src/main/java/example/order/Order.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2022-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package example.order;
+
+import example.order.Order.OrderIdentifier;
+import lombok.Getter;
+
+import java.util.UUID;
+
+import org.jmolecules.ddd.types.AggregateRoot;
+import org.jmolecules.ddd.types.Identifier;
+
+/**
+ * @author Oliver Drotbohm
+ */
+public class Order implements AggregateRoot<Order, OrderIdentifier> {
+
+	private @Getter OrderIdentifier id = new OrderIdentifier(UUID.randomUUID());
+
+	public static record OrderIdentifier(UUID id) implements Identifier {}
+}

spring-modulith-examples/spring-modulith-example-kafka/src/main/java/example/order/OrderCompleted.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2022-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package example.order;
+
+import example.order.Order.OrderIdentifier;
+
+import org.jmolecules.event.types.DomainEvent;
+import org.springframework.modulith.events.Externalized;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@Externalized
+public record OrderCompleted(OrderIdentifier orderId) implements DomainEvent {}

spring-modulith-examples/spring-modulith-example-kafka/src/main/java/example/order/OrderManagement.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2022-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package example.order;
+
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+
+import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@Service
+@RequiredArgsConstructor
+public class OrderManagement {
+
+	private final @NonNull ApplicationEventPublisher events;
+
+	@Transactional
+	public void complete(Order order) {
+		events.publishEvent(new OrderCompleted(order.getId()));
+	}
+}

spring-modulith-examples/spring-modulith-example-kafka/src/main/java/example/order/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * The logical application module order implemented as a multi-package module. Internal components located in nested
+ * packages are prevented from being accessed by the {@link org.springframework.modulith.core.ApplicationModules} type.
+ *
+ * @see example.ModularityTests
+ */
+@org.springframework.lang.NonNullApi
+package example.order;

spring-modulith-examples/spring-modulith-example-kafka/src/main/resources/application.properties

@@ -0,0 +1 @@
+spring.jpa.show-sql=true

spring-modulith-examples/spring-modulith-example-kafka/src/main/resources/logback.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+
+	<property name="CONSOLE_LOG_PATTERN" value="%d{HH:mm:ss.SSS} %1.-1level - %8.8t : %m%n%wEx" />
+
+	<include resource="org/springframework/boot/logging/logback/defaults.xml" />
+	<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
+
+	<root level="INFO">
+		<appender-ref ref="CONSOLE" />
+	</root>
+
+	<logger name="com.tngtech.archunit" level="WARN" />
+	<logger name="org.springframework.modulith" level="DEBUG" />
+
+</configuration>

spring-modulith-examples/spring-modulith-example-kafka/src/test/java/example/TestApplication.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package example;
+
+import static org.mockito.ArgumentMatchers.*;
+import static org.mockito.Mockito.*;
+
+import example.order.Order;
+import example.order.OrderManagement;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Primary;
+import org.springframework.kafka.core.KafkaOperations;
+
+/**
+ * @author Oliver Drotbohm
+ */
+@SpringBootApplication
+public class TestApplication {
+
+	private static final Logger logger = LoggerFactory.getLogger(TestApplication.class);
+
+	@Bean
+	@Primary
+	@SuppressWarnings("unchecked")
+	KafkaOperations<?, ?> kafkaOperations() {
+
+		var mock = mock(KafkaOperations.class);
+
+		when(mock.send(any(), any())).then(invocation -> {
+
+			logger.info("Sending message {} to {}.", invocation.getArguments()[1], invocation.getArguments()[0]);
+
+			return null;
+		});
+
+		return mock;
+	}
+
+	public static void main(String[] args) {
+
+		var orders = SpringApplication.run(TestApplication.class, args)
+				.getBean(OrderManagement.class);
+
+		logger.info("Triggering order completion…");
+
+		orders.complete(new Order());
+	}
+}