Spring/spring-modulith
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-181 - Create dedicated submodule for examples.

Browse Source 
Move already existing example underneath that. Added examples for JDBC- and MongoDB-based event publication registry setups.
This commit is contained in:
Oliver Drotbohm
2023-04-29 12:36:59 +02:00
parent 94093a3081
commit 594c22a4c8
46 changed files with 897 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
pom.xml
View File

@@ -99,7 +99,7 @@ limitations under the License.
<modules>
<module>spring-modulith-integration-test</module>
<module>spring-modulith-example</module>
<module>spring-modulith-examples</module>
</modules>
</profile>
@@ -132,7 +132,7 @@ limitations under the License.
<modules>
<module>spring-modulith-distribution</module>
<module>spring-modulith-example</module>
<module>spring-modulith-examples</module>
<module>spring-modulith-integration-test</module>
</modules>

88
spring-modulith-example/pom.xml → spring-modulith-examples/pom.xml
View File

@@ -1,17 +1,25 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.0.3</version>
<version>3.1.0-RC1</version>
<relativePath />
</parent>
<artifactId>spring-modulith-example</artifactId>
<name>Spring Modulith - Example</name>
<groupId>org.springframework.experimental</groupId>
<artifactId>spring-modulith-examples</artifactId>
<version>0.6.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>Spring Modulith - Examples</name>
<modules>
<module>spring-modulith-examples-epr-jdbc</module>
<module>spring-modulith-examples-epr-mongodb</module>
<module>spring-modulith-examples-full</module>
</modules>
<properties>
<java.version>17</java.version>
@@ -29,7 +37,7 @@
<dependency>
<groupId>org.jmolecules</groupId>
<artifactId>jmolecules-bom</artifactId>
<version>2022.2.2</version>
<version>2022.3.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@@ -48,53 +56,6 @@
<artifactId>spring-boot-starter-json</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.experimental</groupId>
<artifactId>spring-modulith-starter-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Actuator -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.experimental</groupId>
<artifactId>spring-modulith-actuator</artifactId>
</dependency>
<!-- jMolecules -->
<dependency>
<groupId>org.jmolecules</groupId>
<artifactId>jmolecules-ddd</artifactId>
</dependency>
<dependency>
<groupId>org.jmolecules</groupId>
<artifactId>jmolecules-events</artifactId>
</dependency>
<!-- Persistence -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>runtime</scope>
</dependency>
<!-- Testing -->
<dependency>
@@ -111,12 +72,6 @@
<!-- Infrastructure -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
@@ -126,6 +81,13 @@
</dependencies>
<repositories>
<repository>
<id>spring-milestone</id>
<url>https://repo.spring.io/milestone</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>spring-snapshot</id>
<url>https://repo.spring.io/snapshot</url>
@@ -136,6 +98,13 @@
</repositories>
<pluginRepositories>
<pluginRepository>
<id>spring-milestone</id>
<url>https://repo.spring.io/milestone</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>spring-snapshot</id>
<url>https://repo.spring.io/snapshot</url>
@@ -144,4 +113,5 @@
</releases>
</pluginRepository>
</pluginRepositories>
</project>

61
spring-modulith-examples/spring-modulith-examples-epr-jdbc/pom.xml Normal file
View File

@@ -0,0 +1,61 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.experimental</groupId>
<artifactId>spring-modulith-examples</artifactId>
<version>0.6.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>spring-modulith-examples-epr-jdbc</artifactId>
<name>Spring Modulith - Examples - EPR JDBC Example</name>
<dependencies>
<dependency>
<groupId>org.springframework.experimental</groupId>
<artifactId>spring-modulith-starter-jdbc</artifactId>
</dependency>
<!-- jMolecules -->
<dependency>
<groupId>org.jmolecules</groupId>
<artifactId>jmolecules-events</artifactId>
</dependency>
<!-- Persistence -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>postgresql</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-testcontainers</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
</project>

0
spring-modulith-example/src/main/asciidoc/index.adoc → spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/main/asciidoc/index.adoc
View File

29
spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/main/java/example/Application.java Normal file
View File

@@ -0,0 +1,29 @@
/*
* 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;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* Spring Modulith example application
*
* @author Oliver Drotbohm
*/
@SpringBootApplication
public class Application {
public static void main(String... args) throws Exception {}
}

