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

GH-267 - Explicitly declared empty allowed dependencies now forbids any dependency.

Browse Source 
The default for @ApplicationModule(allowedDependencies) is now a single element list with a dedicated token we recognize as "all dependencies allowed". This allows users to declare an empty array explicitly to disallow any outgoing dependencies for an application module. Previously, such a declaration would have allowed any dependency.
This commit is contained in:
Oliver Drotbohm
2023-08-15 19:52:02 +02:00
parent cec759af0c
commit 9568f29613
11 changed files with 221 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
spring-modulith-api/src/main/java/org/springframework/modulith/ApplicationModule.java
View File

@@ -29,6 +29,8 @@ import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
public @interface ApplicationModule {
public static final String OPEN_TOKEN = "¯\\_(ツ)_/¯";
/**
* The human readable name of the module to be used for display and documentation purposes.
*
@@ -37,14 +39,17 @@ public @interface ApplicationModule {
String displayName() default "";
/**
* List the names of modules that the module is allowed to depend on. Shared modules defined in {@link Modulith} will
* be allowed, too. Names listed are local ones, unless the application has configured
* {@link Modulithic#useFullyQualifiedModuleNames()} to {@literal true}. Explicit references to
* List the names of modules that the module is allowed to depend on. Shared modules defined in
* {@link Modulith}/{@link Modulithic} will be allowed, too. Names listed are local ones, unless the application has
* configured {@link Modulithic#useFullyQualifiedModuleNames()} to {@literal true}. Explicit references to
* {@link NamedInterface}s need to be separated by a double colon {@code ::}, e.g. {@code module::API} if
* {@code module} is the logical module name and {@code API} is the name of the named interface.
* <p>
* Declaring an empty array will allow no dependencies to other modules. To not restrict the dependencies at all,
* leave the attribute at its default value.
*
* @return will never be {@literal null}.
* @see NamedInterface
*/
String[] allowedDependencies() default {};
String[] allowedDependencies() default { OPEN_TOKEN };
}