feat: use ServiceLoader to discover cache providers (#367)

DerSimeon · iProdigy · web-flow · commit 210f7a524bed · 2025-01-01T16:59:07.000-06:00
Co-authored-by: iProdigy &lt;gitprodigy@proton.me&gt;
diff --git a/core/src/main/java/io/github/xanthic/cache/core/AbstractCacheProvider.java b/core/src/main/java/io/github/xanthic/cache/core/AbstractCacheProvider.java
@@ -4,6 +4,7 @@
 import io.github.xanthic.cache.api.domain.ExpiryType;
 import io.github.xanthic.cache.api.domain.MisconfigurationPolicy;
 import io.github.xanthic.cache.api.exception.MisconfiguredCacheException;
+import org.jetbrains.annotations.ApiStatus;
 
 import java.time.Duration;
 import java.util.function.BiConsumer;
@@ -34,5 +35,10 @@ protected void handleExpiration(Duration time, ExpiryType type, BiConsumer<Durat
 	protected ExpiryType preferredType() {
 		return ExpiryType.POST_ACCESS; // LRU
 	}
+	
+	@ApiStatus.Internal
+	public int getDiscoveryOrder() {
+		return 1000;
+	}
 
 }
diff --git a/core/src/main/java/io/github/xanthic/cache/core/CacheApiSettings.java b/core/src/main/java/io/github/xanthic/cache/core/CacheApiSettings.java
@@ -12,11 +12,12 @@
 import org.jetbrains.annotations.Nullable;
 
 import java.util.Collections;
+import java.util.Comparator;
 import java.util.IdentityHashMap;
 import java.util.Map;
-import java.util.concurrent.atomic.AtomicInteger;
+import java.util.ServiceLoader;
 import java.util.concurrent.atomic.AtomicReference;
-import java.util.function.Consumer;
+import java.util.stream.StreamSupport;
 
 /**
  * Holds a registry of default settings and cache providers.
@@ -103,31 +104,12 @@ public void registerCacheProvider(@NonNull Class<? extends CacheProvider> cacheP
 	private void populateProviders() {
 		log.debug("Xanthic: Registering canonical cache providers from the classpath...");
 
-		AtomicInteger registered = new AtomicInteger();
-		Consumer<String> loadImpl = (providerClass) -> {
-			try {
-				Class<? extends CacheProvider> clazz = Class.forName(providerClass).asSubclass(CacheProvider.class);
-				registerCacheProvider(clazz, null); // lazy, init if needed
-				registered.incrementAndGet();
-			} catch (ClassNotFoundException cx) {
-				log.trace("Xanthic: Could not find optional cache provider " + providerClass);
-			} catch (Exception e) {
-				log.trace("Xanthic: Could not find optional cache provider " + providerClass, e);
-			}
-		};
-
-		loadImpl.accept("io.github.xanthic.cache.provider.androidx.AndroidLruProvider");
-		loadImpl.accept("io.github.xanthic.cache.provider.caffeine3.Caffeine3Provider");
-		loadImpl.accept("io.github.xanthic.cache.provider.caffeine.CaffeineProvider");
-		loadImpl.accept("io.github.xanthic.cache.provider.cache2k.Cache2kProvider");
-		loadImpl.accept("io.github.xanthic.cache.provider.infinispanjdk17.InfinispanProvider");
-		loadImpl.accept("io.github.xanthic.cache.provider.infinispanjdk11.InfinispanProvider");
-		loadImpl.accept("io.github.xanthic.cache.provider.infinispan.InfinispanProvider");
-		loadImpl.accept("io.github.xanthic.cache.provider.expiringmap.ExpiringMapProvider");
-		loadImpl.accept("io.github.xanthic.cache.provider.guava.GuavaProvider");
-		loadImpl.accept("io.github.xanthic.cache.provider.ehcache.EhcacheProvider");
-
-		log.debug("Xanthic: Loaded {} canonical cache provider(s) on settings construction!", registered.get());
+		ServiceLoader<AbstractCacheProvider> load = ServiceLoader.load(AbstractCacheProvider.class);
+		StreamSupport.stream(load.spliterator(), false)
+			.sorted(Comparator.comparingInt(AbstractCacheProvider::getDiscoveryOrder))
+			.forEach(provider -> registerCacheProvider(provider.getClass(), provider));
+
+		log.debug("Xanthic: Loaded {} canonical cache provider(s) on settings construction!", providers.size());
 	}
 
 	/**
diff --git a/provider-androidx/src/main/java/io/github/xanthic/cache/provider/androidx/AndroidLruProvider.java b/provider-androidx/src/main/java/io/github/xanthic/cache/provider/androidx/AndroidLruProvider.java
@@ -55,4 +55,8 @@ protected void entryRemoved(boolean evicted, @NotNull K key, @NotNull V oldValue
 		};
 	}
 
+	@Override
+	public int getDiscoveryOrder() {
+		return 1;
+	}
 }
diff --git a/provider-androidx/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider b/provider-androidx/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider
@@ -0,0 +1 @@
+io.github.xanthic.cache.provider.androidx.AndroidLruProvider
diff --git a/provider-cache2k/src/main/java/io/github/xanthic/cache/provider/cache2k/Cache2kProvider.java b/provider-cache2k/src/main/java/io/github/xanthic/cache/provider/cache2k/Cache2kProvider.java
@@ -108,4 +108,8 @@ private static <K, V> Collection<CacheEntryOperationListener<K, V>> buildListene
 		);
 	}
 
+	@Override
+	public int getDiscoveryOrder() {
+		return 4;
+	}
 }
diff --git a/provider-cache2k/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider b/provider-cache2k/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider
@@ -0,0 +1 @@
+io.github.xanthic.cache.provider.cache2k.Cache2kProvider
diff --git a/provider-caffeine/src/main/java/io/github/xanthic/cache/provider/caffeine/CaffeineProvider.java b/provider-caffeine/src/main/java/io/github/xanthic/cache/provider/caffeine/CaffeineProvider.java
@@ -51,4 +51,9 @@ private static RemovalCause getCause(com.github.benmanes.caffeine.cache.RemovalC
 				return RemovalCause.OTHER;
 		}
 	}
+
+	@Override
+	public int getDiscoveryOrder() {
+		return 3;
+	}
 }
diff --git a/provider-caffeine/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider b/provider-caffeine/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider
@@ -0,0 +1 @@
+io.github.xanthic.cache.provider.caffeine.CaffeineProvider
diff --git a/provider-caffeine3/src/main/java/io/github/xanthic/cache/provider/caffeine3/Caffeine3Provider.java b/provider-caffeine3/src/main/java/io/github/xanthic/cache/provider/caffeine3/Caffeine3Provider.java
@@ -49,4 +49,9 @@ private static RemovalCause getCause(com.github.benmanes.caffeine.cache.RemovalC
 				return RemovalCause.OTHER;
 		}
 	}
+
+	@Override
+	public int getDiscoveryOrder() {
+		return 2;
+	}
 }
diff --git a/provider-caffeine3/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider b/provider-caffeine3/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider
@@ -0,0 +1 @@
+io.github.xanthic.cache.provider.caffeine3.Caffeine3Provider
diff --git a/provider-ehcache/src/main/java/io/github/xanthic/cache/provider/ehcache/EhcacheProvider.java b/provider-ehcache/src/main/java/io/github/xanthic/cache/provider/ehcache/EhcacheProvider.java
@@ -101,4 +101,8 @@ private static RemovalCause getCause(EventType type) {
 		}
 	}
 
+	@Override
+	public int getDiscoveryOrder() {
+		return 10;
+	}
 }
diff --git a/provider-ehcache/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider b/provider-ehcache/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider
@@ -0,0 +1 @@
+io.github.xanthic.cache.provider.ehcache.EhcacheProvider
diff --git a/provider-expiringmap/src/main/java/io/github/xanthic/cache/provider/expiringmap/ExpiringMapProvider.java b/provider-expiringmap/src/main/java/io/github/xanthic/cache/provider/expiringmap/ExpiringMapProvider.java
@@ -36,4 +36,9 @@ public <K, V> Cache<K, V> build(ICacheSpec<K, V> spec) {
 
 		return new ExpiringMapDelegate<>(builder.build());
 	}
+
+	@Override
+	public int getDiscoveryOrder() {
+		return 8;
+	}
 }
diff --git a/provider-expiringmap/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider b/provider-expiringmap/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider
@@ -0,0 +1 @@
+io.github.xanthic.cache.provider.expiringmap.ExpiringMapProvider
diff --git a/provider-guava/src/main/java/io/github/xanthic/cache/provider/guava/GuavaProvider.java b/provider-guava/src/main/java/io/github/xanthic/cache/provider/guava/GuavaProvider.java
@@ -72,4 +72,9 @@ private static RemovalCause getCause(com.google.common.cache.RemovalCause cause)
 				return RemovalCause.OTHER;
 		}
 	}
+
+	@Override
+	public int getDiscoveryOrder() {
+		return 9;
+	}
 }
diff --git a/provider-guava/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider b/provider-guava/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider
@@ -0,0 +1 @@
+io.github.xanthic.cache.provider.guava.GuavaProvider
diff --git a/provider-infinispan-java11/src/main/java/io/github/xanthic/cache/provider/infinispanjdk11/InfinispanProvider.java b/provider-infinispan-java11/src/main/java/io/github/xanthic/cache/provider/infinispanjdk11/InfinispanProvider.java
@@ -47,4 +47,9 @@ public <K, V> Cache<K, V> build(ICacheSpec<K, V> spec) {
 
 		return new InfinispanDelegate<>(cache);
 	}
+
+	@Override
+	public int getDiscoveryOrder() {
+		return 6;
+	}
 }
diff --git a/provider-infinispan-java11/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider b/provider-infinispan-java11/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider
@@ -0,0 +1 @@
+io.github.xanthic.cache.provider.infinispanjdk11.InfinispanProvider
diff --git a/provider-infinispan-java17/src/main/java/io/github/xanthic/cache/provider/infinispanjdk17/InfinispanProvider.java b/provider-infinispan-java17/src/main/java/io/github/xanthic/cache/provider/infinispanjdk17/InfinispanProvider.java
@@ -47,4 +47,9 @@ public <K, V> Cache<K, V> build(ICacheSpec<K, V> spec) {
 
 		return new InfinispanDelegate<>(cache);
 	}
+
+	@Override
+	public int getDiscoveryOrder() {
+		return 5;
+	}
 }
diff --git a/provider-infinispan-java17/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider b/provider-infinispan-java17/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider
@@ -0,0 +1 @@
+io.github.xanthic.cache.provider.infinispanjdk17.InfinispanProvider
diff --git a/provider-infinispan/src/main/java/io/github/xanthic/cache/provider/infinispan/InfinispanProvider.java b/provider-infinispan/src/main/java/io/github/xanthic/cache/provider/infinispan/InfinispanProvider.java
@@ -47,4 +47,9 @@ public <K, V> Cache<K, V> build(ICacheSpec<K, V> spec) {
 
 		return new InfinispanDelegate<>(cache);
 	}
+
+	@Override
+	public int getDiscoveryOrder() {
+		return 7;
+	}
 }
diff --git a/provider-infinispan/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider b/provider-infinispan/src/main/resources/META-INF/services/io.github.xanthic.cache.core.AbstractCacheProvider
@@ -0,0 +1 @@
+io.github.xanthic.cache.provider.infinispan.InfinispanProvider

Original file line number	Diff line number	Diff line change
`@@ -55,4 +55,8 @@ protected void entryRemoved(boolean evicted, @NotNull K key, @NotNull V oldValue`
`55`	`55`	`};`
`56`	`56`	`}`
`57`	`57`
	`58`	`+ @Override`
	`59`	`+ public int getDiscoveryOrder() {`
	`60`	`+ return 1;`
	`61`	`+ }`
`58`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+io.github.xanthic.cache.provider.androidx.AndroidLruProvider`
Original file line number	Diff line number	Diff line change
`@@ -108,4 +108,8 @@ private static <K, V> Collection<CacheEntryOperationListener<K, V>> buildListene`
`108`	`108`	`);`
`109`	`109`	`}`
`110`	`110`
	`111`	`+ @Override`
	`112`	`+ public int getDiscoveryOrder() {`
	`113`	`+ return 4;`
	`114`	`+ }`
`111`	`115`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+io.github.xanthic.cache.provider.cache2k.Cache2kProvider`
Original file line number	Diff line number	Diff line change
`@@ -51,4 +51,9 @@ private static RemovalCause getCause(com.github.benmanes.caffeine.cache.RemovalC`
`51`	`51`	`return RemovalCause.OTHER;`
`52`	`52`	`}`
`53`	`53`	`}`
	`54`	`+`
	`55`	`+ @Override`
	`56`	`+ public int getDiscoveryOrder() {`
	`57`	`+ return 3;`
	`58`	`+ }`
`54`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+io.github.xanthic.cache.provider.caffeine.CaffeineProvider`
Original file line number	Diff line number	Diff line change
`@@ -49,4 +49,9 @@ private static RemovalCause getCause(com.github.benmanes.caffeine.cache.RemovalC`
`49`	`49`	`return RemovalCause.OTHER;`
`50`	`50`	`}`
`51`	`51`	`}`
	`52`	`+`
	`53`	`+ @Override`
	`54`	`+ public int getDiscoveryOrder() {`
	`55`	`+ return 2;`
	`56`	`+ }`
`52`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -101,4 +101,8 @@ private static RemovalCause getCause(EventType type) {`
`101`	`101`	`}`
`102`	`102`	`}`
`103`	`103`
	`104`	`+ @Override`
	`105`	`+ public int getDiscoveryOrder() {`
	`106`	`+ return 10;`
	`107`	`+ }`
`104`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+io.github.xanthic.cache.provider.ehcache.EhcacheProvider`
Original file line number	Diff line number	Diff line change
`@@ -36,4 +36,9 @@ public <K, V> Cache<K, V> build(ICacheSpec<K, V> spec) {`
`36`	`36`
`37`	`37`	`return new ExpiringMapDelegate<>(builder.build());`
`38`	`38`	`}`
	`39`	`+`
	`40`	`+ @Override`
	`41`	`+ public int getDiscoveryOrder() {`
	`42`	`+ return 8;`
	`43`	`+ }`
`39`	`44`	`}`