53
spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/main/java/example/inventory/InventoryManagement.java Normal file
View File

@@ -0,0 +1,53 @@
/*
* 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.inventory;
import example.order.OrderCompleted;
import lombok.RequiredArgsConstructor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.modulith.ApplicationModuleListener;
import org.springframework.stereotype.Service;
/**
* A Spring {@link Service} exposed by the inventory module.
*
* @author Oliver Drotbohm
*/
@Service
@RequiredArgsConstructor
class InventoryManagement {
private static final Logger LOG = LoggerFactory.getLogger(InventoryManagement.class);
private final ApplicationEventPublisher events;
@ApplicationModuleListener
void on(OrderCompleted event) throws InterruptedException {
var orderId = event.orderId();
LOG.info("Received order completion for {}.", orderId);
// Simulate busy work
Thread.sleep(1000);
events.publishEvent(new InventoryUpdated(orderId));
LOG.info("Finished order completion for {}.", orderId);
}
}

23
spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/main/java/example/inventory/InventoryUpdated.java Normal file
View File

@@ -0,0 +1,23 @@
/*
* 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.inventory;
import java.util.UUID;
/**
* @author Oliver Drotbohm
*/
public record InventoryUpdated(UUID orderId) {}

0
spring-modulith-example/src/main/java/example/inventory/package-info.java → spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/main/java/example/inventory/package-info.java
View File

25
spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/main/java/example/order/OrderCompleted.java Normal file
View File

@@ -0,0 +1,25 @@
/*
* 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 java.util.UUID;
import org.jmolecules.event.types.DomainEvent;
/**
* @author Oliver Drotbohm
*/
public record OrderCompleted(UUID orderId) implements DomainEvent {}

40
spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/main/java/example/order/OrderManagement.java Normal file
View File

@@ -0,0 +1,40 @@
/*
* 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 java.util.UUID;
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() {
events.publishEvent(new OrderCompleted(UUID.randomUUID()));
}
}

0
spring-modulith-example/src/main/java/example/order/package-info.java → spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/main/java/example/order/package-info.java
View File

2
spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/main/resources/application.properties Normal file
View File

@@ -0,0 +1,2 @@
spring.jpa.show-sql=true
spring.modulith.events.jdbc.schema-initialization.enabled=true

14
spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/main/resources/logback.xml Normal file
View File

@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<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="org.springframework.modulith" level="INFO"/>
<logger name="example" level="INFO" />
</configuration>

66
spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/test/java/example/ApplicationIntegrationTests.java Normal file
View File

@@ -0,0 +1,66 @@
/*
* 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;
import example.inventory.InventoryUpdated;
import example.order.OrderManagement;
import java.util.Collection;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
import org.springframework.context.annotation.Bean;
import org.springframework.modulith.events.EventPublicationRegistry;
import org.springframework.modulith.test.EnableScenarios;
import org.springframework.modulith.test.Scenario;
import org.testcontainers.containers.PostgreSQLContainer;
import org.testcontainers.junit.jupiter.Testcontainers;
/**
* Integration test for the overall application.
*
* @author Oliver Drotbohm
*/
@SpringBootTest
@EnableScenarios
@Testcontainers(disabledWithoutDocker = true)
class ApplicationIntegrationTests {
@Autowired OrderManagement orders;
@Autowired EventPublicationRegistry registry;
@TestConfiguration
static class Infrastructure {
@ServiceConnection
@Bean(initMethod = "start", destroyMethod = "stop")
PostgreSQLContainer<?> database() {
return new PostgreSQLContainer<>("postgres:15.2");
}
}
@Test
void bootstrapsApplication(Scenario scenario) throws Exception {
scenario.stimulate(() -> orders.complete())
.andWaitForStateChange(() -> registry.findIncompletePublications(), Collection::isEmpty)
.andExpect(InventoryUpdated.class)
.toArrive();
}
}

0
spring-modulith-example/src/test/java/example/ModularityTests.java → spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/test/java/example/ModularityTests.java
View File

15
spring-modulith-examples/spring-modulith-examples-epr-jdbc/src/test/resources/logback.xml Normal file
View File

