Redis 缓存 + Spring 的集成示例

xiemanR

2016-10-13

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

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

1.依赖包安装

pom.xml加入：

[html]viewplaincopyprint?

<groupId>org.springframework.data</groupId>

<artifactId>spring-data-redis</artifactId>

<version>1.6.0.RELEASE</version>

</dependency>

<groupId>redis.clients</groupId>

<artifactId>jedis</artifactId>

</dependency>

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

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

[java]viewplaincopyprint?

/**

*FileName：RedisCacheConfig.java

*CopyrightDefondsCorporation2015

*AllRightsReserved

packagecom.defonds.bdp.cache.redis;

importorg.springframework.cache.CacheManager;

importorg.springframework.cache.annotation.CachingConfigurerSupport;

importorg.springframework.cache.annotation.EnableCaching;

importorg.springframework.context.annotation.Bean;

importorg.springframework.context.annotation.Configuration;

importorg.springframework.data.redis.cache.RedisCacheManager;

importorg.springframework.data.redis.connection.RedisConnectionFactory;

importorg.springframework.data.redis.connection.jedis.JedisConnectionFactory;

importorg.springframework.data.redis.core.RedisTemplate;

/**

*ProjectName：bdp

*TypeName：RedisCacheConfig

*TypeDescription：

*Author：Defonds

*CreateDate：2015-09-21

*@version

@Configuration

@EnableCaching

publicclassRedisCacheConfigextendsCachingConfigurerSupport{

@Bean

publicJedisConnectionFactoryredisConnectionFactory(){

JedisConnectionFactoryredisConnectionFactory=newJedisConnectionFactory();

//Defaults

redisConnectionFactory.setHostName("192.168.1.166");

redisConnectionFactory.setPort(6379);

returnredisConnectionFactory;

}

@Bean

publicRedisTemplate<String,String>redisTemplate(RedisConnectionFactorycf){

RedisTemplate<String,String>redisTemplate=newRedisTemplate<String,String>();

redisTemplate.setConnectionFactory(cf);

returnredisTemplate;

}

@Bean

publicCacheManagercacheManager(RedisTemplateredisTemplate){

RedisCacheManagercacheManager=newRedisCacheManager(redisTemplate);

//Numberofsecondsbeforeexpiration.Defaultstounlimited(0)

cacheManager.setDefaultExpiration(3000);//Setsthedefaultexpiretime(inseconds)

returncacheManager;

}

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

[html]viewplaincopyprint?

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

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

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

[java]viewplaincopyprint?

//R

@Cacheable("provinceCities")

publicList<City>provinceCities(Stringprovince){

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

returnthis.cityMapper.provinceCities(province);

}

//R

@Cacheable("searchCity")

publicCitysearchCity(Stringcity_code){

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

returnthis.cityMapper.searchCity(city_code);

}

4.缓存数据一致性保证

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

[java]viewplaincopyprint?

//C

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

publicvoidinsertCity(Stringcity_code,Stringcity_jb,

Stringprovince_code,Stringcity_name,

Stringcity,Stringprovince){

CitycityBean=newCity();

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)

publicintrenameCity(Stringcity_code,Stringcity_name){

Citycity=newCity();

city.setCityCode(city_code);

city.setCityName(city_name);

this.cityMapper.renameCity(city);

return1;

}

//D

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

publicintdeleteCity(Stringcity_code){

this.cityMapper.deleteCity(city_code);

return1;

}

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

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

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

[java]viewplaincopyprint?

@Cacheable("users")

publicUserfindByUsername(Stringusername)

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

[java]viewplaincopyprint?

@Cacheable("users")

publicIntegergetLoginCountByUsername(Stringusername)

这个方法的缓存也将保存于key为users~keys的缓存下。对于username取值为"赵德芳"的缓存，key也为"username-赵德芳"，将另外一个方法的缓存覆盖掉。

解决办法是使用自定义缓存策略，对于同一业务(同一业务逻辑处理的方法，哪怕是集群/分布式系统)，生成的key始终一致，对于不同业务则不一致：

[java]viewplaincopyprint?

@Bean

publicKeyGeneratorcustomKeyGenerator(){

returnnewKeyGenerator(){

@Override

publicObjectgenerate(Objecto,Methodmethod,Object...objects){

StringBuildersb=newStringBuilder();

sb.append(o.getClass().getName());

sb.append(method.getName());

for(Objectobj:objects){

sb.append(obj.toString());

}

returnsb.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接口：

使用JMeter调用/bdp/city/province/cities.json接口.png

Eclipse控制台输出如下：

Eclipse控制台输出如下.png

说明这一次请求没有命中缓存，走的是db查询。JMeter再次请求，Eclipse控制台输出：

Eclipse控制台输出

标红部分以下是这一次请求的log，没有访问db的log，缓存命中。查看本次请求的Redis存储情况：

查看本次请求的Redis存储情况.png

同样可以验证city_code为1492的searchCity方法的缓存是否有效：

同样可以验证city_code为1492的searchCity方法的缓存是否有效.png

图中标红部分是searchCity的缓存存储情况。

6.2缓存一致性的验证

先来验证insertCity方法的缓存配置，JMeter调用/bdp/city/create.json接口：

JMeter调用/bdp/city/create.json接口.png

之后看Redis存储：

之后看Redis存储

可以看出provinceCities方法的缓存已被清理掉，insertCity方法的缓存奏效。

然后验证renameCity方法的缓存配置，JMeter调用/bdp/city/rename.json接口：

JMeter调用/bdp/city/rename.json接口.png

之后再看Redis存储：

之后再看Redis存储.png

searchCity方法的缓存也已被清理，renameCity方法的缓存也奏效。

7.注意事项

要缓存的Java对象必须实现Serializable接口，因为Spring会将对象先序列化再存入Redis，比如本文中的com.defonds.bdp.city.bean.City类，如果不实现Serializable的话将会遇到类似这种错误：nestedexceptionisjava.lang.IllegalArgumentException:DefaultSerializerrequiresaSerializablepayloadbutreceivedanobjectoftype[com.defonds.bdp.city.bean.City]]。

缓存的生命周期我们可以配置，然后托管SpringCacheManager，不要试图通过redis-cli命令行去管理缓存。比如provinceCities方法的缓存，某个省份的查询结果会被以key-value的形式存放在Redis，key就是我们刚才自定义生成的key，value是序列化后的对象，这个key会被放在key名为provinceCities~keyskey-value存储中，参考下图"provinceCities方法在Redis中的缓存情况"。可以通过redis-cli使用del命令将provinceCities~keys删除，但每个省份的缓存却不会被清除。

CacheManager必须设置缓存过期时间，否则缓存对象将永不过期，这样做的原因如上，避免一些野数据“永久保存”。此外，设置缓存过期时间也有助于资源利用最大化，因为缓存里保留的永远是热点数据。

缓存适用于读多写少的场合，查询时缓存命中率很低、写操作很频繁等场景不适宜用缓存。

provinceCities方法在Redis中的存储.png

后记

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

参考资料

CachingDatawithSpring

35.CacheAbstractionPartVII.Integration

CachingDatainSpringUsingRedis

CachingwithSpringDataRedis

spring-redis-caching-example