《整合 spring 4(包括mvc、context、orm) + mybatis 3 示例》一文簡要介紹了最新版本的 Spring MVC、IOC、MyBatis ORM 三者的整合以及宣告式事務處理。現在我們需要把快取也整合進來，快取我們選用的是 Redis，本文將在該文示例基礎上介紹 Redis 快取 + Spring 的整合。關於 Redis 伺服器的搭建請參考部落格《Redhat5.8 環境下編譯安裝 Redis 並將其註冊為系統服務》。

1. 依賴包安裝

pom.xml 加入：

		<!-- redis cache related.....start -->
		<dependency>
			<groupId>org.springframework.data</groupId>
			<artifactId>spring-data-redis</artifactId>
			<version>1.6.0.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>redis.clients</groupId>
			<artifactId>jedis</artifactId>
			<version>2.7.3</version>
		</dependency>
		<!-- redis cache related.....end -->
 

2. Spring 專案整合進快取支援

要啟用快取支援，我們需要建立一個新的 CacheManager bean。CacheManager 介面有很多實現，本文演示的是和 Redis 的整合，自然就是用 RedisCacheManager 了。Redis 不是應用的共享記憶體，它只是一個記憶體伺服器，就像 MySql 似的，我們需要將應用連線到它並使用某種“語言”進行互動，因此我們還需要一個連線工廠以及一個 Spring 和 Redis 對話要用的 RedisTemplate，這些都是 Redis 快取所必需的配置，把它們都放在自定義的 CachingConfigurerSupport 中：

/**
 * File Name：RedisCacheConfig.java
 *
 * Copyright Defonds Corporation 2015 
 * All Rights Reserved
 *
 */
package com.defonds.bdp.cache.redis;

import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;

/**
 * 
 * Project Name：bdp 
 * Type Name：RedisCacheConfig 
 * Type Description：
 *  Author：Defonds
 * Create Date：2015-09-21
 * 
 * @version
 * 
 */
@Configuration
@EnableCaching
public class RedisCacheConfig extends CachingConfigurerSupport {

	@Bean
	public JedisConnectionFactory redisConnectionFactory() {
		JedisConnectionFactory redisConnectionFactory = new JedisConnectionFactory();

		// Defaults
		redisConnectionFactory.setHostName("192.168.1.166");
		redisConnectionFactory.setPort(6379);
		return redisConnectionFactory;
	}

	@Bean
	public RedisTemplate<String, String> redisTemplate(RedisConnectionFactory cf) {
		RedisTemplate<String, String> redisTemplate = new RedisTemplate<String, String>();
		redisTemplate.setConnectionFactory(cf);
		return redisTemplate;
	}

	@Bean
	public CacheManager cacheManager(RedisTemplate redisTemplate) {
		RedisCacheManager cacheManager = new RedisCacheManager(redisTemplate);

		// Number of seconds before expiration. Defaults to unlimited (0)
		cacheManager.setDefaultExpiration(3000); // Sets the default expire time (in seconds)
		return cacheManager;
	}
	
}
 

當然也別忘了把這些 bean 注入 Spring，不然配置無效。在 applicationContext.xml 中加入以下：

<context:component-scan base-package="com.defonds.bdp.cache.redis" />

3. 快取某些方法的執行結果

設定好快取配置之後我們就可以使用 @Cacheable 註解來快取方法執行的結果了，比如根據省份名檢索城市的 provinceCities 方法和根據 city_code 檢索城市的 searchCity 方法：

	// R
	@Cacheable("provinceCities")
	public List<City> provinceCities(String province) {
		logger.debug("province=" + province);
		return this.cityMapper.provinceCities(province);
	}
	
	// R
	@Cacheable("searchCity")
	public City searchCity(String city_code){
		logger.debug("city_code=" + city_code);
		return this.cityMapper.searchCity(city_code);	
	}
 

4. 快取資料一致性保證

CRUD (Create 建立，Retrieve 讀取，Update 更新，Delete 刪除) 操作中，除了 R 具備冪等性，其他三個發生的時候都可能會造成快取結果和資料庫不一致。為了保證快取資料的一致性，在進行 CUD 操作的時候我們需要對可能影響到的快取進行更新或者清除。

	// C
	@CacheEvict(value = { "provinceCities"}, allEntries = true)
	public void insertCity(String city_code, String city_jb, 
			String province_code, String city_name,
			String city, String province) {
		City cityBean = new City();
		cityBean.setCityCode(city_code);
		cityBean.setCityJb(city_jb);
		cityBean.setProvinceCode(province_code);
		cityBean.setCityName(city_name);
		cityBean.setCity(city);
		cityBean.setProvince(province);
		this.cityMapper.insertCity(cityBean);
	}
	// U
	@CacheEvict(value = { "provinceCities", "searchCity" }, allEntries = true)
	public int renameCity(String city_code, String city_name) {
		City city = new City();
		city.setCityCode(city_code);
		city.setCityName(city_name);
		this.cityMapper.renameCity(city);
		return 1;
	}
	
	// D
	@CacheEvict(value = { "provinceCities", "searchCity" }, allEntries = true)
	public int deleteCity(String city_code) {
		this.cityMapper.deleteCity(city_code);
		return 1;
	}

