Spring Modulith

https://spring.io/projects/spring-modulith

Admin

Spring Modulith enables developers to build well-structured Spring Boot applications with modular...

Tokens:526

Snippets:5

Trust Score:10

Update:1 week ago

Show doc for...

Tokens:

Raw

### Package structure for modular application

Source: https://spring.io/projects/spring-modulith

Shows the recommended package layout: the application root package (example) with sub-packages for each business module (example.inventory, example.order).

```text
└─ □ src/main/java
   ├─ □ example           <1>
   │  └─ Application.java
   ├─ □ example.inventory <2>
   │  └─ …
   └─ □ example.order     <2>
      └─ …

```

--------------------------------

### Integration test for an application module

Source: https://spring.io/projects/spring-modulith

Shows the test package structure and an example integration test class for the order module, annotated with @ApplicationModuleTests.

```text
└─ □ src/test/java
   └─ □ example.order
      └─ OrderModuleIntegrationTests.java

```

```java
@ApplicationModuleTests
class OrderModuleIntegrationTests {

  @Test
  void someTestMethod() { … }
}

```

--------------------------------

### ApplicationModules verification and documentation snippet generation

Source: https://spring.io/projects/spring-modulith

Test method that creates an ApplicationModules model from the application class, verifies its structure, and uses Documenter to write Asciidoctor snippets (component diagrams, application module canvas) to target/modulith-docs.

```java
class ApplicationTests {

  @Test
  void writeDocumentationSnippets() {

    var modules = ApplicationModules.of(Application.class).verify(); (1)

    new Documenter(modules) (2)
      .writeModulesAsPlantUml()
      .writeIndividualModulesAsPlantUml();
  }
}

```

Tokens:

Raw