Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Optimize CacheKey handling in SpringIterableConfigurationPropertySource #16717

Closed
wants to merge 1 commit into from
Closed

Optimize CacheKey handling in SpringIterableConfigurationPropertySource #16717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 28 additions & 6 deletions ...ngframework/boot/context/properties/source/SpringIterableConfigurationPropertySource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.util.Set;
import java.util.stream.Stream;

import org.springframework.boot.env.OriginTrackedMapPropertySource;
import org.springframework.core.env.EnumerablePropertySource;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.PropertySource;
Expand All @@ -44,7 +45,7 @@
class SpringIterableConfigurationPropertySource extends SpringConfigurationPropertySource
implements IterableConfigurationPropertySource {

private volatile Object cacheKey;
private volatile CacheKey cacheKey;

private volatile Cache cache;

Expand Down Expand Up @@ -173,21 +174,37 @@ private static final class CacheKey {

private final Object key;

private CacheKey(Object key) {
private final int size;

private final boolean unmodifiableKey;

private CacheKey(Object key, boolean unmodifiableKey) {
this.key = key;
this.size = calculateSize(key);
this.unmodifiableKey = unmodifiableKey;
}

public CacheKey copy() {
return new CacheKey(copyKey(this.key));
return new CacheKey(copyKey(this.key), this.unmodifiableKey);
}

private Object copyKey(Object key) {
if (this.unmodifiableKey) {
return key;
}
if (key instanceof Set) {
return new HashSet<Object>((Set<?>) key);
}
return ((String[]) key).clone();
}

private int calculateSize(Object key) {
if (key instanceof Set) {
return ((Set<?>) key).size();
}
return ((String[]) key).length;
}

@Override
public boolean equals(Object obj) {
if (this == obj) {
Expand All @@ -196,7 +213,11 @@ public boolean equals(Object obj) {
if (obj == null || getClass() != obj.getClass()) {
return false;
}
return ObjectUtils.nullSafeEquals(this.key, ((CacheKey) obj).key);
CacheKey otherCacheKey = (CacheKey) obj;
if (this.size != otherCacheKey.size) {
return false;
}
return ObjectUtils.nullSafeEquals(this.key, otherCacheKey.key);
}

@Override
Expand All @@ -206,9 +227,10 @@ public int hashCode() {

public static CacheKey get(EnumerablePropertySource<?> source) {
if (source instanceof MapPropertySource) {
return new CacheKey(((MapPropertySource) source).getSource().keySet());
return new CacheKey(((MapPropertySource) source).getSource().keySet(),
source instanceof OriginTrackedMapPropertySource);
}
return new CacheKey(source.getPropertyNames());
return new CacheKey(source.getPropertyNames(), false);
}

}
Expand Down
18 changes: 17 additions & 1 deletion ...mework/boot/context/properties/source/SpringIterableConfigurationPropertySourceTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

import org.junit.Test;

import org.springframework.boot.env.OriginTrackedMapPropertySource;
import org.springframework.boot.origin.Origin;
import org.springframework.boot.origin.OriginLookup;
import org.springframework.core.env.EnumerablePropertySource;
Expand Down Expand Up @@ -156,7 +157,7 @@ public void containsDescendantOfShouldCheckSourceNames() {
}

@Test
public void propertySourceKeyDataChangeInvalidatesCache() {
public void simpleMapPropertySourceKeyDataChangeInvalidatesCache() {
// gh-13344
Map<String, Object> map = new LinkedHashMap<>();
map.put("key1", "value1");
Expand All @@ -169,6 +170,21 @@ public void propertySourceKeyDataChangeInvalidatesCache() {
assertThat(adapter.stream().count()).isEqualTo(3);
}

@Test
public void originTrackedMapPropertySourceKeyAdditionInvalidatesCache() {
// gh-13344
Map<String, Object> map = new LinkedHashMap<>();
map.put("key1", "value1");
map.put("key2", "value2");
EnumerablePropertySource<?> source = new OriginTrackedMapPropertySource("test",
map);
SpringIterableConfigurationPropertySource adapter = new SpringIterableConfigurationPropertySource(
source, DefaultPropertyMapper.INSTANCE);
assertThat(adapter.stream().count()).isEqualTo(2);
map.put("key3", "value3");
assertThat(adapter.stream().count()).isEqualTo(3);
}

/**
* Test {@link PropertySource} that's also an {@link OriginLookup}.
*/
Expand Down