@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<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="org.springframework.modulith" level="WARN"/>
<logger name="com.github.dockerjava" level="WARN" />
<logger name="example" level="INFO" />
</configuration>

56
spring-modulith-examples/spring-modulith-examples-epr-mongodb/pom.xml Normal file
View File

@@ -0,0 +1,56 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.experimental</groupId>
<artifactId>spring-modulith-examples</artifactId>
<version>0.6.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>spring-modulith-examples-epr-mongodb</artifactId>
<name>Spring Modulith - Examples - EPR MongoDB Example</name>
<dependencies>
<dependency>
<groupId>org.springframework.experimental</groupId>
<artifactId>spring-modulith-starter-mongodb</artifactId>
</dependency>
<!-- jMolecules -->
<dependency>
<groupId>org.jmolecules</groupId>
<artifactId>jmolecules-events</artifactId>
</dependency>
<!-- Persistence -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>mongodb</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-testcontainers</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
</project>

16
spring-modulith-examples/spring-modulith-examples-epr-mongodb/src/main/asciidoc/index.adoc Normal file
View File

@@ -0,0 +1,16 @@
= Spring Modulith Example Documentation
:modulith-docs: ../../../target/spring-modulith-docs
== Overview
plantuml::{modulith-docs}/components.puml[format="svg"]
== Inventory
plantuml::{modulith-docs}/module-inventory.puml[format="svg"]
include::{modulith-docs}/module-inventory.adoc[]
== Orders
plantuml::{modulith-docs}/module-order.puml[format="svg"]
include::{modulith-docs}/module-order.adoc[]

29
spring-modulith-examples/spring-modulith-examples-epr-mongodb/src/main/java/example/Application.java Normal file
View File

@@ -0,0 +1,29 @@
/*
* 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;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* Spring Modulith example application
*
* @author Oliver Drotbohm
*/
@SpringBootApplication
public class Application {
public static void main(String... args) {}
}

53
spring-modulith-examples/spring-modulith-examples-epr-mongodb/src/main/java/example/inventory/InventoryManagement.java Normal file
View File

@@ -0,0 +1,53 @@
/*
* 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.inventory;
import example.order.OrderCompleted;
import lombok.RequiredArgsConstructor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.modulith.ApplicationModuleListener;
import org.springframework.stereotype.Service;
/**
* A Spring {@link Service} exposed by the inventory module.
*
* @author Oliver Drotbohm
*/
@Service
@RequiredArgsConstructor
class InventoryManagement {
private static final Logger LOG = LoggerFactory.getLogger(InventoryManagement.class);
private final ApplicationEventPublisher events;
@ApplicationModuleListener
void on(OrderCompleted event) throws InterruptedException {
var orderId = event.orderId();
LOG.info("Received order completion for {}.", orderId);
// Simulate busy work
Thread.sleep(1000);
events.publishEvent(new InventoryUpdated(orderId));
LOG.info("Finished order completion for {}.", orderId);
}
}

23
spring-modulith-examples/spring-modulith-examples-epr-mongodb/src/main/java/example/inventory/InventoryUpdated.java Normal file
View File

@@ -0,0 +1,23 @@
/*
* 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.inventory;
import java.util.UUID;
/**
* @author Oliver Drotbohm
*/
public record InventoryUpdated(UUID orderId) {}

8
spring-modulith-examples/spring-modulith-examples-epr-mongodb/src/main/java/example/inventory/package-info.java Normal file
View File

@@ -0,0 +1,8 @@
/**
* The logical application module inventory implemented as a single-package module. Allows to hide application
* components inside the module by using package scoped types.
*
* @see example.inventory.InventoryInternal
*/
@org.springframework.lang.NonNullApi
package example.inventory;

25
spring-modulith-examples/spring-modulith-examples-epr-mongodb/src/main/java/example/order/OrderCompleted.java Normal file
View File

@@ -0,0 +1,25 @@
/*
* 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 java.util.UUID;
import org.jmolecules.event.types.DomainEvent;
/**
* @author Oliver Drotbohm
*/
public record OrderCompleted(UUID orderId) implements DomainEvent {}

40
spring-modulith-examples/spring-modulith-examples-epr-mongodb/src/main/java/example/order/OrderManagement.java Normal file
View File

