詳解Redis 緩存 + Spring 的集成示例
《整合 spring 4(包括mvc、context、orm) + mybatis 3 示例》一文簡(jiǎn)要介紹了最新版本的 Spring MVC、IOC、MyBatis ORM 三者的整合以及聲明式事務(wù)處理?，F(xiàn)在我們需要把緩存也整合進(jìn)來，緩存我們選用的是 Redis，本文將在該文示例基礎(chǔ)上介紹 Redis 緩存 + Spring 的集成。
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 項(xiàng)目集成進(jìn)緩存支持
要啟用緩存支持，我們需要?jiǎng)?chuàng)建一個(gè)新的 CacheManager bean。CacheManager 接口有很多實(shí)現(xiàn)，本文演示的是和 Redis 的集成，自然就是用 RedisCacheManager 了。Redis 不是應(yīng)用的共享內(nèi)存，它只是一個(gè)內(nèi)存服務(wù)器，就像 MySql 似的，我們需要將應(yīng)用連接到它并使用某種“語言”進(jìn)行交互，因此我們還需要一個(gè)連接工廠以及一個(gè) Spring 和 Redis 對(duì)話要用的 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;
}
}
當(dāng)然也別忘了把這些 bean 注入 Spring，不然配置無效。在 applicationContext.xml 中加入以下：
<context:component-scan base-package="com.defonds.bdp.cache.redis" />
3. 緩存某些方法的執(zhí)行結(jié)果
設(shè)置好緩存配置之后我們就可以使用 @Cacheable 注解來緩存方法執(zhí)行的結(jié)果了，比如根據(jù)省份名檢索城市的 provinceCities 方法和根據(jù) 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. 緩存數(shù)據(jù)一致性保證
CRUD (Create 創(chuàng)建，Retrieve 讀取，Update 更新，Delete 刪除) 操作中，除了 R 具備冪等性，其他三個(gè)發(fā)生的時(shí)候都可能會(huì)造成緩存結(jié)果和數(shù)據(jù)庫(kù)不一致。為了保證緩存數(shù)據(jù)的一致性，在進(jìn)行 CUD 操作的時(shí)候我們需要對(duì)可能影響到的緩存進(jìn)行更新或者清除。
// 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;
}
業(yè)務(wù)考慮，本示例用的都是 @CacheEvict 清除緩存。如果你的 CUD 能夠返回 City 實(shí)例，也可以使用 @CachePut 更新緩存策略。筆者推薦能用 @CachePut 的地方就不要用 @CacheEvict，因?yàn)楹笳邔⑺邢嚓P(guān)方法的緩存都清理掉，比如上面三個(gè)方法中的任意一個(gè)被調(diào)用了的話，provinceCities 方法的所有緩存將被清除。
5. 自定義緩存數(shù)據(jù) key 生成策略
對(duì)于使用 @Cacheable 注解的方法，每個(gè)緩存的 key 生成策略默認(rèn)使用的是參數(shù)名+參數(shù)值，比如以下方法：
@Cacheable("users")
public User findByUsername(String username)
這個(gè)方法的緩存將保存于 key 為 users~keys 的緩存下，對(duì)于 username 取值為 "趙德芳" 的緩存，key 為 "username-趙德芳"。一般情況下沒啥問題，二般情況如方法 key 取值相等然后參數(shù)名也一樣的時(shí)候就出問題了，如：
@Cacheable("users")
public Integer getLoginCountByUsername(String username)
這個(gè)方法的緩存也將保存于 key 為 users~keys 的緩存下。對(duì)于 username 取值為 "趙德芳" 的緩存，key 也為 "username-趙德芳"，將另外一個(gè)方法的緩存覆蓋掉。
解決辦法是使用自定義緩存策略，對(duì)于同一業(yè)務(wù)(同一業(yè)務(wù)邏輯處理的方法，哪怕是集群/分布式系統(tǒng))，生成的 key 始終一致，對(duì)于不同業(yè)務(wù)則不一致：
@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();
}
};
}
于是上述兩個(gè)方法，對(duì)于 username 取值為 "趙德芳" 的緩存，雖然都還是存放在 key 為 users~keys 的緩存下，但由于 key 分別為 "類名-findByUsername-username-趙德芳" 和 "類名-getLoginCountByUsername-username-趙德芳"，所以也不會(huì)有問題。
這對(duì)于集群系統(tǒng)、分布式系統(tǒng)之間共享緩存很重要，真正實(shí)現(xiàn)了分布式緩存。
筆者建議：緩存方法的 @Cacheable 最好使用方法名，避免不同的方法的 @Cacheable 值一致，然后再配以以上緩存策略。
6. 緩存的驗(yàn)證
6.1 緩存的驗(yàn)證
為了確定每個(gè)緩存方法到底有沒有走緩存，我們打開了 MyBatis 的 SQL 日志輸出，并且為了演示清楚，我們還清空了測(cè)試用 Redis 數(shù)據(jù)庫(kù)。
先來驗(yàn)證 provinceCities 方法緩存，Eclipse 啟動(dòng) tomcat 加載項(xiàng)目完畢，使用 JMeter 調(diào)用 /bdp/city/province/cities.json 接口：
Eclipse 控制臺(tái)輸出如下：
說明這一次請(qǐng)求沒有命中緩存，走的是 db 查詢。JMeter 再次請(qǐng)求，Eclipse 控制臺(tái)輸出：
輸出：
標(biāo)紅部分以下是這一次請(qǐng)求的 log，沒有訪問 db 的 log，緩存命中。查看本次請(qǐng)求的 Redis 存儲(chǔ)情況：
同樣可以驗(yàn)證 city_code 為 1492 的 searchCity 方法的緩存是否有效：
圖中標(biāo)紅部分是 searchCity 的緩存存儲(chǔ)情況。
6.2 緩存一致性的驗(yàn)證
先來驗(yàn)證 insertCity 方法的緩存配置，JMeter 調(diào)用 /bdp/city/create.json 接口：
之后看 Redis 存儲(chǔ)：
可以看出 provinceCities 方法的緩存已被清理掉，insertCity 方法的緩存奏效。
然后驗(yàn)證 renameCity 方法的緩存配置，JMeter 調(diào)用 /bdp/city/rename.json 接口：
之后再看 Redis 存儲(chǔ)：
searchCity 方法的緩存也已被清理，renameCity 方法的緩存也奏效。
7. 注意事項(xiàng)
- 要緩存的 Java 對(duì)象必須實(shí)現(xiàn) Serializable 接口，因?yàn)?Spring 會(huì)將對(duì)象先序列化再存入 Redis，比如本文中的 com.defonds.bdp.city.bean.City 類，如果不實(shí)現(xiàn) Serializable 的話將會(huì)遇到類似這種錯(cuò)誤：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 方法的緩存，某個(gè)省份的查詢結(jié)果會(huì)被以 key-value 的形式存放在 Redis，key 就是我們剛才自定義生成的 key，value 是序列化后的對(duì)象，這個(gè) key 會(huì)被放在 key 名為 provinceCities~keys key-value 存儲(chǔ)中，參考下圖"provinceCities 方法在 Redis 中的緩存情況"?？梢酝ㄟ^ redis-cli 使用 del 命令將 provinceCities~keys 刪除，但每個(gè)省份的緩存卻不會(huì)被清除。
- CacheManager 必須設(shè)置緩存過期時(shí)間，否則緩存對(duì)象將永不過期，這樣做的原因如上，避免一些野數(shù)據(jù)“永久保存”。此外，設(shè)置緩存過期時(shí)間也有助于資源利用最大化，因?yàn)榫彺胬锉Ａ舻挠肋h(yuǎn)是熱點(diǎn)數(shù)據(jù)。
- 緩存適用于讀多寫少的場(chǎng)合，查詢時(shí)緩存命中率很低、寫操作很頻繁等場(chǎng)景不適宜用緩存。
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了Spring Boot 2.X 如何快速整合jpa？,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-08-08
SpringBatch是一個(gè)開源 的、全面的、輕量級(jí)的批處理框架，通過SpringBoot可以實(shí)現(xiàn)強(qiáng)大的批處理應(yīng)用程序開發(fā)，本文主要介紹了SpringBoot批處理的實(shí)現(xiàn)示例，感興趣的可以了解一下2022-03-03
jackson json序列化實(shí)現(xiàn)首字母大寫,第二個(gè)字母需小寫
這篇文章主要介紹了jackson json序列化實(shí)現(xiàn)首字母大寫,第二個(gè)字母需小寫方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-06-06
這篇文章主要介紹了Sentinel熔斷規(guī)則，采用了示例代碼的方式對(duì)Sentinel熔斷規(guī)則進(jìn)行了詳細(xì)的分析，以便廣大讀者朋友們更易理解，有需要的朋友可以參考下2021-09-09
Idea如何導(dǎo)入一個(gè)SpringBoot項(xiàng)目的方法(圖文教程)
這篇文章主要介紹了Idea如何導(dǎo)入一個(gè)SpringBoot項(xiàng)目的方法(圖文教程)，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09
這篇文章主要介紹了jkd動(dòng)態(tài)代理源碼分析過程,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-08-08
spring boot與spring mvc的區(qū)別及功能介紹
這篇文章主要介紹了spring boot與spring mvc的區(qū)別是什么以及spring boot和spring mvc功能介紹，感興趣的朋友一起看看吧2018-02-02
Spring Security實(shí)現(xiàn)不同接口安全策略方法詳解
這篇文章主要介紹了Spring Security實(shí)現(xiàn)不同接口安全策略方法詳解,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-09-09
在啟動(dòng)后臺(tái) jar包時(shí),使用指定的 application.yml操作
這篇文章主要介紹了在啟動(dòng)后臺(tái) jar包時(shí),使用指定的 application.yml操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2020-10-10
jxl 導(dǎo)出數(shù)據(jù)到excel的實(shí)例講解
下面小編就為大家分享一篇jxl 導(dǎo)出數(shù)據(jù)到excel的實(shí)例講解，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2017-12-12