業務考慮，本示例用的都是 @CacheEvict 清除快取。如果你的 CUD 能夠返回 City 例項，也可以使用 @CachePut 更新快取策略。筆者推薦能用 @CachePut 的地方就不要用 @CacheEvict，因為後者將所有相關方法的快取都清理掉，比如上面三個方法中的任意一個被呼叫了的話，provinceCities 方法的所有快取將被清除。

5. 自定義快取資料 key 生成策略

對於使用 @Cacheable 註解的方法，每個快取的 key 生成策略預設使用的是引數名+引數值，比如以下方法：

@Cacheable("users")
public User findByUsername(String username)

這個方法的快取將保存於 key 為 users~keys 的快取下，對於 username 取值為 "趙德芳" 的快取，key 為 "username-趙德芳"。一般情況下沒啥問題，二般情況如方法 key 取值相等然後引數名也一樣的時候就出問題了，如：

@Cacheable("users")
public Integer getLoginCountByUsername(String username)

這個方法的快取也將保存於 key 為 users~keys 的快取下。對於 username 取值為 "趙德芳" 的快取，key 也為 "username-趙德芳"，將另外一個方法的快取覆蓋掉。
解決辦法是使用自定義快取策略，對於同一業務(同一業務邏輯處理的方法，哪怕是叢集/分散式系統)，生成的 key 始終一致，對於不同業務則不一致：

	@Bean
	public KeyGenerator customKeyGenerator() {
		return new KeyGenerator() {
			@Override
			public Object generate(Object o, Method method, Object... objects) {
				StringBuilder sb = new StringBuilder();
				sb.append(o.getClass().getName());
				sb.append(method.getName());
				for (Object obj : objects) {
					sb.append(obj.toString());
				}
				return sb.toString();
			}
		};
	}

於是上述兩個方法，對於 username 取值為 "趙德芳" 的快取，雖然都還是存放在 key 為 users~keys 的快取下，但由於 key 分別為 "類名-findByUsername-username-趙德芳" 和 "類名-getLoginCountByUsername-username-趙德芳"，所以也不會有問題。
這對於集群系統、分散式系統之間共享快取很重要，真正實現了分散式快取。
筆者建議：快取方法的 @Cacheable 最好使用方法名，避免不同的方法的 @Cacheable 值一致，然後再配以以上快取策略。

6. 快取的驗證

6.1 快取的驗證

為了確定每個快取方法到底有沒有走快取，我們打開了 MyBatis 的 SQL 日誌輸出，並且為了演示清楚，我們還清空了測試用 Redis 資料庫。
先來驗證 provinceCities 方法快取，Eclipse 啟動 tomcat 載入專案完畢，使用 JMeter 呼叫 /bdp/city/province/cities.json 介面：

Eclipse 控制檯輸出如下：

說明這一次請求沒有命中快取，走的是 db 查詢。JMeter 再次請求，Eclipse 控制檯輸出：

標紅部分以下是這一次請求的 log，沒有訪問 db 的 log，快取命中。檢視本次請求的 Redis 儲存情況：

同樣可以驗證 city_code 為 1492 的 searchCity 方法的快取是否有效：

圖中標紅部分是 searchCity 的快取儲存情況。

6.2 快取一致性的驗證

先來驗證 insertCity 方法的快取配置，JMeter 呼叫 /bdp/city/create.json 介面：

之後看 Redis 儲存：

可以看出 provinceCities 方法的快取已被清理掉，insertCity 方法的快取奏效。
然後驗證 renameCity 方法的快取配置，JMeter 呼叫 /bdp/city/rename.json 介面：

之後再看 Redis 儲存：

searchCity 方法的快取也已被清理，renameCity 方法的快取也奏效。

7. 注意事項

• 要快取的 Java 物件必須實現 Serializable 介面，因為 Spring 會將物件先序列化再存入 Redis，比如本文中的 com.defonds.bdp.city.bean.City 類，如果不實現 Serializable 的話將會遇到類似這種錯誤：nested exception is java.lang.IllegalArgumentException: DefaultSerializer requires a Serializable payload but received an object of type [com.defonds.bdp.city.bean.City]]。
• 快取的生命週期我們可以配置，然後託管 Spring CacheManager，不要試圖通過 redis-cli 命令列去管理快取。比如 provinceCities 方法的快取，某個省份的查詢結果會被以 key-value 的形式存放在 Redis，key 就是我們剛才自定義生成的 key，value 是序列化後的物件，這個 key 會被放在 key 名為 provinceCities~keys key-value 儲存中，參考下圖"provinceCities 方法在 Redis 中的快取情況"。可以通過 redis-cli 使用 del 命令將 provinceCities~keys 刪除，但每個省份的快取卻不會被清除。
• CacheManager 必須設定快取過期時間，否則快取物件將永不過期，這樣做的原因如上，避免一些野資料“永久儲存”。此外，設定快取過期時間也有助於資源利用最大化，因為快取裡保留的永遠是熱點資料。
• 快取適用於讀多寫少的場合，查詢時快取命中率很低、寫操作很頻繁等場景不適宜用快取。
  

後記

本文完整 Eclipse 下的開發專案示例已上傳 CSDN 資源，有興趣的朋友可以去下載下來參考：http://download.csdn.net/detail/defonds/9137505。

參考資料