@@ -0,0 +1,40 @@
/*
* 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 java.util.UUID;
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() {
events.publishEvent(new OrderCompleted(UUID.randomUUID()));
}
}

8
spring-modulith-examples/spring-modulith-examples-epr-mongodb/src/main/java/example/order/package-info.java Normal file
View File

@@ -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;

83
spring-modulith-examples/spring-modulith-examples-epr-mongodb/src/test/java/example/ApplicationIntegrationTests.java Normal file
View File

@@ -0,0 +1,83 @@
/*
* 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;
import example.inventory.InventoryUpdated;
import example.order.OrderManagement;
import java.util.Collection;
import org.bson.UuidRepresentation;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
import org.springframework.context.annotation.Bean;
import org.springframework.modulith.events.EventPublicationRegistry;
import org.springframework.modulith.test.EnableScenarios;
import org.springframework.modulith.test.Scenario;
import org.testcontainers.containers.MongoDBContainer;
import org.testcontainers.junit.jupiter.Testcontainers;
import com.mongodb.ConnectionString;
import com.mongodb.MongoClientSettings;
import com.mongodb.client.MongoClient;
import com.mongodb.client.MongoClients;
/**
* Integration test for the overall application.
*
* @author Oliver Drotbohm
*/
@SpringBootTest
@EnableScenarios
@Testcontainers(disabledWithoutDocker = true)
class ApplicationIntegrationTests {
@TestConfiguration
static class MongoDbInfrastructureConfiguration {
@ServiceConnection
@Bean(initMethod = "start", destroyMethod = "stop")
MongoDBContainer mongoDBContainer() {
return new MongoDBContainer("mongo:6.0.3");
}
@Bean
public MongoClient mongoClient(MongoDBContainer container) {
var settings = MongoClientSettings.builder()
.uuidRepresentation(UuidRepresentation.STANDARD)
.applyConnectionString(new ConnectionString(container.getReplicaSetUrl()))
.build();
return MongoClients.create(settings);
}
}
@Autowired OrderManagement orders;
@Autowired EventPublicationRegistry registry;
@Test
void bootstrapsApplication(Scenario scenario) throws Exception {
scenario.stimulate(() -> orders.complete())
.andWaitForStateChange(() -> registry.findIncompletePublications(), Collection::isEmpty)
.andExpect(InventoryUpdated.class)
.toArrive();
}
}

40
spring-modulith-examples/spring-modulith-examples-epr-mongodb/src/test/java/example/ModularityTests.java Normal file
View File

@@ -0,0 +1,40 @@
/*
* 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;
import org.junit.jupiter.api.Test;
import org.springframework.modulith.core.ApplicationModules;
import org.springframework.modulith.docs.Documenter;
/**
* Tests to verify the modular structure and generate documentation for the modules.
*
* @author Oliver Drotbohm
*/
class ModularityTests {
ApplicationModules modules = ApplicationModules.of(Application.class);
@Test
void verifiesModularStructure() {
modules.verify();
}
@Test
void createModuleDocumentation() {
new Documenter(modules).writeDocumentation();
}
}

16
spring-modulith-examples/spring-modulith-examples-epr-mongodb/src/test/resources/logback.xml Normal file
View File

@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<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="org.springframework.data.mongodb" level="DEBUG"/>
<logger name="org.springframework.modulith" level="DEBUG"/>
<logger name="com.github.dockerjava" level="WARN" />
<logger name="example" level="INFO" />
</configuration>

69
spring-modulith-examples/spring-modulith-examples-full/pom.xml Normal file
View File

@@ -0,0 +1,69 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.experimental</groupId>
<artifactId>spring-modulith-examples</artifactId>
<version>0.6.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>spring-modulith-examples-full</artifactId>
<name>Spring Modulith - Examples - Full Example</name>
<dependencies>
<dependency>
<groupId>org.springframework.experimental</groupId>
<artifactId>spring-modulith-starter-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Actuator -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.experimental</groupId>
<artifactId>spring-modulith-actuator</artifactId>
</dependency>
<!-- jMolecules -->
<dependency>
<groupId>org.jmolecules.integrations</groupId>
<artifactId>jmolecules-starter-ddd</artifactId>
</dependency>
<!-- Persistence -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>runtime</scope>
</dependency>
<!-- Infrastructure -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
</project>

