专栏首页用户2442861的专栏Redis 缓存 + Spring 的集成示例 (不错的bolg)

Redis 缓存 + Spring 的集成示例 (不错的bolg)

http://blog.csdn.net/defonds/article/details/48716161  

整合 spring 4(包括mvc、context、orm) + mybatis 3 示例》一文简要介绍了最新版本的 Spring MVC、IOC、MyBatis ORM 三者的整合以及声明式事务处理。现在我们需要把缓存也整合进来,缓存我们选用的是 Redis,本文将在该文示例基础上介绍 Redis 缓存 + Spring 的集成。关于 Redis 服务器的搭建请参考博客《Redhat5.8 环境下编译安装 Redis 并将其注册为系统服务》。

1. 依赖包安装

pom.xml 加入:

[html] view plain copy

print?

  1. <!-- redis cache related.....start -->
  2. <dependency>
  3. <groupId>org.springframework.data</groupId>
  4. <artifactId>spring-data-redis</artifactId>
  5. <version>1.6.0.RELEASE</version>
  6. </dependency>
  7. <dependency>
  8. <groupId>redis.clients</groupId>
  9. <artifactId>jedis</artifactId>
  10. <version>2.7.3</version>
  11. </dependency>
  12. <!-- redis cache related.....end -->

2. Spring 项目集成进缓存支持

要启用缓存支持,我们需要创建一个新的 CacheManager bean。CacheManager 接口有很多实现,本文演示的是和 Redis 的集成,自然就是用 RedisCacheManager 了。Redis 不是应用的共享内存,它只是一个内存服务器,就像 MySql 似的,我们需要将应用连接到它并使用某种“语言”进行交互,因此我们还需要一个连接工厂以及一个 Spring 和 Redis 对话要用的 RedisTemplate,这些都是 Redis 缓存所必需的配置,把它们都放在自定义的 CachingConfigurerSupport 中:

[java] view plain copy

print?

  1. /**
  2.  * File Name:RedisCacheConfig.java
  3.  *
  4.  * Copyright Defonds Corporation 2015 
  5.  * All Rights Reserved
  6.  *
  7.  */
  8. package com.defonds.bdp.cache.redis;  
  9. import org.springframework.cache.CacheManager;  
  10. import org.springframework.cache.annotation.CachingConfigurerSupport;  
  11. import org.springframework.cache.annotation.EnableCaching;  
  12. import org.springframework.context.annotation.Bean;  
  13. import org.springframework.context.annotation.Configuration;  
  14. import org.springframework.data.redis.cache.RedisCacheManager;  
  15. import org.springframework.data.redis.connection.RedisConnectionFactory;  
  16. import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;  
  17. import org.springframework.data.redis.core.RedisTemplate;  
  18. /**
  19.  * 
  20.  * Project Name:bdp 
  21.  * Type Name:RedisCacheConfig 
  22.  * Type Description:
  23.  *  Author:Defonds
  24.  * Create Date:2015-09-21
  25.  * 
  26.  * @version
  27.  * 
  28.  */
  29. @Configuration
  30. @EnableCaching
  31. public class RedisCacheConfig extends CachingConfigurerSupport {  
  32. @Bean
  33. public JedisConnectionFactory redisConnectionFactory() {  
  34.         JedisConnectionFactory redisConnectionFactory = new JedisConnectionFactory();  
  35. // Defaults
  36.         redisConnectionFactory.setHostName("192.168.1.166");  
  37.         redisConnectionFactory.setPort(6379);  
  38. return redisConnectionFactory;  
  39.     }  
  40. @Bean
  41. public RedisTemplate<String, String> redisTemplate(RedisConnectionFactory cf) {  
  42.         RedisTemplate<String, String> redisTemplate = new RedisTemplate<String, String>();  
  43.         redisTemplate.setConnectionFactory(cf);  
  44. return redisTemplate;  
  45.     }  
  46. @Bean
  47. public CacheManager cacheManager(RedisTemplate redisTemplate) {  
  48.         RedisCacheManager cacheManager = new RedisCacheManager(redisTemplate);  
  49. // Number of seconds before expiration. Defaults to unlimited (0)
  50.         cacheManager.setDefaultExpiration(3000); // Sets the default expire time (in seconds)
  51. return cacheManager;  
  52.     }  
  53. }  

