原創-轉載請注明 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