LPD-41245 Apply key-hashing improvement for Ehcache 3 from Spring-framework spring-projects/spring-framework#34483

Author: dantewang

modules/apps/portal-cache/portal-cache-ehcache-impl/src/main/java/com/liferay/portal/cache/ehcache/internal/BaseEhcachePortalCache.java

@@ -21,7 +21,6 @@
 import java.time.temporal.ChronoUnit;
 
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 
@@ -54,25 +53,22 @@ public BaseEhcachePortalCache(
 	@Override
 	@SuppressWarnings("unchecked")
 	public List<K> getKeys() {
+		List<K> keys = new ArrayList<>();
+
 		Cache<?, ?> cache = getEhcache();
 
-		List<K> rawKeys = new ArrayList<>();
+		cache.forEach(
+			entry -> {
+				EhcacheKey ehcacheKey = (EhcacheKey)entry.getKey();
 
-		cache.forEach(entry -> rawKeys.add((K)entry.getKey()));
+				Object key = ehcacheKey.getKey();
 
-		if (!_serializable) {
-			return rawKeys;
-		}
+				if (_serializable) {
+					key = SerializableObjectWrapper.unwrap(key);
+				}
 
-		if (rawKeys.isEmpty()) {
-			return Collections.emptyList();
-		}
-
-		List<K> keys = new ArrayList<>(rawKeys.size());
-
-		for (Object object : rawKeys) {
-			keys.add(SerializableObjectWrapper.unwrap(object));
-		}
+				keys.add((K)key);
+			});
 
 		return keys;
 	}
@@ -209,10 +205,10 @@ private V _getValue(Object value) {
 
 	private Object _wrapKey(K key) {
 		if (!_serializable) {
-			return key;
+			return new EhcacheKey(key);
 		}
 
-		return new SerializableObjectWrapper(key);
+		return new EhcacheKey(new SerializableObjectWrapper(key));
 	}
 
 	private Object _wrapValue(V value, int timeToLive) {

modules/apps/portal-cache/portal-cache-ehcache-impl/src/main/java/com/liferay/portal/cache/ehcache/internal/EhcacheKey.java

@@ -0,0 +1,56 @@
+/**
+ * SPDX-FileCopyrightText: (c) 2025 Liferay, Inc. https://liferay.com
+ * SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
+ */
+
+package com.liferay.portal.cache.ehcache.internal;
+
+import java.io.Serializable;
+
+import java.util.Objects;
+
+/**
+ * @author Dante Wang
+ */
+public class EhcacheKey implements Serializable {
+
+	public EhcacheKey(Object key) {
+		_key = key;
+
+		// See https://github.com/spring-projects/spring-framework/issues/34483
+
+		int hashCode = _key.hashCode();
+
+		hashCode = (hashCode ^ (hashCode >>> 16)) * 0x85ebca6b;
+		hashCode = (hashCode ^ (hashCode >>> 13)) * 0xc2b2ae35;
+		hashCode = hashCode ^ (hashCode >>> 16);
+
+		_hashCode = hashCode;
+	}
+
+	@Override
+	public boolean equals(Object other) {
+		if (this == other) {
+			return true;
+		}
+
+		if (!(other instanceof EhcacheKey ehcacheKey)) {
+			return false;
+		}
+
+		return Objects.equals(_key, ehcacheKey._key);
+	}
+
+	public Object getKey() {
+		return _key;
+	}
+
+	@Override
+	public int hashCode() {
+		return _hashCode;
+	}
+
+	private final int _hashCode;
+	private final Object _key;
+
+}

modules/apps/portal-cache/portal-cache-ehcache-impl/src/main/java/com/liferay/portal/cache/ehcache/internal/event/PortalCacheCacheEventListener.java

@@ -9,6 +9,7 @@
 import com.liferay.petra.string.StringPool;
 import com.liferay.portal.cache.AggregatedPortalCacheListener;
 import com.liferay.portal.cache.ehcache.internal.BaseEhcachePortalCache;
+import com.liferay.portal.cache.ehcache.internal.EhcacheKey;
 import com.liferay.portal.cache.ehcache.internal.EhcacheValue;
 import com.liferay.portal.cache.io.SerializableObjectWrapper;
 import com.liferay.portal.kernel.cache.PortalCache;
@@ -132,6 +133,10 @@ _portalCache, _getKey(key), _getValue(newValue),
 
 	@SuppressWarnings("unchecked")
 	private K _getKey(Object key) {
+		EhcacheKey ehcacheKey = (EhcacheKey)key;
+
+		key = ehcacheKey.getKey();
+
 		if (_requireSerialization) {
 			return SerializableObjectWrapper.unwrap(key);
 		}

modules/apps/portal-cache/portal-cache-ehcache-impl/src/test/java/com/liferay/portal/cache/ehcache/internal/BaseEhcachePortalCacheTest.java

@@ -789,7 +789,7 @@ public void testTimeToLive() {
 
 		// Put if absent
 
-		cache.remove(_KEY_2);
+		cache.remove(new EhcacheKey(_KEY_2));
 
 		_ehcachePortalCache.putIfAbsent(_KEY_2, _VALUE_2, timeToLive);
 
@@ -805,7 +805,7 @@ public void testTimeToLive() {
 
 		// Replace 1
 
-		cache.remove(_KEY_2);
+		cache.remove(new EhcacheKey(_KEY_2));
 
 		_ehcachePortalCache.replace(_KEY_1, _VALUE_2, timeToLive);
 
@@ -822,7 +822,7 @@ public void testTimeToLive() {
 
 		// Replace 2
 
-		cache.remove(_KEY_1);
+		cache.remove(new EhcacheKey(_KEY_1));
 
 		_ehcachePortalCache.put(_KEY_1, _VALUE_1);
 

modules/apps/portal-cache/portal-cache-ehcache-impl/src/test/java/com/liferay/portal/cache/ehcache/internal/ShardedEhcachePortalCacheTest.java

@@ -288,7 +288,7 @@ public void testGetKeys() {
 		_companyIdThreadLocal.set(_TEST_COMPANY_ID_1);
 
 		Assert.assertEquals(
-			Arrays.asList(_TEST_KEY_1, _TEST_KEY_SYSTEM),
+			Arrays.asList(_TEST_KEY_SYSTEM, _TEST_KEY_1),
 			_shardedEhcachePortalCache.getKeys());
 
 		_companyIdThreadLocal.set(_TEST_COMPANY_ID_2);
@@ -741,7 +741,8 @@ private void _assertTimeToLive(
 			_getShardedCacheName(_TEST_CACHE_NAME, companyId), Object.class,
 			Object.class);
 
-		EhcacheValue ehcacheValue = (EhcacheValue)cache.get(key);
+		EhcacheValue ehcacheValue = (EhcacheValue)cache.get(
+			new EhcacheKey(key));
 
 		Assert.assertEquals(value, ehcacheValue.getValue());