78434cec48
This change publishes a build scan to ge.spring.io for every local build from an authenticated Spring committer and for CI where appropriate access tokens are available. The build will not fail if publishing fails. This change also allows the build to benefit from local and remote build caching, providing faster builds for all contributors. Additionally, the project will have access to all features of Gradle Enterprise such as: - Dashboards to view all historical build scans, along with performance trends over time - Build failure analytics for enhanced investigation and diagnosis of build failures - Test failure analytics to better understand trends and causes around slow, failing, and flaky tests
113 lines
3.8 KiB
Plaintext
113 lines
3.8 KiB
Plaintext
= Spring Modulith image:https://img.shields.io/badge/Revved%20up%20by-Gradle%20Enterprise-06A0CE?logo=Gradle&labelColor=02303A["Revved up by Gradle Enterprise", link="https://ge.spring.io/scans?search.rootProjectNames=Spring Modulith"]
|
|
|
|
:docs: https://docs.spring.io/spring-modulith/docs/current-SNAPSHOT/reference/html/
|
|
|
|
Spring Modulith allows developers to build well-structured Spring Boot applications and guides developers in finding and working with link:{docs}#fundamentals.modules.application-modules[application modules] driven by the domain.
|
|
It supports the link:{docs}#verification[verification] of such modular arrangements, link:{docs}#testing[integration testing] individual modules, link:{docs}#observability[observing] the application's behavior on the module level and creating link:{docs}#documentation[documentation snippets] based on the arrangement created.
|
|
|
|
== Quickstart
|
|
|
|
. Create a Spring Boot application on https://start.spring.io
|
|
. Add Spring Modulith to your application by adding this to your `pom.xml`:
|
|
+
|
|
[source, xml]
|
|
----
|
|
<!-- The Maven repository to pull the dependencies from -->
|
|
<repositories>
|
|
<repository>
|
|
<id>spring-snapshots</id>
|
|
<url>https://repo.spring.io/snapshot</url>
|
|
</repository>
|
|
</repositories>
|
|
|
|
<!-- Include the BOM for simplified version management -->
|
|
<dependencyManagement>
|
|
<dependencies>
|
|
<dependency>
|
|
<groupId>org.springframework.modulith</groupId>
|
|
<artifactId>spring-modulith-bom</artifactId>
|
|
<version>1.0.0-SNAPSHOT</version>
|
|
<scope>import</scope>
|
|
<type>pom</type>
|
|
</dependency>
|
|
</dependencies>
|
|
</dependencyManagement>
|
|
|
|
<dependencies>
|
|
|
|
<!-- The test dependency to pull in verification APIs -->
|
|
|
|
<dependency>
|
|
<groupId>org.springframework.modulith</groupId>
|
|
<artifactId>spring-modulith-starter-test</artifactId>
|
|
<scope>test</scope>
|
|
</dependency>
|
|
|
|
</dependencies>
|
|
----
|
|
. Create a Java package arrangement that puts business modules as link:{docs}#fundamentals[direct sub-packages of the application's main package].
|
|
+
|
|
[source, text, subs="macros"]
|
|
----
|
|
□ Example
|
|
└─ □ src/main/java
|
|
├─ □ example <1>
|
|
| └─ Application.java
|
|
├─ □ example.inventory <2>
|
|
| └─ …
|
|
└─ □ example.order <2>
|
|
└─ …
|
|
----
|
|
<1> The application root package
|
|
<2> Application module packages
|
|
. Create link:{docs}#fundamentals.modules.application-modules[an `ApplicationModules` model], run link:{docs}#verification[verifications] and link:{docs}#documentation[create documentation snippets].
|
|
+
|
|
[source, java]
|
|
----
|
|
class ApplicationTests {
|
|
|
|
@Test
|
|
void writeDocumentationSnippets() {
|
|
|
|
var modules = ApplicationModules.of(Application.class).verify(); <1>
|
|
|
|
new Documenter(modules) <2>
|
|
.writeModulesAsPlantUml()
|
|
.writeIndividualModulesAsPlantUml();
|
|
}
|
|
}
|
|
----
|
|
<1> Creates application module model and link:{docs}#verification[verifies its structure].
|
|
<2> Renders link:{docs}#documentation[Asciidoctor snippets] (component diagrams, application module canvas) to `target/modulith-docs`.
|
|
. Run link:{docs}#testing[integration tests] for individual application modules.
|
|
+
|
|
[source, text, subs="macros"]
|
|
----
|
|
□ Example
|
|
└─ □ src/test/java
|
|
└─ □ example.order
|
|
└─ OrderModuleIntegrationTests.java
|
|
----
|
|
+
|
|
[source, java]
|
|
----
|
|
@ApplicationModuleTests
|
|
class OrderModuleIntegrationTests {
|
|
|
|
@Test
|
|
void someTestMethod() { … }
|
|
}
|
|
----
|
|
|
|
== Reference documentation
|
|
|
|
Find the reference documentation link:{docs}[here].
|
|
|
|
== Contributing
|
|
|
|
https://help.github.com/articles/creating-a-pull-request[Pull requests] are welcome. Note, that we expect everyone to follow the https://github.com/spring-projects/.github/blob/main/CODE_OF_CONDUCT.md[code of conduct].
|
|
|
|
== License
|
|
Spring Modulith is Open Source software released under the
|
|
https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
|