当然也别忘了把这些 bean 注入 Spring,不然配置无效。在 applicationContext.xml 中加入以下:

[html] view plain copy

print?

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

3. 缓存某些方法的执行结果

设置好缓存配置之后我们就可以使用 @Cacheable 注解来缓存方法执行的结果了,比如根据省份名检索城市的 provinceCities 方法和根据 city_code 检索城市的 searchCity 方法:

[java] view plain copy

print?

  1. // R
  2. @Cacheable("provinceCities")  
  3. public List<City> provinceCities(String province) {  
  4.     logger.debug("province=" + province);  
  5. return this.cityMapper.provinceCities(province);  
  6. }  
  7. // R
  8. @Cacheable("searchCity")  
  9. public City searchCity(String city_code){  
  10.     logger.debug("city_code=" + city_code);  
  11. return this.cityMapper.searchCity(city_code);     
  12. }  

4. 缓存数据一致性保证

CRUD (Create 创建,Retrieve 读取,Update 更新,Delete 删除) 操作中,除了 R 具备幂等性,其他三个发生的时候都可能会造成缓存结果和数据库不一致。为了保证缓存数据的一致性,在进行 CUD 操作的时候我们需要对可能影响到的缓存进行更新或者清除。

[java] view plain copy

print?

  1. // C
  2. @CacheEvict(value = { "provinceCities"}, allEntries = true)  
  3. public void insertCity(String city_code, String city_jb,   
  4.         String province_code, String city_name,  
  5.         String city, String province) {  
  6.     City cityBean = new City();  
  7.     cityBean.setCityCode(city_code);  
  8.     cityBean.setCityJb(city_jb);  
  9.     cityBean.setProvinceCode(province_code);  
  10.     cityBean.setCityName(city_name);  
  11.     cityBean.setCity(city);  
  12.     cityBean.setProvince(province);  
  13. this.cityMapper.insertCity(cityBean);  
  14. }  
  15. // U
  16. @CacheEvict(value = { "provinceCities", "searchCity" }, allEntries = true)  
  17. public int renameCity(String city_code, String city_name) {  
  18.     City city = new City();  
  19.     city.setCityCode(city_code);  
  20.     city.setCityName(city_name);  
  21. this.cityMapper.renameCity(city);  
  22. return 1;  
  23. }  
  24. // D
  25. @CacheEvict(value = { "provinceCities", "searchCity" }, allEntries = true)  
  26. public int deleteCity(String city_code) {  
  27. this.cityMapper.deleteCity(city_code);  
  28. return 1;  
  29. }  

业务考虑,本示例用的都是 @CacheEvict 清除缓存。如果你的 CUD 能够返回 City 实例,也可以使用 @CachePut 更新缓存策略。笔者推荐能用 @CachePut 的地方就不要用 @CacheEvict,因为后者将所有相关方法的缓存都清理掉,比如上面三个方法中的任意一个被调用了的话,provinceCities 方法的所有缓存将被清除。

5. 自定义缓存数据 key 生成策略

对于使用 @Cacheable 注解的方法,每个缓存的 key 生成策略默认使用的是参数名+参数值,比如以下方法:

[java] view plain copy

print?

  1. @Cacheable("users")  
  2. public User findByUsername(String username)  

这个方法的缓存将保存于 key 为 users~keys 的缓存下,对于 username 取值为 "赵德芳" 的缓存,key 为 "username-赵德芳"。一般情况下没啥问题,二般情况如方法 key 取值相等然后参数名也一样的时候就出问题了,如:

[java] view plain copy

print?

  1. @Cacheable("users")  
  2. public Integer getLoginCountByUsername(String username)  

这个方法的缓存也将保存于 key 为 users~keys 的缓存下。对于 username 取值为 "赵德芳" 的缓存,key 也为 "username-赵德芳",将另外一个方法的缓存覆盖掉。 解决办法是使用自定义缓存策略,对于同一业务(同一业务逻辑处理的方法,哪怕是集群/分布式系统),生成的 key 始终一致,对于不同业务则不一致:

[java] view plain copy

print?

  1. @Bean
  2. public KeyGenerator customKeyGenerator() {  
  3. return new KeyGenerator() {  
  4. @Override
  5. public Object generate(Object o, Method method, Object... objects) {  
  6.             StringBuilder sb = new StringBuilder();  
  7.             sb.append(o.getClass().getName());  
  8.             sb.append(method.getName());  
  9. for (Object obj : objects) {  
  10.                 sb.append(obj.toString());  
  11.             }  
  12. return sb.toString();  
  13.         }  
  14.     };  
  15. }  

于是上述两个方法,对于 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. 注意事项

  1. 要缓存的 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]]。
  2. 缓存的生命周期我们可以配置,然后托管 Spring CacheManager,不要试图通过 redis-cli 命令行去管理缓存。比如 provinceCities 方法的缓存,某个省份的查询结果会被以 key-value 的形式存放在 Redis,key 就是我们刚才自定义生成的 key,value 是序列化后的对象,这个 key 会被放在 key 名为 provinceCities~keys key-value 存储中,参考下图"provinceCities 方法在 Redis 中的缓存情况"。可以通过 redis-cli 使用 del 命令将 provinceCities~keys 删除,但每个省份的缓存却不会被清除。
  3. CacheManager 必须设置缓存过期时间,否则缓存对象将永不过期,这样做的原因如上,避免一些野数据“永久保存”。此外,设置缓存过期时间也有助于资源利用最大化,因为缓存里保留的永远是热点数据。
  4. 缓存适用于读多写少的场合,查询时缓存命中率很低、写操作很频繁等场景不适宜用缓存。

后记

本文完整 Eclipse 下的开发项目示例已上传 CSDN 资源,有兴趣的朋友可以去下载下来参考:http://download.csdn.net/detail/defonds/9137505

参考资料

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 大型网站架构演变过程、大并发服务器架构

    客户端(浏览器)缓存 前端页面缓存(squid) 页面片段缓存ESI(Edge Side Includes) 本地数据缓存

    bear_fish
  • 大数据并发问题

    http://blog.csdn.net/u014421556/article/details/50964505

    bear_fish
  • java处理高并发高负载类网站的优化方法

        一般来说MySQL是最常用的,可能最初是一个mysql主机,当数据增加到100万以上,那么,MySQL的效能急剧下降。常用的优化措施是M-S(主-从)...

    bear_fish
  • 反向代理的攻击面 (下)

    让我们接着上节的内容,继续探讨。建议读者先阅读第一部分,这将有助于理解本节的内容。

    随心助手
  • Java缓存深入理解

    对于缓存大家都不会陌生,但如何正确和合理的使用缓存还是需要一定的思考,本文将基于Java技术栈对缓存做一个相对详细的介绍,内容分为基本概念、本地缓存、远程缓存和...

    用户1216676
  • [日常] HTTP的缓存

    陶士涵
  • WEB缓存探究

    由于项目越来越大,即使了使用代码压缩工具减少文件大小,js文件还是不可避免的越变越大。而对于用户来说每次重新下载都有可能会消耗大量时间,让我们的首屏展示有较长时...

    疯狂的技术宅
  • 聊聊MyBatis缓存机制

    前言 MyBatis是常见的Java数据库访问层框架。在日常工作中,开发人员多数情况下是使用MyBatis的默认缓存配置,但是MyBatis缓存机制有一些不足之...

    美团技术团队
  • http缓存与离线缓存

    一、http协议实现缓存 1. 缓存头部 通用缓存、条件缓存、缓存控制三大类 头部名称 说明 请求/响应 通用缓存头部 控制客户端是否向服务器发送请求...

    sam dragon
  • 优化页面访问速度(三) ——服务端优化

    服务端的优化,主要可以通过消息队列、减少数据库请求(缓存)、并发处理、页面静态化等方式处理。

    用户1327360

扫码关注云+社区

领取腾讯云代金券