1. 依赖包安装pom.xml 加入：

<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>

xxxxxxxxxx

10

 

1

2

   
              
               org.springframework.data
                

3

   
              
               spring-data-redis
                

4

   
              
               1.6.0.RELEASE
                

5

6

7

   
              
               redis.clients
                

8

   
              
               jedis
                

9

   
              
               2.7.3
                

10

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

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; @Configuration @EnableCaching public class RedisCacheConfig extends CachingConfigurerSupport { @Bean public JedisConnectionFactory redisConnectionFactory() { JedisConnectionFactory redisConnectionFactory = new JedisConnectionFactory(); 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); cacheManager.setDefaultExpiration(3000); return cacheManager; } }

xxxxxxxxxx

41

 

1

package com.defonds.bdp.cache.redis;  

2

3

import org.springframework.cache.CacheManager;  

4

import org.springframework.cache.annotation.CachingConfigurerSupport;  

5

import org.springframework.cache.annotation.EnableCaching;  

6

import org.springframework.context.annotation.Bean;  

7

import org.springframework.context.annotation.Configuration;  

8

import org.springframework.data.redis.cache.RedisCacheManager;  

9

import org.springframework.data.redis.connection.RedisConnectionFactory;  

10

import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;  

11

import org.springframework.data.redis.core.RedisTemplate;  

12

13

14

@Configuration  

15

@EnableCaching  

16

public class RedisCacheConfig extends CachingConfigurerSupport {  

17

18

   @Bean  

19

   public JedisConnectionFactory redisConnectionFactory() {  

20

       JedisConnectionFactory redisConnectionFactory = new JedisConnectionFactory();  

21

22

       redisConnectionFactory.setHostName("192.168.1.166");  

23

       redisConnectionFactory.setPort(6379);  

24

       return redisConnectionFactory;  

25

   }  

26

27

   @Bean  

28

   public RedisTemplate
              
                redisTemplate(RedisConnectionFactory cf) {  
              

29

       RedisTemplate
              
                redisTemplate = new RedisTemplate
               
                ();  
               
              

30

       redisTemplate.setConnectionFactory(cf);  

31

       return redisTemplate;  

32

   }  

33

34

   @Bean  

35

   public CacheManager cacheManager(RedisTemplate redisTemplate) {  

36

       RedisCacheManager cacheManager = new RedisCacheManager(redisTemplate);  

37

       cacheManager.setDefaultExpiration(3000);

38

       return cacheManager;  

39

   }  

40

41

}  

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

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

xxxxxxxxxx

1

 

1

3. 缓存某些方法的执行结果并缓存数据一致性保证设置好缓存配置之后我们就可以使用 @Cacheable 注解来缓存方法执行的结果了，比如根据省份名检索城市的 provinceCities 方法和根据 city_code 检索城市的 searchCity 方法：

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

// 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); } @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; }

xxxxxxxxxx

43

 

1

// R  

2

@Cacheable("provinceCities")  

3

public List
              
                provinceCities(String province) {  
              

4

   logger.debug("province=" + province);  

5

   return this.cityMapper.provinceCities(province);  

6

}  

7

8

// R  

9

@Cacheable("searchCity")  

10

public City searchCity(String city_code){  

11

   logger.debug("city_code=" + city_code);  

12

   return this.cityMapper.searchCity(city_code);    

13

}  

14

15

@CacheEvict(value = { "provinceCities"}, allEntries = true)  

16

public void insertCity(String city_code, String city_jb,  

17

       String province_code, String city_name,  

18

       String city, String province) {  

19

   City cityBean = new City();  

20

   cityBean.setCityCode(city_code);  

21

   cityBean.setCityJb(city_jb);  

22

   cityBean.setProvinceCode(province_code);  

23

   cityBean.setCityName(city_name);  

24

   cityBean.setCity(city);  

25

   cityBean.setProvince(province);  

26

   this.cityMapper.insertCity(cityBean);  

27

}  

28

// U  

29

@CacheEvict(value = { "provinceCities", "searchCity" }, allEntries = true)  

30

public int renameCity(String city_code, String city_name) {  

31

   City city = new City();  

32

   city.setCityCode(city_code);  

33

   city.setCityName(city_name);  

34

   this.cityMapper.renameCity(city);  

35

   return 1;  

36

}  

37

38

// D  

39

@CacheEvict(value = { "provinceCities", "searchCity" }, allEntries = true)  

40

public int deleteCity(String city_code) {  

41

   this.cityMapper.deleteCity(city_code);  

42

   return 1;  

43

}  

业务考虑，本示例用的都是 @CacheEvict 清除缓存。如果你的 CUD 能够返回 City 实例，也可以使用 @CachePut 更新缓存策略。

笔者推荐能用 @CachePut 的地方就不要用 @CacheEvict，因为后者将所有相关方法的缓存都清理掉，比如上面三个方法中的任意一个被调用了的话，provinceCities 方法的所有缓存将被清除。

5. 自定义缓存数据 key 生成策略对于使用 @Cacheable 注解的方法，每个缓存的 key 生成策略默认使用的是参数名+参数值，比如以下方法：

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

xxxxxxxxxx

2

 

1

@Cacheable("users")  

2

public User findByUsername(String username)  

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

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

xxxxxxxxxx

2

 

1

@Cacheable("users")  

2

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(); } }; }

xxxxxxxxxx

16

 

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

}  

16

这对于集群系统、分布式系统之间共享缓存很重要，真正实现了分布式缓存。

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