16
spring-modulith-examples/spring-modulith-examples-full/src/main/asciidoc/index.adoc Normal file
View File

@@ -0,0 +1,16 @@
= Spring Modulith Example Documentation
:modulith-docs: ../../../target/spring-modulith-docs
== Overview
plantuml::{modulith-docs}/components.puml[format="svg"]
== Inventory
plantuml::{modulith-docs}/module-inventory.puml[format="svg"]
include::{modulith-docs}/module-inventory.adoc[]
== Orders
plantuml::{modulith-docs}/module-order.puml[format="svg"]
include::{modulith-docs}/module-order.adoc[]

0
spring-modulith-example/src/main/java/example/Application.java → spring-modulith-examples/spring-modulith-examples-full/src/main/java/example/Application.java
View File

0
spring-modulith-example/src/main/java/example/inventory/InventoryInternal.java → spring-modulith-examples/spring-modulith-examples-full/src/main/java/example/inventory/InventoryInternal.java
View File

0
spring-modulith-example/src/main/java/example/inventory/InventoryManagement.java → spring-modulith-examples/spring-modulith-examples-full/src/main/java/example/inventory/InventoryManagement.java
View File

0
spring-modulith-example/src/main/java/example/inventory/InventorySettings.java → spring-modulith-examples/spring-modulith-examples-full/src/main/java/example/inventory/InventorySettings.java
View File

8
spring-modulith-examples/spring-modulith-examples-full/src/main/java/example/inventory/package-info.java Normal file
View File

@@ -0,0 +1,8 @@
/**
* The logical application module inventory implemented as a single-package module. Allows to hide application
* components inside the module by using package scoped types.
*
* @see example.inventory.InventoryInternal
*/
@org.springframework.lang.NonNullApi
package example.inventory;

0
spring-modulith-example/src/main/java/example/order/Order.java → spring-modulith-examples/spring-modulith-examples-full/src/main/java/example/order/Order.java
View File

0
spring-modulith-example/src/main/java/example/order/OrderCompleted.java → spring-modulith-examples/spring-modulith-examples-full/src/main/java/example/order/OrderCompleted.java
View File

0
spring-modulith-example/src/main/java/example/order/OrderManagement.java → spring-modulith-examples/spring-modulith-examples-full/src/main/java/example/order/OrderManagement.java
View File

0
spring-modulith-example/src/main/java/example/order/internal/OrderInternal.java → spring-modulith-examples/spring-modulith-examples-full/src/main/java/example/order/internal/OrderInternal.java
View File

8
spring-modulith-examples/spring-modulith-examples-full/src/main/java/example/order/package-info.java Normal file
View File

@@ -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;

0
spring-modulith-example/src/main/resources/application.properties → spring-modulith-examples/spring-modulith-examples-full/src/main/resources/application.properties
View File

0
spring-modulith-example/src/main/resources/logback.xml → spring-modulith-examples/spring-modulith-examples-full/src/main/resources/logback.xml
View File

0
spring-modulith-example/src/test/java/example/ApplicationIntegrationTests.java → spring-modulith-examples/spring-modulith-examples-full/src/test/java/example/ApplicationIntegrationTests.java
View File

40
spring-modulith-examples/spring-modulith-examples-full/src/test/java/example/ModularityTests.java Normal file
View File

@@ -0,0 +1,40 @@
/*
* 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;
import org.junit.jupiter.api.Test;
import org.springframework.modulith.core.ApplicationModules;
import org.springframework.modulith.docs.Documenter;
/**
* Tests to verify the modular structure and generate documentation for the modules.
*
* @author Oliver Drotbohm
*/
class ModularityTests {
ApplicationModules modules = ApplicationModules.of(Application.class);
@Test
void verifiesModularStructure() {
modules.verify();
}
@Test
void createModuleDocumentation() {
new Documenter(modules).writeDocumentation();
}
}

0
spring-modulith-example/src/test/java/example/order/EventPublicationRegistryTests.java → spring-modulith-examples/spring-modulith-examples-full/src/test/java/example/order/EventPublicationRegistryTests.java
View File

0
spring-modulith-example/src/test/java/example/order/OrderIntegrationTests.java → spring-modulith-examples/spring-modulith-examples-full/src/test/java/example/order/OrderIntegrationTests.java
View File