Redis 缓存 + Spring 的集成示例

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. 缓存适用于读多写少的场合，查询时缓存命中率很低、写操作很频繁等场景不适宜用缓存。

时间： 2024-10-14 13:40:10

Redis 缓存 + Spring 的集成示例的相关文章

Redis 缓存 + Spring 的集成示例(转)

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

Redis 缓存 + Spring 的集成示例(转载)

1. 依赖包安装 pom.xml 加入: <dependency> <groupId>org.springframework.data</groupId> <artifactId>spring-data-redis</artifactId> <version>1.6.0.RELEASE</version> </dependency> <dependency> <groupId>redis

redis和spring的集成

Jedis是Redis的Java版本的客户端实现. 一.我们需要导入jar包(下面是最新版本,可根据情况自行选择版本) [html] view plain copy <!-- https://mvnrepository.com/artifact/redis.clients/jedis --> <dependency> <groupId>redis.clients</groupId> <artifactId>jedis</artifactId

【spring boot】【redis】spring boot 集成redis的发布订阅机制

一.简单介绍 1.redis的发布订阅功能,很简单. 消息发布者和消息订阅者互相不认得,也不关心对方有谁. 消息发布者,将消息发送给频道(channel). 然后是由 频道(channel)将消息发送给对自己感兴趣的 消息订阅者们,进行消费. 2.redis的发布订阅和专业的MQ相比较 1>redis的发布订阅只是最基本的功能,不支持持久化,消息发布者将消息发送给频道.如果没有订阅者消费,消息就丢失了. 2>在消息发布过程中,如果客户端和服务器连接超时,MQ会有重试机制,事务回滚等.但是Red

spring boot redis 缓存（cache）集成

Spring Boot 集成教程 Spring Boot 介绍 Spring Boot 开发环境搭建(Eclipse) Spring Boot Hello World (restful接口)例子 spring boot 连接Mysql spring boot配置druid连接池连接mysql spring boot集成mybatis(1) spring boot集成mybatis(2) – 使用pagehelper实现分页 spring boot集成mybatis(3) – mybatis ge

spring boot集成redis缓存

spring boot项目中使用redis作为缓存. 先创建spring boot的maven工程,在pom.xml中添加依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <version>1.5.3.RELEASE</version> </depen

Spring Boot集成Hazelcast实现集群与分布式内存缓存

Hazelcast是Hazelcast公司开源的一款分布式内存数据库产品,提供弹性可扩展.高性能的分布式内存计算.并通过提供诸如Map,Queue,ExecutorService,Lock和JCache等Java的许多开发人员友好的分布式实现. 了解Hazelcast Hazelcast特性 简单易用 Hazelcast是用Java编写的,没有其他依赖关系.只需简单的把jar包引入项目的classpath即可创建集群. 无主从模式 与许多NoSQL解决方案不同,Hazelcast节点是点对点的.

Spring Boot 2.X(六)：Spring Boot 集成 Redis

Redis 简介 什么是 Redis Redis 是目前使用的非常广泛的免费开源内存数据库,是一个高性能的 key-value 数据库. Redis 与其他 key-value 缓存(如 Memcached )相比有以下三个特点: 1.Redis 支持数据的持久化,它可以将内存中的数据保存在磁盘中,重启的时候可以再次加载进行使用. 2.Redis 不仅仅支持简单的 key-value 类型的数据,同时还提供 list,set,zset,hash 等数据结构的存储. 3.Redis 支持数据的备份

Spring Cache集成redis

Redis是一个key-value存储系统.和Memcached类似,它支持存储的value类型相对更多,包括string(字符串).list(链表).set(集合).zset(sorted set –有序集合)和hash(哈希类型).这些数据类型都支持push/pop.add/remove及取交集并集和差集及更丰富的操作,而且这些操作都是原子性的.在此基础上,redis支持各种不同方式的排序.与memcached一样,为了保证效率,数据都是缓存在内存中.区别的是redis会周期性的把更新的数据