Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove Guava cache support

Browse Source 
This commit removes `GuavaCache` and support classes. Caffeine supersedes
the caching support in the Google Guava library with an actively maintained
Java 8+ version in standalone form.

As it is the only Guava feature Spring framework integrates with, this
commit removes effectively any reference to Guava.

Issue: SPR-13797
This commit is contained in:
Stephane Nicoll
2016-07-08 10:57:05 +02:00
parent 7e783dd91f
commit 2bf9bc312e
9 changed files with 6 additions and 699 deletions
Download Patch File Download Diff File Expand all files Collapse all files

165
spring-context-support/src/main/java/org/springframework/cache/guava/GuavaCache.java vendored
View File

@@ -1,165 +0,0 @@
/*
* Copyright 2002-2015 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
*
* http://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.cache.guava;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import com.google.common.cache.LoadingCache;
import com.google.common.util.concurrent.UncheckedExecutionException;
import org.springframework.cache.support.AbstractValueAdaptingCache;
import org.springframework.util.Assert;
/**
* Spring {@link org.springframework.cache.Cache} adapter implementation
* on top of a Guava {@link com.google.common.cache.Cache} instance.
*
* <p>Requires Google Guava 12.0 or higher.
*
* @author Juergen Hoeller
* @author Stephane Nicoll
* @since 4.0
*/
public class GuavaCache extends AbstractValueAdaptingCache {
private final String name;
private final com.google.common.cache.Cache<Object, Object> cache;
/**
* Create a {@link GuavaCache} instance with the specified name and the
* given internal {@link com.google.common.cache.Cache} to use.
* @param name the name of the cache
* @param cache the backing Guava Cache instance
*/
public GuavaCache(String name, com.google.common.cache.Cache<Object, Object> cache) {
this(name, cache, true);
}
/**
* Create a {@link GuavaCache} instance with the specified name and the
* given internal {@link com.google.common.cache.Cache} to use.
* @param name the name of the cache
* @param cache the backing Guava Cache instance
* @param allowNullValues whether to accept and convert {@code null}
* values for this cache
*/
public GuavaCache(String name, com.google.common.cache.Cache<Object, Object> cache, boolean allowNullValues) {
super(allowNullValues);
Assert.notNull(name, "Name must not be null");
Assert.notNull(cache, "Cache must not be null");
this.name = name;
this.cache = cache;
}
@Override
public final String getName() {
return this.name;
}
@Override
public final com.google.common.cache.Cache<Object, Object> getNativeCache() {
return this.cache;
}
@Override
public ValueWrapper get(Object key) {
if (this.cache instanceof LoadingCache) {
try {
Object value = ((LoadingCache<Object, Object>) this.cache).get(key);
return toValueWrapper(value);
}
catch (ExecutionException ex) {
throw new UncheckedExecutionException(ex.getMessage(), ex);
}
}
return super.get(key);
}
@SuppressWarnings("unchecked")
@Override
public <T> T get(Object key, final Callable<T> valueLoader) {
try {
return (T) fromStoreValue(this.cache.get(key, new Callable<Object>() {
@Override
public Object call() throws Exception {
return toStoreValue(valueLoader.call());
}
}));
}
catch (ExecutionException ex) {
throw new ValueRetrievalException(key, valueLoader, ex.getCause());
}
catch (UncheckedExecutionException ex) {
throw new ValueRetrievalException(key, valueLoader, ex.getCause());
}
}
@Override
protected Object lookup(Object key) {
return this.cache.getIfPresent(key);
}
@Override
public void put(Object key, Object value) {
this.cache.put(key, toStoreValue(value));
}
@Override
public ValueWrapper putIfAbsent(Object key, final Object value) {
try {
PutIfAbsentCallable callable = new PutIfAbsentCallable(value);
Object result = this.cache.get(key, callable);
return (callable.called ? null : toValueWrapper(result));
}
catch (ExecutionException ex) {
throw new IllegalStateException(ex);
}
}
@Override
public void evict(Object key) {
this.cache.invalidate(key);
}
@Override
public void clear() {
this.cache.invalidateAll();
}
private class PutIfAbsentCallable implements Callable<Object> {
private final Object value;
private boolean called;
public PutIfAbsentCallable(Object value) {
this.value = value;
}
@Override
public Object call() throws Exception {
this.called = true;
return toStoreValue(this.value);
}
}
}

229
spring-context-support/src/main/java/org/springframework/cache/guava/GuavaCacheManager.java vendored
View File

