Fix caching operations in CachingMetadataReaderFactory

gh-33616 refactored `CachingMetadataReaderFactory` and broke the
behavior as it bypassed the cache for `getMetadataReader(String
className)` operations.

This commit restores the original behavior.

Fixes gh-35112
This commit is contained in:
Brian Clozel
2025-06-25 20:32:38 +02:00
parent b3a5473bc7
commit 2fa25b50d9
7 changed files with 161 additions and 183 deletions
@@ -1,78 +0,0 @@
/*
* Copyright 2002-present the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.core.type;
import java.net.URL;
import org.jspecify.annotations.Nullable;
import org.junit.jupiter.api.Test;
import org.springframework.core.io.Resource;
import org.springframework.core.io.UrlResource;
import org.springframework.core.testfixture.EnabledForTestGroups;
import org.springframework.core.type.classreading.CachingMetadataReaderFactory;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.core.testfixture.TestGroup.LONG_RUNNING;
/**
* Tests for checking the behaviour of {@link CachingMetadataReaderFactory} under
* load. If the cache is not controlled, this test should fail with an out of memory
* exception around entry 5k.
*
* @author Costin Leau
* @author Sam Brannen
*/
@EnabledForTestGroups(LONG_RUNNING)
class CachingMetadataReaderLeakTests {
private static final int ITEMS_TO_LOAD = 9999;
private final MetadataReaderFactory mrf = new CachingMetadataReaderFactory();
@Test
void significantLoad() throws Exception {
// the biggest public class in the JDK (>60k)
URL url = getClass().getResource("/java/awt/Component.class");
assertThat(url).isNotNull();
// look at a LOT of items
for (int i = 0; i < ITEMS_TO_LOAD; i++) {
Resource resource = new UrlResource(url) {
@Override
public boolean equals(@Nullable Object obj) {
return (obj == this);
}
@Override
public int hashCode() {
return System.identityHashCode(this);
}
};
MetadataReader reader = mrf.getMetadataReader(resource);
assertThat(reader).isNotNull();
}
// useful for profiling to take snapshots
// System.in.read();
}
}
@@ -0,0 +1,50 @@
/*
* Copyright 2002-present the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.core.type.classreading;
import org.junit.jupiter.api.Test;
import org.springframework.core.io.Resource;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
/**
* Tests for {@link CachingMetadataReaderFactory}.
*/
class CachingMetadataReaderFactoryTests {
@Test
void shouldCacheClassNameCalls() throws Exception {
MetadataReaderFactory delegate = mock(MetadataReaderFactory.class);
when(delegate.getMetadataReader(any(Resource.class))).thenReturn(mock(MetadataReader.class));
CachingMetadataReaderFactory readerFactory = new CachingMetadataReaderFactory(delegate);
MetadataReader metadataReader = readerFactory.getMetadataReader(TestClass.class.getName());
metadataReader = readerFactory.getMetadataReader(TestClass.class.getName());
verify(delegate, times(1)).getMetadataReader(any(Resource.class));
}
public static class TestClass {
}
}