原创-转载请注明 http://tramp.cincout.cn/2017/10/31/spring-boot-2017-10-31-spring-boot-multi-cache-manager/

摘要

Spring Cache 为企业级级应用提供了类似于 Spring Transactional 的声明式缓存抽象层。Spring 采用 AOP 的方式实现对多种底层缓存技术的适配。包括 REDIS、COUCHBASE、EHCACHE 等。
当配置好 spring.cache.type=REDIS 时， Spring Boot 的自动装配策略会自动的为我们配置好需要的底层缓存框架以及对应的CacheManager。这在大多数场景下是满足需求的。
笔者在实际开发中遇到的场景是一些常量信息需要存储到Redis中，利用Redis 的分布式缓存功能，使得多个节点可以共享该数据；一些需要基于特定的缓存清理规则（采用LRU存储最近最常使用的10000 条）的数据则需要采用EhCache 实现。

原理

Spring Boot 的自动装配

当引入 spring-boot-starter-data-redis 时，Spring Boot 会采用RedisAutoConfiguration 会我们配置好 Redis 的基础配置信息。具体参见该类。在本项目中我们采用的时 EnCache 2.x, 因此需要我们单独引入对应的依赖。
当引入 spring-boot-starter-cache，以及注解了@EnableCaching 时， Spring Boot 便会采用CacheAutoConfiguration 和 RedisCacheConfiguration 来进行自n一如多个动装配。装配的条件是缺少 CacheManager.class 实例 Bean。

因此，当需要引入多个 CacheManager 的需要我们自己来分别配置。

实现

pom 依赖

需要引入的核心依赖如下，具体的参见后文的源代码链接：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

<!-- https://mvnrepository.com/artifact/net.sf.ehcache/ehcache -->
<dependency>
    <groupId>net.sf.ehcache</groupId>
    <artifactId>ehcache</artifactId>
    <version>2.10.4</version>
</dependency>
<!-- https://mvnrepository.com/artifact/net.sf.ehcache/ehcache-core -->
<dependency>
    <groupId>net.sf.ehcache</groupId>
    <artifactId>ehcache-core</artifactId>
    <version>2.6.11</version>
</dependency>

application.properties

在application.properties 可以配置底层 Redis 数据源的相关信息：

spring.redis.host=cincout.cn
spring.redis.port=6379

配置 CacheManager

分别配置 RedisCacheManager 和 EhCacheCacheManager：

@Configuration
@EnableCaching
public class CacheConfig implements ApplicationRunner {

    @Resource
    private List<CacheManager> cacheManagers;

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(cacheManagers.size());
    }

    @Bean(name = "redisCacheManager")
    public RedisCacheManager redisCacheManager(RedisTemplate<Object, Object> redisTemplate) {
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        RedisCacheManager redisCacheManager = new RedisCacheManager(redisTemplate);
        redisCacheManager.setCacheNames(Arrays.asList("user"));
        redisCacheManager.setUsePrefix(true);
        return redisCacheManager;
    }

    @Bean(name = "ehcache")
    public EhCacheManagerFactoryBean ehCacheManagerFactoryBean() {
        EhCacheManagerFactoryBean cacheBean = new EhCacheManagerFactoryBean();
        cacheBean.setConfigLocation(new ClassPathResource("ehcache.xml"));
        return cacheBean;
    }

    @Bean("ehCacheCacheManager")
    public EhCacheCacheManager ehCacheCacheManager(@Qualifier("ehcache") net.sf.ehcache.CacheManager ehcacheManager) {
        EhCacheCacheManager ehCacheCacheManager = new EhCacheCacheManager(ehcacheManager);
        return ehCacheCacheManager;
    }

    @Bean(name = "cacheManager")
    @Primary
    public CompositeCacheManager cacheManager(RedisCacheManager redisCacheManager, EhCacheCacheManager ehCacheCacheManager) {
        CompositeCacheManager cacheManager = new CompositeCacheManager(redisCacheManager, ehCacheCacheManager);
        return cacheManager;
    }
}

encache.xml 配置文件的内容：

<?xml version="1.0" encoding="UTF-8"?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd"
    updateCheck="false">
    <defaultCache eternal="false" maxElementsInMemory="1000"
        overflowToDisk="false" diskPersistent="false" timeToIdleSeconds="0"
        timeToLiveSeconds="600" memoryStoreEvictionPolicy="LRU" />

    <!--  200 * 10 := 2k per api metadata -->
    <cache name="api" maxElementsInMemory="10000" eternal="false"
        timeToIdleSeconds="0" timeToLiveSeconds="600" overflowToDisk="false"
        diskPersistent="false" diskExpiryThreadIntervalSeconds="120"
        memoryStoreEvictionPolicy="LRU">
    </cache>
