Spring @CacheEvict使用通配符

时间:2013-07-19 14:46:26

标签: java spring caching

在@CacheEvict中有没有办法使用通配符?

我有一个多租户应用程序,有时需要从租户的缓存中驱逐所有数据,而不是系统中所有租户的数据。

考虑以下方法:

@Cacheable(value="users", key="T(Security).getTenant() + #user.key")
public List<User> getUsers(User user) {
    ...
}

所以,我想做点什么:

@CacheEvict(value="users", key="T(Security).getTenant() + *")
public void deleteOrganization(Organization organization) {
    ...
}

无论如何都要这样做?

4 个答案:

答案 0 :(得分:3)

答案是:否。

实现你想要的东西并不容易。

  1. Spring Cache注释必须易于通过缓存提供程序实现。
  2. 高效的缓存必须简单。有一个关键和价值。如果在缓存中找到密钥,则使用该值,否则计算值并将其置于缓存中。高效密钥必须具有快速且诚实的等于()哈希码()。假设您从一个租户缓存了许多对(密钥,值)。为了提高效率,不同的密钥应该具有不同的 hashcode()。而你决定驱逐整个租户。在缓存中找到租户元素并不容易。您必须迭代所有缓存对并丢弃属于租户的对。效率不高。它不是原子的,所以它很复杂,需要一些同步。同步效率不高。
  3. 因此没有。

    但是,如果你找到一个解决方案告诉我,因为你想要的功能非常有用。

答案 1 :(得分:1)

与宇宙中每个问题的99%一样,答案是:它取决于。如果你的缓存管理器实现了一些处理它的东西,那很好。但情况似乎并非如此。

如果您正在使用SimpleCacheManager,这是Spring提供的基本内存缓存管理器,那么您可能正在使用Spring附带的ConcurrentMapCache。虽然无法扩展ConcurrentMapCache来处理密钥中的通配符(因为缓存存储是私有的,您无法访问它),但您可以将它用作您自己实现的灵感。

下面是一个可能的实现(我没有真正测试它,除了检查它是否正常工作)。这是ConcurrentMapCache的简单副本,对evict()方法进行了修改。不同之处在于此evict()版本对待密钥以查看它是否为正则表达式。在这种情况下,它遍历商店中的所有键并逐出与正则表达式匹配的键。

package com.sigraweb.cache;

import java.io.Serializable;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

import org.springframework.cache.Cache;
import org.springframework.cache.support.SimpleValueWrapper;
import org.springframework.util.Assert;

public class RegexKeyCache implements Cache {
    private static final Object NULL_HOLDER = new NullHolder();

    private final String name;

    private final ConcurrentMap<Object, Object> store;

    private final boolean allowNullValues;

    public RegexKeyCache(String name) {
        this(name, new ConcurrentHashMap<Object, Object>(256), true);
    }

    public RegexKeyCache(String name, boolean allowNullValues) {
        this(name, new ConcurrentHashMap<Object, Object>(256), allowNullValues);
    }

    public RegexKeyCache(String name, ConcurrentMap<Object, Object> store, boolean allowNullValues) {
        Assert.notNull(name, "Name must not be null");
        Assert.notNull(store, "Store must not be null");
        this.name = name;
        this.store = store;
        this.allowNullValues = allowNullValues;
    }

    @Override
    public final String getName() {
        return this.name;
    }

    @Override
    public final ConcurrentMap<Object, Object> getNativeCache() {
        return this.store;
    }

    public final boolean isAllowNullValues() {
        return this.allowNullValues;
    }

    @Override
    public ValueWrapper get(Object key) {
        Object value = this.store.get(key);
        return toWrapper(value);
    }

    @Override
    @SuppressWarnings("unchecked")
    public <T> T get(Object key, Class<T> type) {
        Object value = fromStoreValue(this.store.get(key));
        if (value != null && type != null && !type.isInstance(value)) {
            throw new IllegalStateException("Cached value is not of required type [" + type.getName() + "]: " + value);
        }
        return (T) value;
    }

    @Override
    public void put(Object key, Object value) {
        this.store.put(key, toStoreValue(value));
    }

    @Override
    public ValueWrapper putIfAbsent(Object key, Object value) {
        Object existing = this.store.putIfAbsent(key, value);
        return toWrapper(existing);
    }

    @Override
    public void evict(Object key) {
        this.store.remove(key);
        if (key.toString().startsWith("regex:")) {
            String r = key.toString().replace("regex:", "");
            for (Object k : this.store.keySet()) {
                if (k.toString().matches(r)) {
                    this.store.remove(k);
                }
            }
        }
    }

    @Override
    public void clear() {
        this.store.clear();
    }

    protected Object fromStoreValue(Object storeValue) {
        if (this.allowNullValues && storeValue == NULL_HOLDER) {
            return null;
        }
        return storeValue;
    }

    protected Object toStoreValue(Object userValue) {
        if (this.allowNullValues && userValue == null) {
            return NULL_HOLDER;
        }
        return userValue;
    }

    private ValueWrapper toWrapper(Object value) {
        return (value != null ? new SimpleValueWrapper(fromStoreValue(value)) : null);
    }

    @SuppressWarnings("serial")
    private static class NullHolder implements Serializable {
    }
}

我相信读者知道如何使用自定义缓存实现来初始化缓存管理器。那里有很多文档向您展示如何做到这一点。正确配置项目后,您可以正常使用注释:

@CacheEvict(value = { "cacheName" }, key = "'regex:#tenant'+'.*'")
public myMethod(String tenant){
...
}

同样,这远未经过适当的测试,但它为您提供了一种方法来做您想做的事情。如果您正在使用另一个缓存管理器,则可以类似地扩展其缓存实现。

答案 2 :(得分:1)

以下在Redis Cache上为我工作。 假设您要删除所有具有键前缀:'cache-name:object-name:parentKey'的Cache条目。带有键值cache-name:object-name:parentKey*的调用方法。

import org.springframework.data.redis.core.RedisOperations;    
...
private final RedisOperations<Object, Object> redisTemplate;
...    
public void evict(Object key)
{
    redisTemplate.delete(redisTemplate.keys(key));
}

来自RedisOperations.java

/**
 * Delete given {@code keys}.
 *
 * @param keys must not be {@literal null}.
 * @return The number of keys that were removed.
 * @see <a href="http://redis.io/commands/del">Redis Documentation: DEL</a>
 */
void delete(Collection<K> keys);

/**
 * Find all keys matching the given {@code pattern}.
 *
 * @param pattern must not be {@literal null}.
 * @return
 * @see <a href="http://redis.io/commands/keys">Redis Documentation: KEYS</a>
 */
Set<K> keys(K pattern);

答案 3 :(得分:0)

通过实现自定义CacheResolver将租户作为缓存名称的一部分;扩展和实施SimpleCacheResolver.getCacheName

然后撤离所有按键

@CacheEvict(value = {CacheName.CACHE1, CacheName.CACHE2}, allEntries = true)

但是请注意,如果您将Redis用作后备缓存,那么在后台Spring将使用KEYS命令,因此该解决方案将无法扩展。一旦您在redis中获得少量100K密钥,KEYS将花费150ms,redis服务器将成为CPU的瓶颈。顽皮的春天。