• Stars
    star
    741
  • Rank 61,194 (Top 2 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created over 2 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Modular applications with Spring Boot

Spring Modulith Revved up by Gradle Enterprise

Spring Modulith allows developers to build well-structured Spring Boot applications and guides developers in finding and working with application modules driven by the domain. It supports the verification of such modular arrangements, integration testing individual modules, observing the applicationโ€™s behavior on the module level and creating documentation snippets based on the arrangement created.

Quickstart

  1. Create a Spring Boot application on https://start.spring.io

  2. Add Spring Modulith to your application by adding this to your pom.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>
  3. Create a Java package arrangement that puts business modules as direct sub-packages of the applicationโ€™s main package.

    โ–ก Example
    โ””โ”€ โ–ก src/main/java
       โ”œโ”€ โ–ก example           <1>
       |  โ””โ”€ Application.java
       โ”œโ”€ โ–ก example.inventory <2>
       |  โ””โ”€ โ€ฆ
       โ””โ”€ โ–ก example.order     <2>
          โ””โ”€ โ€ฆ
    1. The application root package

    2. Application module packages

  4. Create an ApplicationModules model, run verifications and create documentation snippets.

    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 verifies its structure.

    2. Renders Asciidoctor snippets (component diagrams, application module canvas) to target/modulith-docs.

  5. Run integration tests for individual application modules.

    โ–ก Example
    โ””โ”€ โ–ก src/test/java
       โ””โ”€ โ–ก example.order
          โ””โ”€ OrderModuleIntegrationTests.java
    @ApplicationModuleTests
    class OrderModuleIntegrationTests {
    
      @Test
      void someTestMethod() { โ€ฆ }
    }

Reference documentation

Find the reference documentation here.

Contributing

Pull requests are welcome. Note, that we expect everyone to follow the code of conduct.

License

Spring Modulith is Open Source software released under the Apache 2.0 license.

More Repositories

1

spring-boot

Spring Boot
Java
73,985
star
2

spring-framework

Spring Framework
Java
55,858
star
3

spring-security

Spring Security
Java
8,623
star
4

spring-petclinic

A sample Spring-based application
CSS
7,457
star
5

spring-data-examples

Spring Data Example Projects
Java
5,142
star
6

spring-authorization-server

Spring Authorization Server
Java
4,799
star
7

spring-data-jpa

Simplifies the development of creating a JPA-based data access layer.
Java
2,951
star
8

spring-data-elasticsearch

Provide support to increase developer productivity in Java when using Elasticsearch. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
2,907
star
9

spring-ai

An Application Framework for AI Engineering
Java
2,808
star
10

spring-loaded

Java agent that enables class reloading in a running JVM
Java
2,714
star
11

spring-batch

Spring Batch is a framework for writing batch applications using Java and Spring
Java
2,661
star
12

spring-integration-samples

You are looking for examples, code snippets, sample applications for Spring Integration? This is the place.
Java
2,302
star
13

spring-kafka

Provides Familiar Spring Abstractions for Apache Kafka
Java
2,180
star
14

spring-retry

Java
2,128
star
15

spring-session

Spring Session
Java
1,853
star
16

spring-data-redis

Provides support to increase developer productivity in Java when using Redis, a key-value store. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
1,733
star
17

spring-data-mongodb

Provides support to increase developer productivity in Java when using MongoDB. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
1,593
star
18

spring-statemachine

Spring Statemachine is a framework for application developers to use state machine concepts with Spring.
Java
1,553
star
19

spring-integration

Spring Integration provides an extension of the Spring programming model to support the well-known Enterprise Integration Patterns (EIP)
Java
1,519
star
20

spring-graphql

Spring Integration for GraphQL
Java
1,509
star
21

spring-security-samples

Java
1,349
star
22

spring-restdocs

Test-driven documentation for RESTful services
Java
1,154
star
23

spring-hateoas

Spring HATEOAS - Library to support implementing representations for hyper-text driven REST web services.
Java
1,029
star
24

spring-data-rest

Simplifies building hypermedia-driven REST web services on top of Spring Data repositories
Java
910
star
25

sts4

The next generation of tooling for Spring Boot, including support for Cloud Foundry manifest files, Concourse CI pipeline definitions, BOSH deployment manifests, and more... - Available for Eclipse, Visual Studio Code, and Theia
Java
862
star
26

spring-net

Spring Framework for .NET
C#
843
star
27

spring-cloud

Umbrella project for Spring Cloud
821
star
28

spring-data-neo4j

Provide support to increase developer productivity in Java when using Neo4j. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
820
star
29

spring-amqp

Spring AMQP - support for Spring programming model with AMQP, especially but not limited to RabbitMQ
Java
796
star
30

spring-data-commons

Spring Data Commons. Interfaces and code shared between the various datastore specific implementations.
Java
757
star
31

spring-data-relational

Spring Data Relational. Home of Spring Data JDBC and Spring Data R2DBC.
Java
742
star
32

spring-shell

Spring based shell
Java
712
star
33

spring-data-r2dbc

Provide support to increase developer productivity in Java when using Reactive Relational Database Connectivity. Uses familiar Spring concepts such as a DatabaseClient for core API usage and lightweight repository style data access.
708
star
34

spring-amqp-samples

Samples for Spring AMQP
Java
588
star
35

spring-plugin

Java
438
star
36

spring-webflow-samples

CSS
411
star
37

spring-hateoas-examples

Collection of examples on how (and why) to build hypermedia-driven apps with Spring HATEOAS
Java
375
star
38

spring-data-cassandra

Provides support to increase developer productivity in Java when using Apache Cassandra. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
374
star
39

spring-ldap

Spring LDAP
Java
341
star
40

spring-webflow

Spring Web Flow
Java
324
star
41

spring-ws

Spring Web Services
Java
316
star
42

spring-flo

JavaScript angular based embeddable graphical component for pipeline/graph building and editing
TypeScript
301
star
43

spring-vault

Provides familiar Spring abstractions for HashiCorp Vault
Java
280
star
44

spring-integration-extensions

The Spring Integration Extensions project provides extension components for Spring Integration
Java
279
star
45

spring-data-couchbase

Provides support to increase developer productivity in Java when using Couchbase. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
273
star
46

spring-data-envers

Envers extension of the Spring Data JPA module
262
star
47

spring-batch-extensions

Spring Batch Extensions
Java
241
star
48

spring-integration-aws

Java
209
star
49

spring-pulsar

Spring Friendly Abstractions for Apache Pulsar
Java
183
star
50

spring-security-kerberos

Spring Security Kerberos
Java
179
star
51

spring-guice

Tools for using Spring in Guice and Guice in Spring
Java
172
star
52

spring-ws-samples

Java
147
star
53

gradle-plugins

Gradle plugins for use in building and publishing open-source Spring projects, e.g. Spring Framework, Spring Integration
Groovy
139
star
54

spring-data-keyvalue

Project to provide infrastructure to implement Spring Data repositories on top of key-value-based, in-memory data stores.
Java
133
star
55

spring-data-build

Modules to centralize common resources and configuration for Spring Data Maven builds.
Shell
100
star
56

spring-data-gemfire

Spring Data integration for Pivotal GemFire
Java
99
star
57

spring-cli

A CLI focused on developer productivity
Java
94
star
58

spring-data

Spring Data
87
star
59

spring-data-ldap

Repository abstraction for Spring LDAP
Java
66
star
60

spring-aot-smoke-tests

Smoke tests for Spring's AOT and native support
Java
51
star
61

spring-data-geode

Spring Data support for Apache Geode
Java
50
star
62

spring-session-data-mongodb

Spring Session for MongoDB
Java
47
star
63

spring-boot-data-geode

Spring Boot support for Apache Geode and VMware GemFire
Java
44
star
64

spring-data-dev-tools

A collection of tools to support Spring Data development.
Java
41
star
65

spring-restdocs-samples

JavaScript
32
star
66

spring-session-bom

Spring Session Bill of Materials
Java
32
star
67

spring-credhub

Spring abstractions for Cloud Foundry CredHub
Java
26
star
68

spring-lifecycle-smoke-tests

Java
26
star
69

spring-integration-splunk

Java
22
star
70

spring-test-data-geode

A Spring-based Test Framework supporting Unit and Integration testing for Spring Boot applications using Spring Data with either Apache Geode or VMware Tanzu GemFire
Java
21
star
71

spring-session-data-geode

Spring Session support for Apache Geode and VMware Tanzu GemFire
Java
20
star
72

spring-data-bom

Spring Data Bill of Materials
18
star
73

security-advisories

Report a Spring CVE
17
star
74

spring-session-data-mongodb-examples

Java
16
star
75

eclipse-integration-tcserver

Eclipse Integration for vFabric tc Server
Java
15
star
76

spring-graphql-examples

Spring for GraphQL Examples
Java
11
star
77

spring-integration-flow

Java
10
star
78

gh-pages

Shared gh-pages content for Spring projects
JavaScript
8
star
79

spring-data-release

Command-line application to ship Spring Data releases
Java
7
star
80

.github

7
star
81

spring-rewrite-commons

Java
6
star