</ehcache>

该文件定义了名字为api 的cache 的缓存策略。具体的参见Ehcache。

业务中使用

在业务代码中使用时为了区分不同的业务使用不同的CacheManager 有两种方式实现。

• 在业务代码中采用@CacheConfig, @CachePut, @Cacheable, @CacheEvict 来进行缓存的配置。它们都拥有cacheManager 这个属性。
  具体配置:

@Service
@CacheConfig(cacheManager = "ehCacheCacheManager")
public class ApiMetaServiceImpl implements ApiMetaService {
    private final static Logger LOG = LoggerFactory.getLogger(ApiMetaServiceImpl.class);

    @Override
    @CachePut(cacheNames = "api", key = "#api.id.toString()")
    public Api save(Api api) {
        LOG.info("save {}", api);
        return api;
    }

    @Override
    @Cacheable(cacheNames = "api", key = "#id.toString()")
    public Api get(Integer id) {
        LOG.info("get {}", id);
        return new Api(1, "x");
    }
}

@Service
@CacheConfig(cacheManager = "redisCacheManager")
public class UserServiceImpl implements UserService {
    private final static Logger LOG = LoggerFactory.getLogger(UserServiceImpl.class);

    @Override
    @CachePut(cacheNames = "user", key = "#user.id.toString()")
    public User save(User user) {
        LOG.info("saved user {}", user);
        return user;
    }

    @Override
    @CacheEvict(cacheNames = "user")
    public void delete(int id) {
        LOG.info("delete {}", id);
    }

    @Override
    @Cacheable(cacheNames = "user")
    public User get(int id) {
        LOG.info("get user {}", id);
        return new User(1, "zhang");
    }
}

• 采用CompositeCacheManager。 Spring Cache在 CacheManager 之下可以采用缓存名称(cacheNames 属性)来对缓存进行区分。Spring Cache 提供了CompositeCacheManager 来对所有的 CacheManager 进行代理。
  根据指定的cacheName 去遍历所有的 CacheManager，查找对应的缓存。

RedisCacheManager指定CacheNames

redisCacheManager.setCacheNames(Arrays.asList("user"));
redisCacheManager.setUsePrefix(true);

同时需要在缓存相关的注解上配置 cacheNames 属性。

EnCache

EnCache 直接在其配置文件中指明：

<cache name="api" maxElementsInMemory="10000" eternal="false"
        timeToIdleSeconds="0" timeToLiveSeconds="600" overflowToDisk="false"
        diskPersistent="false" diskExpiryThreadIntervalSeconds="120"
        memoryStoreEvictionPolicy="LRU">
</cache>

配置基于CompositeCacheManager 的CacheManager

@Bean(name = "cacheManager")
@Primary
public CompositeCacheManager cacheManager(RedisCacheManager redisCacheManager, EhCacheCacheManager ehCacheCacheManager) {
    CompositeCacheManager cacheManager = new CompositeCacheManager(redisCacheManager, ehCacheCacheManager);
    return cacheManager;
}

由于当前 Spring Context 中存在多个实现了 CacheManager.class 的 Bean，需要使用 @Primary 注解指定优先选择的 CacheManager。

不然CacheAspectSupport.class 会抛出No CacheResolver specified, and no unique bean of type CacheManager found. Mark one as primary (or give it the name 'cacheManager') or declare a specific CacheManager to use, that serves as the default one. 的错误。

业务代码的配置

此时在业务代码中就不需要配置 CacheManager：

@Service
@CacheConfig
public class UserServiceImpl implements UserService {
    private final static Logger LOG = LoggerFactory.getLogger(UserServiceImpl.class);

    @Override
    @CachePut(cacheNames = "user", key = "#user.id.toString()")
    public User save(User user) {
        LOG.info("saved user {}", user);
        return user;
    }

    @Override
    @CacheEvict(cacheNames = "user")
    public void delete(int id) {
        LOG.info("delete {}", id);
    }

    @Override
    @Cacheable(cacheNames = "user")
    public User get(int id) {
        LOG.info("get user {}", id);
        return new User(1, "zhang");
    }
}

源代码

本工程源代码可以从github 获取。源代码

总结

本文介绍了 Spring Cache 配置多种不同的 CacheManager 的具体实现方案，在实际生产中可以直接使用。 在使用 Spring Boot 的自动装配时，我们一定要搞清楚其底层的配置原理。遇到默认的配置不能满足时，就需要我们阅读文档和源代码来进行解决了。
本文没有涉及到 Spring Cache 的具体使用，相关的内容会在后续推出。

参考

1. Spring Reference
2. Spring Boot Reference
3. Ehcache