Spring Cache不适用于抽象类

时间:2016-05-02 07:57:17

标签: java spring spring-mvc inheritance caching

我试图在抽象类中使用Spring Cache,但它不会起作用,因为从我所看到的,Spring正在抽象类中搜索CacheNames。我有一个使用服务层和dao层的REST API。我们的想法是为每个子类设置不同的缓存名称。

我的抽象服务类如下所示:

    @Service
    @Transactional
    public abstract class AbstractService<E> {

...

    @Cacheable
    public List<E> findAll() {
        return getDao().findAll();
    }
}

抽象类的扩展名如下所示:

@Service
@CacheConfig(cacheNames = "textdocuments")
public class TextdocumentsService extends AbstractService<Textdocuments> {
...
}

因此,当我使用此代码启动应用程序时,Spring给出了以下异常:

Caused by: java.lang.IllegalStateException: No cache names could be detected on 'public java.util.List foo.bar.AbstractService.findAll()'. Make sure to set the value parameter on the annotation or declare a @CacheConfig at the class-level with the default cache name(s) to use.
    at org.springframework.cache.annotation.SpringCacheAnnotationParser.validateCacheOperation(SpringCacheAnnotationParser.java:240) ~[spring-context-4.1.6.RELEASE.jar:?]

我认为这是因为Spring在抽象类上搜索CacheName,尽管它是在子类上声明的。

尝试使用

 @Service
 @Transactional
 @CacheConfig
        public abstract class AbstractService<E> {
    }

导致同样的例外;使用

 @Service
 @Transactional
 @CacheConfig(cacheNames = "abstractservice")
        public abstract class AbstractService<E> {
    }

没有例外,但是Spring Cache为每个子类使用相同的缓存名称,并忽略在子类上定义的缓存名称。有什么想法可以解决这个问题吗?

1 个答案:

答案 0 :(得分:2)

此问题已在another question中得到解决,与抽象类无关,而与框架确定要使用哪个缓存的能力有关。

长话短说(引自Spring documentation),您缺少适合您的抽象类层次结构的CacheResolver

  

从Spring 4.1开始,缓存注释的value属性不再是必需的,因为CacheResolver可以提供此特定信息,而与注释的内容无关。

因此,您的抽象类应定义一个缓存解析器,而不是直接声明缓存名称。

abstract class Repository<T> {
    // .. some methods omitted for brevity

    @Cacheable(cacheResolver = CachingConfiguration.CACHE_RESOLVER_NAME)
    public List<T> findAll() {
        return getDao().findAll();
    }
}

解析器确定要用于拦截方法调用的Cache实例。一个非常幼稚的实现可以采用目标存储库Bean(按名称)并将其用作缓存名称

class RuntimeCacheResolver
        extends SimpleCacheResolver {

    protected RuntimeCacheResolver(CacheManager cacheManager) {
        super(cacheManager);
    }

    @Override
    protected Collection<String> getCacheNames(CacheOperationInvocationContext<?> context) {
        return Arrays.asList(context.getTarget().getClass().getSimpleName());
    }
}

此类解析程序需要显式配置:

@Configuration
@EnableCaching
class CachingConfiguration extends CachingConfigurerSupport {

    final static String CACHE_RESOLVER_NAME = "simpleCacheResolver";

    @Bean
    @Override
    public CacheManager cacheManager() {
        return new ConcurrentMapCacheManager();
    }

    @Bean(CACHE_RESOLVER_NAME)
    public CacheResolver cacheResolver(CacheManager cacheManager) {
        return new RuntimeCacheResolver(cacheManager);
    }
}

我已经create a Gist详细描述了整个概念。

免责声明

以上代码片段仅用于演示,目的是提供指导,而不是提供完整的解决方案。上面的缓存解析器实现非常幼稚,不会考虑很多东西(例如方法参数等)。我永远不会在生产环境中使用它。

Spring处理缓存的方式是通过代理,@Cacheable批注声明缓存以及在运行时处理的命名信息。缓存是通过提供给缓存解析器的运行时信息解析的(毫不奇怪,它类似于经典AOP的InvocationContext)。

public interface CacheOperationInvocationContext<O extends BasicOperation> {
    O getOperation();
    Object getTarget();
    Method getMethod();
    Object[] getArgs();
}

通过getTarget()方法可以确定代理哪个bean,但是在现实生活中,应该考虑更多信息,以提供可靠的缓存(如方法参数等)。