GH-587 - ModulithMetadata now exposes all base packages.

Previously, we had a variety of places calculating the overall packages to inspect for types. This is now all consolidated into the ModulithMetadata abstraction exposing them directly.

Author: odrotbohm

spring-modulith-core/src/main/java/org/springframework/modulith/core/AnnotationModulithMetadata.java

@@ -15,6 +15,7 @@
  */
 package org.springframework.modulith.core;
 
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
@@ -34,6 +35,7 @@ class AnnotationModulithMetadata implements ModulithMetadata {
 
 	private final Class<?> modulithType;
 	private final Modulithic annotation;
+	private final String basePackage;
 
 	/**
 	 * Creates a new {@link AnnotationModulithMetadata} for the given type and annotation.
@@ -48,6 +50,7 @@ private AnnotationModulithMetadata(Class<?> modulithType, Modulithic annotation)
 
 		this.modulithType = modulithType;
 		this.annotation = annotation;
+		this.basePackage = modulithType.getPackageName();
 	}
 
 	/**
@@ -123,4 +126,17 @@ public Optional<String> getSystemName() {
 				.filter(StringUtils::hasText) //
 				.or(() -> Optional.of(modulithType.getSimpleName()));
 	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.modulith.core.ModulithMetadata#getBasePackages()
+	 */
+	@Override
+	public List<String> getBasePackages() {
+
+		var result = new ArrayList<>(List.of(basePackage));
+		result.addAll(List.of(annotation.additionalPackages()));
+
+		return result;
+	}
 }

spring-modulith-core/src/main/java/org/springframework/modulith/core/ApplicationModules.java

