public interface CachingConfigurer
Configuration classes annotated with @EnableCaching that wish or need to
specify explicitly how caches are resolved and how keys are generated for annotation-driven
cache management. Consider extending CachingConfigurerSupport, which provides a
stub implementation of all interface methods.
See @EnableCaching for general examples and context; see
cacheManager(), cacheResolver() and keyGenerator()
for detailed instructions.
EnableCaching,
CachingConfigurerSupport| Modifier and Type | Method and Description |
|---|---|
CacheManager |
cacheManager()
Return the cache manager bean to use for annotation-driven cache
management.
|
CacheResolver |
cacheResolver()
Return the
CacheResolver bean to use to resolve regular caches for
annotation-driven cache management. |
CacheErrorHandler |
errorHandler()
Return the
CacheErrorHandler to use to handle cache-related errors. |
KeyGenerator |
keyGenerator()
Return the key generator bean to use for annotation-driven cache management.
|
CacheManager cacheManager()
CacheResolver will be initialized
behind the scenes with this cache manager. For more fine-grained
management of the cache resolution, consider setting the
CacheResolver directly.
Implementations must explicitly declare
@Bean, e.g.
@Configuration
@EnableCaching
public class AppConfig extends CachingConfigurerSupport {
@Bean // important!
@Override
public CacheManager cacheManager() {
// configure and return CacheManager instance
}
// ...
}
See @EnableCaching for more complete examples.CacheResolver cacheResolver()
CacheResolver bean to use to resolve regular caches for
annotation-driven cache management. This is an alternative and more powerful
option of specifying the CacheManager to use.
If both a cacheManager() and cacheResolver() are set, the
cache manager is ignored.
Implementations must explicitly declare
@Bean, e.g.
@Configuration
@EnableCaching
public class AppConfig extends CachingConfigurerSupport {
@Bean // important!
@Override
public CacheResolver cacheResolver() {
// configure and return CacheResolver instance
}
// ...
}
See EnableCaching for more complete examples.KeyGenerator keyGenerator()
@Bean, e.g.
@Configuration
@EnableCaching
public class AppConfig extends CachingConfigurerSupport {
@Bean // important!
@Override
public KeyGenerator keyGenerator() {
// configure and return KeyGenerator instance
}
// ...
}
See @EnableCaching for more complete examples.CacheErrorHandler errorHandler()
CacheErrorHandler to use to handle cache-related errors.
By default,SimpleCacheErrorHandler
is used and simply throws the exception back at the client.
Implementations must explicitly declare
@Bean, e.g.
@Configuration
@EnableCaching
public class AppConfig extends CachingConfigurerSupport {
@Bean // important!
@Override
public CacheErrorHandler errorHandler() {
// configure and return CacheErrorHandler instance
}
// ...
}
See @EnableCaching for more complete examples.