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

GH-652 - Allow to configure the ApplicationModuleDetectionStrategy via a configuration property.

Browse Source 
We now expose a configuration property spring.modulith.detection-strategy that can take either of the two prepared values "direct-sub-packages" (default) or "explicitly-annotated", or a fully qualified class name of the strategy to use.

Removed ApplicationModuleStrategies enum to avoid exposing the enum values as additional implementations. Those are now held as inline lambda expression in the factory methods on ApplicationModuleStrategy. Extracted the lookup of the strategy to use into ApplicationModuleDetectionStrategyLookup for easier testability.
This commit is contained in:
Oliver Drotbohm
2024-06-05 17:35:45 +02:00
parent 1aef1b6191
commit ed1cb3fc91
11 changed files with 236 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/docs/antora/modules/ROOT/pages/fundamentals.adoc
View File

@@ -348,12 +348,23 @@ package example.inventory
[[customizing-modules]]
=== Customizing Module Detection
If the default application module model does not work for your application, the detection of the modules can be customized by providing an implementation of `ApplicationModuleDetectionStrategy`.
By default, application modules will be expected to be located in direct sub-packages of the package the Spring Boot application class resides in.
An alternative detection strategy can be activated to only consider package explicitly annotated, either via Spring Modulith's `@ApplicationModule` or jMolecules `@Module` annotation.
That strategy can be activated by configuring the `spring.modulith.detection-strategy` to `explicitly-annotated`.
.Switching the application module detection strategy to only consider annotated packages
[source, text]
----
spring.modulith.detection-strategy=explicitly-annotated
----
If the neither default application module detection strategy nor the manually annotated one does not work for your application, the detection of the modules can be customized by providing an implementation of `ApplicationModuleDetectionStrategy`.
That interface exposes a single method `Stream<JavaPackage> getModuleBasePackages(JavaPackage)` and will be called with the package the Spring Boot application class resides in.
You can then inspect the packages residing within that and select the ones to be considered application module base packages based on a naming convention or the like.
Assume you declare a custom `ApplicationModuleDetectionStrategy` implementation like this:
.Implementing a custom `ApplicationModuleDetectionStrategy`
[tabs]
======
Java::
@@ -385,12 +396,11 @@ class CustomApplicationModuleDetectionStrategy : ApplicationModuleDetectionStrat
----
======
This class needs to be registered in `META-INF/spring.factories` as follows:
This class can now be registered as `spring.modulith.detection-strategy` as follows:
[source, text]
----
org.springframework.modulith.core.ApplicationModuleDetectionStrategy=\
example.CustomApplicationModuleDetectionStrategy
spring.modulith.detection-strategy=example.CustomApplicationModuleDetectionStrategy
----
[[customizing-modules-arrangement]]