@@ -107,9 +107,40 @@ private static DescribedPredicate<CanBeAnnotated> getAtGenerated() {
 
 	private boolean verified;
 
+	/**
+	 * Creates a new {@link ApplicationModules} instance.
+	 *
+	 * @param metadata must not be {@literal null}.
+	 * @param ignored must not be {@literal null}.
+	 * @param useFullyQualifiedModuleNames can be {@literal null}.
+	 * @param option must not be {@literal null}.
+	 */
+	protected ApplicationModules(ModulithMetadata metadata,
+			DescribedPredicate<JavaClass> ignored, boolean useFullyQualifiedModuleNames, ImportOption option) {
+		this(metadata, metadata.getBasePackages(), ignored, useFullyQualifiedModuleNames, option);
+	}
+
+	/**
+	 * Creates a new {@link ApplicationModules} instance.
+	 *
+	 * @param metadata must not be {@literal null}.
+	 * @param packages must not be {@literal null}.
+	 * @param ignored must not be {@literal null}.
+	 * @param useFullyQualifiedModuleNames can be {@literal null}.
+	 * @param option must not be {@literal null}.
+	 * @deprecated since 1.2, for removal in 1.3. Use {@link ApplicationModules(ModulithMetadata, DescribedPredicate,
+	 *             boolean, ImportOption)} instead and set up {@link ModulithMetadata} to contain the packages you want to
+	 *             use.
+	 */
+	@Deprecated(forRemoval = true)
 	protected ApplicationModules(ModulithMetadata metadata, Collection<String> packages,
 			DescribedPredicate<JavaClass> ignored, boolean useFullyQualifiedModuleNames, ImportOption option) {
 
+		Assert.notNull(metadata, "ModulithMetadata must not be null!");
+		Assert.notNull(packages, "Base packages must not be null!");
+		Assert.notNull(ignored, "Ignores must not be null!");
+		Assert.notNull(option, "ImportOptions must not be null!");
+
 		this.metadata = metadata;
 		this.allClasses = new ClassFileImporter() //
 				.withImportOption(option) //
@@ -190,26 +221,33 @@ public static ApplicationModules of(Class<?> modulithType) {
 	}
 
 	/**
-	 * Creates a new {@link ApplicationModules} relative to the given modulith type, a
-	 * {@link ApplicationModuleDetectionStrategy} and a {@link DescribedPredicate} which types and packages to ignore.
-	 * Will inspect the {@link org.springframework.modulith.Modulith} and {@link org.springframework.modulith.Modulithic}
-	 * annotations on the class given for advanced customizations of the module setup.
+	 * Creates a new {@link ApplicationModules} relative to the given modulith type, and a {@link DescribedPredicate}
+	 * which types and packages to ignore. Will inspect the {@link org.springframework.modulith.Modulith} and
+	 * {@link org.springframework.modulith.Modulithic} annotations on the class given for advanced customizations of the
+	 * module setup.
 	 *
 	 * @param modulithType must not be {@literal null}.
 	 * @param ignored must not be {@literal null}.
 	 * @return will never be {@literal null}.
 	 */
 	public static ApplicationModules of(Class<?> modulithType, DescribedPredicate<JavaClass> ignored) {
 
-		CacheKey key = new TypeKey(modulithType, ignored);
+		Assert.notNull(modulithType, "Modulith root type must not be null!");
+		Assert.notNull(ignored, "Predicate to describe ignored types must not be null!");
 
-		return CACHE.computeIfAbsent(key, it -> {
-
-			Assert.notNull(modulithType, "Modulith root type must not be null!");
-			Assert.notNull(ignored, "Predicate to describe ignored types must not be null!");
+		return of(CacheKey.of(modulithType, ignored, IMPORT_OPTION));
+	}
 
-			return of(key);
-		});
+	/**
+	 * Creates a new {@link ApplicationModules} instance for the given type and {@link ImportOption}.
+	 *
+	 * @param modulithType must not be {@literal null}.
+	 * @param options must not be {@literal null}.
+	 * @return will never be {@literal null}.
+	 * @since 1.2
+	 */
+	public static ApplicationModules of(Class<?> modulithType, ImportOption options) {
+		return of(CacheKey.of(modulithType, alwaysFalse(), options));
 	}
 
 	/**
@@ -231,15 +269,22 @@ public static ApplicationModules of(String javaPackage) {
 	 */
 	public static ApplicationModules of(String javaPackage, DescribedPredicate<JavaClass> ignored) {
 
-		CacheKey key = new PackageKey(javaPackage, ignored);
-
-		return CACHE.computeIfAbsent(key, it -> {
+		Assert.hasText(javaPackage, "Base package must not be null or empty!");
+		Assert.notNull(ignored, "Predicate to describe ignored types must not be null!");
 
-			Assert.hasText(javaPackage, "Base package must not be null or empty!");
-			Assert.notNull(ignored, "Predicate to describe ignored types must not be null!");
+		return of(CacheKey.of(javaPackage, ignored, IMPORT_OPTION));
+	}
 
-			return of(key);
-		});
+	/**
+	 * Creates a new {@link ApplicationModules} instance for the given package and {@link ImportOption}.
+	 *
+	 * @param javaPackage must not be {@literal null}.
+	 * @param options must not be {@literal null}.
+	 * @return will never be {@literal null}.
+	 * @since 1.2
+	 */
+	public static ApplicationModules of(String javaPackage, ImportOption options) {
+		return of(CacheKey.of(javaPackage, alwaysFalse(), options));
 	}
 
 	/**
@@ -571,13 +616,8 @@ private static ApplicationModules of(CacheKey key) {
 		Assert.notNull(key, "Cache key must not be null!");
 
 		var metadata = key.getMetadata();
-
-		var basePackages = new HashSet<String>();
-		basePackages.add(key.getBasePackage());
-		basePackages.addAll(metadata.getAdditionalPackages());
-
-		var modules = new ApplicationModules(metadata, basePackages, key.getIgnored(),
-				metadata.useFullyQualifiedModuleNames(), IMPORT_OPTION);
+		var modules = new ApplicationModules(metadata, key.getIgnored(),
+				metadata.useFullyQualifiedModuleNames(), key.getOptions());
 
 		var sharedModules = metadata.getSharedModuleNames() //
 				.map(modules::getRequiredModule) //
@@ -623,130 +663,37 @@ public static DescribedPredicate<JavaClass> withoutModule(String name) {
 		}
 	}
 
-	private static interface CacheKey {
+	private static class CacheKey {
 
-		String getBasePackage();
-
-		DescribedPredicate<JavaClass> getIgnored();
-
-		ModulithMetadata getMetadata();
-	}
-
-	private static final class TypeKey implements CacheKey {
-
-		private final Class<?> type;
 		private final DescribedPredicate<JavaClass> ignored;
+		private final ImportOption options;
+		private final Supplier<ModulithMetadata> metadata;
 
-		/**
-		 * Creates a new {@link TypeKey} for the given type and {@link DescribedPredicate} of ignored {@link JavaClass}es.
-		 *
-		 * @param type must not be {@literal null}.
-		 * @param ignored must not be {@literal null}.
-		 */
-		TypeKey(Class<?> type, DescribedPredicate<JavaClass> ignored) {
+		public CacheKey(DescribedPredicate<JavaClass> ignored, ImportOption options, Supplier<ModulithMetadata> metadata) {
 
-			this.type = type;
 			this.ignored = ignored;
+			this.options = options;
+			this.metadata = SingletonSupplier.of(metadata);
 		}
 
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.modulith.model.Modules.CacheKey#getBasePackage()
-		 */
-		@Override
-		public String getBasePackage() {
-			return type.getPackage().getName();
+		static CacheKey of(String pkg, DescribedPredicate<JavaClass> ignored, ImportOption options) {
+			return new CacheKey(ignored, options, () -> ModulithMetadata.of(pkg));
 		}
 
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.modulith.model.Modules.CacheKey#getMetadata()
-		 */
-		@Override
-		public ModulithMetadata getMetadata() {
-			return ModulithMetadata.of(type);
+		static CacheKey of(Class<?> type, DescribedPredicate<JavaClass> ignored, ImportOption options) {
+			return new CacheKey(ignored, options, () -> ModulithMetadata.of(type));
 		}
 
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.modulith.model.ApplicationModules.CacheKey#getIgnored()
-		 */
-		@Override
-		public DescribedPredicate<JavaClass> getIgnored() {
+		DescribedPredicate<JavaClass> getIgnored() {
 			return ignored;
 		}
 
-		/*
-		 * (non-Javadoc)
-		 * @see java.lang.Object#equals(java.lang.Object)
-		 */
-		@Override
-		public boolean equals(Object obj) {
-
-			if (this == obj) {
-				return true;
-			}
-
-			if (!(obj instanceof TypeKey other)) {
-				return false;
-			}
-
-			return Objects.equals(this.type, other.type) //
-					&& Objects.equals(this.ignored, other.ignored);
-		}
-
-		/*
-		 * (non-Javadoc)
-		 * @see java.lang.Object#hashCode()
-		 */
-		@Override
-		public int hashCode() {
-			return Objects.hash(type, ignored);
-		}
-	}
-
-	private static final class PackageKey implements CacheKey {
-
-		private final String basePackage;
-		private final DescribedPredicate<JavaClass> ignored;
-
-		/**
-		 * Creates a new {@link PackageKey} for the given base package and {@link DescribedPredicate} of ignored
-		 * {@link JavaClass}es.
-		 *
-		 * @param basePackage must not be {@literal null}.
-		 * @param ignored must not be {@literal null}.
-		 */
-		PackageKey(String basePackage, DescribedPredicate<JavaClass> ignored) {
-
-			this.basePackage = basePackage;
-			this.ignored = ignored;
+		ModulithMetadata getMetadata() {
+			return metadata.get();
 		}
 
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.modulith.model.ApplicationModules.CacheKey#getBasePackage()
-		 */
-		@Override
-		public String getBasePackage() {
-			return basePackage;
-		}
-
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.modulith.model.ApplicationModules.CacheKey#getIgnored()
-		 */
-		public DescribedPredicate<JavaClass> getIgnored() {
-			return ignored;
-		}
-
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.modulith.model.Modules.CacheKey#getMetadata()
-		 */
-		@Override
-		public ModulithMetadata getMetadata() {
-			return ModulithMetadata.of(basePackage);
+		ImportOption getOptions() {
+			return options;
 		}
 
 		/*
@@ -756,25 +703,17 @@ public ModulithMetadata getMetadata() {
 		@Override
 		public boolean equals(Object obj) {
 
-			if (this == obj) {
+			if (obj == this) {
 				return true;
 			}
 
-			if (!(obj instanceof PackageKey that)) {
+			if (!(obj instanceof CacheKey that)) {
 				return false;
 			}
 
-			return Objects.equals(this.basePackage, that.basePackage) //
-					&& Objects.equals(this.ignored, that.ignored);
-		}
-
-		/*
-		 * (non-Javadoc)
-		 * @see java.lang.Object#hashCode()
-		 */
-		@Override
-		public int hashCode() {
-			return Objects.hash(basePackage, ignored);
+			return Objects.equals(this.ignored, that.ignored)
+					&& Objects.equals(this.options, that.options)
+					&& Objects.equals(this.metadata.get(), that.metadata.get());
 		}
 	}
 

spring-modulith-core/src/main/java/org/springframework/modulith/core/ModulithMetadata.java

@@ -25,6 +25,11 @@
 import org.springframework.modulith.core.Types.SpringTypes;
 import org.springframework.util.Assert;
 
+/**
+ * Core metadata about the modulithic application.
+ *
+ * @author Oliver Drotbohm
+ */
 public interface ModulithMetadata {
 
 	static final String ANNOTATION_MISSING = "Modules can only be retrieved from a root type, but %s is not annotated with either @%s, @%s or @%s!";
@@ -81,7 +86,9 @@ public static ModulithMetadata of(String javaPackage) {
 	 * consider all direct sub-packages modules by default.
 	 *
 	 * @return will never be {@literal null}.
+	 * @deprecated since 1.2, rather use {@link #getBasePackages()} that includes all packages already.
 	 */
+	@Deprecated
 	List<String> getAdditionalPackages();
 
 	/**
@@ -105,4 +112,12 @@ public static ModulithMetadata of(String javaPackage) {
 	 * @return will never be {@literal null}.
 	 */
 	Optional<String> getSystemName();
+
+	/**
+	 * Returns all base packages of the modulith.
+	 *
+	 * @return will never be {@literal null}.
+	 * @since 1.2
+	 */
+	List<String> getBasePackages();
 }