@@ -1,229 +0,0 @@
/*
* Copyright 2002-2016 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
*
* http://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.cache.guava;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheBuilderSpec;
import com.google.common.cache.CacheLoader;
import org.springframework.cache.Cache;
import org.springframework.cache.CacheManager;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
/**
* {@link CacheManager} implementation that lazily builds {@link GuavaCache}
* instances for each {@link #getCache} request. Also supports a 'static' mode
* where the set of cache names is pre-defined through {@link #setCacheNames},
* with no dynamic creation of further cache regions at runtime.
*
* <p>The configuration of the underlying cache can be fine-tuned through a
* Guava {@link CacheBuilder} or {@link CacheBuilderSpec}, passed into this
* CacheManager through {@link #setCacheBuilder}/{@link #setCacheBuilderSpec}.
* A {@link CacheBuilderSpec}-compliant expression value can also be applied
* via the {@link #setCacheSpecification "cacheSpecification"} bean property.
*
* <p>Requires Google Guava 12.0 or higher.
*
* @author Juergen Hoeller
* @author Stephane Nicoll
* @since 4.0
* @see GuavaCache
*/
public class GuavaCacheManager implements CacheManager {
private final ConcurrentMap<String, Cache> cacheMap = new ConcurrentHashMap<>(16);
private boolean dynamic = true;
private CacheBuilder<Object, Object> cacheBuilder = CacheBuilder.newBuilder();
private CacheLoader<Object, Object> cacheLoader;
private boolean allowNullValues = true;
/**
* Construct a dynamic GuavaCacheManager,
* lazily creating cache instances as they are being requested.
*/
public GuavaCacheManager() {
}
/**
* Construct a static GuavaCacheManager,
* managing caches for the specified cache names only.
*/
public GuavaCacheManager(String... cacheNames) {
setCacheNames(Arrays.asList(cacheNames));
}
/**
* Specify the set of cache names for this CacheManager's 'static' mode.
* <p>The number of caches and their names will be fixed after a call to this method,
* with no creation of further cache regions at runtime.
* <p>Calling this with a {@code null} collection argument resets the
* mode to 'dynamic', allowing for further creation of caches again.
*/
public void setCacheNames(Collection<String> cacheNames) {
if (cacheNames != null) {
for (String name : cacheNames) {
this.cacheMap.put(name, createGuavaCache(name));
}
this.dynamic = false;
}
else {
this.dynamic = true;
}
}
/**
* Set the Guava CacheBuilder to use for building each individual
* {@link GuavaCache} instance.
* @see #createNativeGuavaCache
* @see com.google.common.cache.CacheBuilder#build()
*/
public void setCacheBuilder(CacheBuilder<Object, Object> cacheBuilder) {
Assert.notNull(cacheBuilder, "CacheBuilder must not be null");
doSetCacheBuilder(cacheBuilder);
}
/**
* Set the Guava CacheBuilderSpec to use for building each individual
* {@link GuavaCache} instance.
* @see #createNativeGuavaCache
* @see com.google.common.cache.CacheBuilder#from(CacheBuilderSpec)
*/
public void setCacheBuilderSpec(CacheBuilderSpec cacheBuilderSpec) {
doSetCacheBuilder(CacheBuilder.from(cacheBuilderSpec));
}
/**
* Set the Guava cache specification String to use for building each
* individual {@link GuavaCache} instance. The given value needs to
* comply with Guava's {@link CacheBuilderSpec} (see its javadoc).
* @see #createNativeGuavaCache
* @see com.google.common.cache.CacheBuilder#from(String)
*/
public void setCacheSpecification(String cacheSpecification) {
doSetCacheBuilder(CacheBuilder.from(cacheSpecification));
}
/**
* Set the Guava CacheLoader to use for building each individual
* {@link GuavaCache} instance, turning it into a LoadingCache.
* @see #createNativeGuavaCache
* @see com.google.common.cache.CacheBuilder#build(CacheLoader)
* @see com.google.common.cache.LoadingCache
*/
public void setCacheLoader(CacheLoader<Object, Object> cacheLoader) {
if (!ObjectUtils.nullSafeEquals(this.cacheLoader, cacheLoader)) {
this.cacheLoader = cacheLoader;
refreshKnownCaches();
}
}
/**
* Specify whether to accept and convert {@code null} values for all caches
* in this cache manager.
* <p>Default is "true", despite Guava itself not supporting {@code null} values.
* An internal holder object will be used to store user-level {@code null}s.
*/
public void setAllowNullValues(boolean allowNullValues) {
if (this.allowNullValues != allowNullValues) {
this.allowNullValues = allowNullValues;
refreshKnownCaches();
}
}
/**
* Return whether this cache manager accepts and converts {@code null} values
* for all of its caches.
*/
public boolean isAllowNullValues() {
return this.allowNullValues;
}
@Override
public Collection<String> getCacheNames() {
return Collections.unmodifiableSet(this.cacheMap.keySet());
}
@Override
public Cache getCache(String name) {
Cache cache = this.cacheMap.get(name);
if (cache == null && this.dynamic) {
synchronized (this.cacheMap) {
cache = this.cacheMap.get(name);
if (cache == null) {
cache = createGuavaCache(name);
this.cacheMap.put(name, cache);
}
}
}
return cache;
}
/**
* Create a new GuavaCache instance for the specified cache name.
* @param name the name of the cache
* @return the Spring GuavaCache adapter (or a decorator thereof)
*/
protected Cache createGuavaCache(String name) {
return new GuavaCache(name, createNativeGuavaCache(name), isAllowNullValues());
}
/**
* Create a native Guava Cache instance for the specified cache name.
* @param name the name of the cache
* @return the native Guava Cache instance
*/
protected com.google.common.cache.Cache<Object, Object> createNativeGuavaCache(String name) {
if (this.cacheLoader != null) {
return this.cacheBuilder.build(this.cacheLoader);
}
else {
return this.cacheBuilder.build();
}
}
private void doSetCacheBuilder(CacheBuilder<Object, Object> cacheBuilder) {
if (!ObjectUtils.nullSafeEquals(this.cacheBuilder, cacheBuilder)) {
this.cacheBuilder = cacheBuilder;
refreshKnownCaches();
}
}
/**
* Create the known caches again with the current state of this manager.
*/
private void refreshKnownCaches() {
for (Map.Entry<String, Cache> entry : this.cacheMap.entrySet()) {
entry.setValue(createGuavaCache(entry.getKey()));
}
}
}

6
spring-context-support/src/main/java/org/springframework/cache/guava/package-info.java vendored
View File

@@ -1,6 +0,0 @@
/**
* Support classes for the open source cache in Google's
* <a href="http://code.google.com/p/guava-libraries/">Guava</a> library,
* allowing to set up Guava caches within Spring's cache abstraction.
*/
package org.springframework.cache.guava;