Use an expiring cache for MagicItems#getMagicItemDataFromItemStack

NOTICE.md

@@ -54,3 +54,7 @@ The project includes software developed by third parties. For their full license
 - packetevents:
   - Repository: `retrooper/packetevents`
   - License: **General Public License v3.0** (See `3rd_party_licenses/LICENSE-GPLv3`)
+
+- Caffeine:
+  - Repository: `ben-manes/caffeine`
+  - License: **Apache-2.0 License** (See `3rd_party_licenses/LICENSE-Apache_v2`)

core/build.gradle

@@ -5,6 +5,7 @@ plugins {
 
 dependencies {
     shadow(group: "org.apache.commons", name: "commons-math4-core", version: "4.0-beta1")
+    shadow(group: "com.github.ben-manes.caffeine", name: "caffeine", version: "3.2.1")
     shadow(group: "com.github.Chronoken", name: "EffectLib", version: "753da6c")
     shadow(group: "co.aikar", name: "acf-paper", version: "0.5.1-SNAPSHOT")
     shadow(group: "org.bstats", name: "bstats-bukkit", version: "3.0.2")
@@ -48,6 +49,7 @@ jar {
 shadowJar {
     configurations = [project.configurations.shadow]
 
+    relocate("com.github.benmanes.caffeine", "com.nisovin.magicspells.shaded.com.github.benmanes.caffeine")
     relocate("org.apache.commons.math4", "com.nisovin.magicspells.shaded.org.apache.commons.math4")
     relocate("de.slikey.effectlib", "com.nisovin.magicspells.shaded.effectlib")
     relocate("co.aikar.commands", "com.nisovin.magicspells.shaded.acf")

core/src/main/java/com/nisovin/magicspells/util/magicitems/MagicItems.java

@@ -1,6 +1,10 @@
 package com.nisovin.magicspells.util.magicitems;
 
 import java.util.*;
+import java.time.Duration;
+
+import com.github.benmanes.caffeine.cache.Cache;
+import com.github.benmanes.caffeine.cache.Caffeine;
 
 import net.kyori.adventure.text.Component;
 
@@ -25,7 +29,11 @@
 public class MagicItems {
 
 	private static final Map<String, MagicItem> magicItems = new HashMap<>();
-	private static final Map<ItemStack, MagicItemData> itemStackCache = new HashMap<>();
+
+	private static final Cache<ItemStack, MagicItemData> itemStackCache = Caffeine.newBuilder()
+		.expireAfterAccess(Duration.ofMinutes(5))
+		.maximumSize(10000)
+		.build();
 
 	public static Map<String, MagicItem> getMagicItems() {
 		return magicItems;
@@ -58,37 +66,36 @@ public static MagicItemData getMagicItemDataByInternalName(String internalName)
 		return magicItems.get(internalName).getMagicItemData();
 	}
 
-	public static MagicItemData getMagicItemDataFromItemStack(ItemStack itemStack) {
-		if (itemStack == null) return null;
+	public static MagicItemData getMagicItemDataFromItemStack(ItemStack item) {
+		if (item == null) return null;
+
+		MagicItemData data = itemStackCache.getIfPresent(item);
+		if (data != null) return data;
 
-		MagicItemData cached = itemStackCache.get(itemStack);
-		// We can do this because itemStackCache doesn't have any null values
-		if (cached != null) return cached;
+		data = getMagicItemDataFromItemStackInternal(item);
+		itemStackCache.put(item.clone(), data);
+
+		return data;
+	}
 
+	private static MagicItemData getMagicItemDataFromItemStackInternal(ItemStack item) {
 		MagicItemData data = new MagicItemData();
 
 		// type
-		data.setAttribute(TYPE, itemStack.getType());
-
-		if (itemStack.getType().isAir()) {
-			itemStackCache.put(itemStack, data);
-			return data;
-		}
+		data.setAttribute(TYPE, item.getType());
+		if (item.getType().isAir()) return data;
 
 		// amount
-		data.setAttribute(AMOUNT, itemStack.getAmount());
+		data.setAttribute(AMOUNT, item.getAmount());
 
-		ItemMeta meta = itemStack.getItemMeta();
-		if (meta == null) {
-			itemStackCache.put(itemStack, data);
-			return data;
-		}
+		ItemMeta meta = item.getItemMeta();
+		if (meta == null) return data;
 
 		// name
 		NameHandler.processMagicItemData(meta, data);
 
 		// durability
-		if (itemStack.getType().getMaxDurability() > 0) DurabilityHandler.processMagicItemData(meta, data);
+		if (item.getType().getMaxDurability() > 0) DurabilityHandler.processMagicItemData(meta, data);
 
 		// repairCost
 		RepairableHandler.processMagicItemData(meta, data);
@@ -149,9 +156,8 @@ public static MagicItemData getMagicItemDataFromItemStack(ItemStack itemStack) {
 		BannerHandler.processMagicItemData(meta, data);
 
 		// block data
-		BlockDataHandler.processMagicItemData(meta, data, itemStack.getType());
+		BlockDataHandler.processMagicItemData(meta, data, item.getType());
 
-		itemStackCache.put(itemStack, data);
 		return data;
 	}