1.添加spring-boot-starter-data-redis依赖
<!-- Spring Boot Redis依赖 --> <!-- 注意:1.5版本的依赖和2.0的依赖不一样,注意看哦 1.5我记得名字里面应该没有“data”, 2.0必须是“spring-boot-starter-data-redis” 这个才行--> <!-- 1.5的版本默认采用的连接池技术是jedis 2.0以上版本默认连接池是lettuce--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> <!--spring2.0集成redis所需common-pool2--> <!-- 必须加上,jedis依赖此 jar--> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-pool2</artifactId> <version>2.5.0</version> </dependency> <!-- 将作为Redis对象序列化器 --> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.47</version> </dependency>
2.配置redis在application.yml中配置如下
spring: redis: host: 127.0.0.1 password: port: 6379 # 连接超时时间(毫秒) timeout: 1000 jedis: pool: # 连接池最大连接数(使用负值表示没有限制) max-active: 8 # 连接池中的最大空闲连接 max-idle: 8 # 连接池中的最小空闲连接 min-idle: 0 # 连接池最大阻塞等待时间(使用负值表示没有限制) max-wait: -1
3.书写配置类
package com.alen.springboot.demo.config; import com.fasterxml.jackson.annotation.JsonAutoDetect; import com.fasterxml.jackson.annotation.PropertyAccessor; import com.fasterxml.jackson.databind.DeserializationFeature; import com.fasterxml.jackson.databind.ObjectMapper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.cache.Cache; import org.springframework.cache.CacheManager; import org.springframework.cache.annotation.CachingConfigurerSupport; import org.springframework.cache.annotation.EnableCaching; import org.springframework.cache.interceptor.CacheErrorHandler; import org.springframework.cache.interceptor.KeyGenerator; 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.RedisConfiguration; import org.springframework.data.redis.connection.RedisConnectionFactory; import org.springframework.data.redis.core.RedisTemplate; import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer; import org.springframework.data.redis.serializer.RedisSerializer; import org.springframework.data.redis.serializer.StringRedisSerializer; /** * @author alen * @create 2018-11-27 18:06 **/ @Configuration @EnableCaching public class RedisConfig extends CachingConfigurerSupport { /** * Logger */ private static final Logger log = LoggerFactory.getLogger(RedisConfiguration.class); @Bean @Override public KeyGenerator keyGenerator() { // 设置自动key的生成规则,配置spring boot的注解,进行方法级别的缓存 // 使用:进行分割,可以很多显示出层级关系 // 这里其实就是new了一个KeyGenerator对象, // 只是这是lambda表达式的写法,我感觉很好用,大家感兴趣可以去了解下 // return (target, method, params) -> { StringBuilder sb = new StringBuilder(); sb.append(target.getClass().getName()); sb.append(":"); sb.append(method.getName()); for (Object obj : params) { sb.append(":" + String.valueOf(obj)); } String rsToUse = String.valueOf(sb); log.info("自动生成Redis Key -> [{}]", rsToUse); return rsToUse; }; } /** * 管理缓存 */ @Bean public CacheManager cacheManager(RedisConnectionFactory connectionFactory) { RedisCacheManager redisCacheManager = RedisCacheManager.builder(connectionFactory).build(); return redisCacheManager; } //防止redis入库序列化乱码的问题 @Bean public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) { //设置序列化 Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class); ObjectMapper om = new ObjectMapper(); //解决使用jackson发生UnrecognizedPropertyException异常 om.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL); jackson2JsonRedisSerializer.setObjectMapper(om); // 配置redisTemplate RedisTemplate<Object, Object> redisTemplate = new RedisTemplate<Object, Object>(); redisTemplate.setConnectionFactory(redisConnectionFactory); RedisSerializer stringSerializer = new StringRedisSerializer(); redisTemplate.setKeySerializer(stringSerializer); // key序列化 redisTemplate.setValueSerializer(jackson2JsonRedisSerializer); // value序列化 redisTemplate.setHashKeySerializer(stringSerializer); // Hash key序列化 redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer); // Hash value序列化 redisTemplate.afterPropertiesSet(); return redisTemplate; } @Override @Bean public CacheErrorHandler errorHandler() { // 异常处理,当Redis发生异常时,打印日志,但是程序正常走 log.info("初始化 -> [{}]", "Redis CacheErrorHandler"); CacheErrorHandler cacheErrorHandler = new CacheErrorHandler() { @Override public void handleCacheGetError(RuntimeException e, Cache cache, Object key) { log.error("Redis occur handleCacheGetError:key -> [{}]", key, e); } @Override public void handleCachePutError(RuntimeException e, Cache cache, Object key, Object value) { log.error("Redis occur handleCachePutError:key -> [{}];value -> [{}]", key, value, e); } @Override public void handleCacheEvictError(RuntimeException e, Cache cache, Object key) { log.error("Redis occur handleCacheEvictError:key -> [{}]", key, e); } @Override public void handleCacheClearError(RuntimeException e, Cache cache) { log.error("Redis occur handleCacheClearError:", e); } }; return cacheErrorHandler; } }
缓存操作出现异常默认会抛异常,影响主流程,默认的异常处理类是SimpleCacheErrorHandler,
处理redis异常,我们需要自定义CacheErrorHandler来替代默认的SimpleCacheErrorHandler。
打开之前的Redis配置类,继承CachingConfigurerSupport,这个CachingConfigurerSupport就是供我们来自定义一些Cache相关配置的。
重写Override errorHandler方法:写上自己的处理逻辑,在AbstractCacheInvoker中调用自定义的异常处理
public abstract class AbstractCacheInvoker { private CacheErrorHandler errorHandler; protected Cache.ValueWrapper doGet(Cache cache, Object key) { try { return cache.get(key); } catch (RuntimeException ex) { getErrorHandler().handleCacheGetError(ex, cache, key); return null; // If the exception is handled, return a cache miss } }
Spring Data Redis支持JDK序列化、Json序列化、XML序列化
- JDK序列化:默认采用JDK序列化方式的类JdkSerializationRedisSerializer,速度快但占用空间较大,对象必须实现java.io.Serializable接口
- Json序列化:空间占用小,包括GenericJackson2JsonRedisSerializer和Jackson2JsonRedisSerializer 两种,其中GenericJackson2JsonRedisSerializer无需为各种类型单独定义Bean
- XML序列化:OxmSerializer ,速度慢空间占用较大
不用上面的配置直接使用默认的操作类也是可以的(参考:https://www.cnblogs.com/floay/p/6485742.html)4.编写RedisService
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.redis.core.RedisTemplate; import org.springframework.data.redis.core.StringRedisTemplate; import org.springframework.data.redis.core.ValueOperations; import org.springframework.stereotype.Service; import javax.annotation.Resource; @Service public class RedisService { @Autowired StringRedisTemplate stringRedisTemplate; @Resource(name = "stringRedisTemplate") ValueOperations<String, String> valOpsStr; @Autowired RedisTemplate<Object, Object> redisTemplate; @Resource(name = "redisTemplate") ValueOperations<Object, Object> valOpsObj; /** * 根据指定key获取String * @param key * @return */ public String getStr(String key){ return valOpsStr.get(key); } /** * 设置Str缓存 * @param key * @param val */ public void setStr(String key, String val){ valOpsStr.set(key,val); } /** * 删除指定key * @param key */ public void del(String key){ stringRedisTemplate.delete(key); } /** * 根据指定o获取Object * @param o * @return */ public Object getObj(Object o){ return valOpsObj.get(o); } /** * 设置obj缓存 * @param o1 * @param o2 */ public void setObj(Object o1, Object o2){ valOpsObj.set(o1, o2); } /** * 删除Obj缓存 * @param o */ public void delObj(Object o){ redisTemplate.delete(o); } }
5.可以把它编写成一个工具类
package com.alen.springboot.demo.util; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.ComponentScan; import org.springframework.data.redis.core.RedisTemplate; import org.springframework.data.redis.core.ZSetOperations.TypedTuple; import org.springframework.stereotype.Service; import java.util.Collection; import java.util.List; import java.util.Map; import java.util.Set; import java.util.concurrent.TimeUnit; /** * @author alen * @create 2018-11-27 18:09 **/ @Service public class RedisUtil { @Autowired private RedisTemplate<Object, Object> redisTemplate; public RedisTemplate<Object, Object> getInstance() { return redisTemplate; } /** * 设置 String 类型 key-value * * @param key * @param value */ public void set(String key, String value) { redisTemplate.opsForValue().set(key, value); } /** * 获取 String 类型 key-value * * @param key * @return */ public String get(String key) { return (String) redisTemplate.opsForValue().get(key); } /** * 设置 String 类型 key-value 并添加过期时间 (毫秒单位) * * @param key * @param value * @param time 过期时间,毫秒单位 */ public void setForTimeMS(String key, String value, long time) { redisTemplate.opsForValue().set(key, value, time, TimeUnit.MILLISECONDS); } /** * 设置 String 类型 key-value 并添加过期时间 (分钟单位) * * @param key * @param value * @param time 过期时间,分钟单位 */ public void setForTimeMIN(String key, String value, long time) { redisTemplate.opsForValue().set(key, value, time, TimeUnit.MINUTES); } /** * 设置 String 类型 key-value 并添加过期时间 (分钟单位) * * @param key * @param value * @param time 过期时间,分钟单位 */ public void setForTimeCustom(String key, String value, long time, TimeUnit type) { redisTemplate.opsForValue().set(key, value, time, type); } /** * 如果 key 存在则覆盖,并返回旧值. * 如果不存在,返回null 并添加 * * @param key * @param value * @return */ public String getAndSet(String key, String value) { return (String) redisTemplate.opsForValue().getAndSet(key, value); } /** * 批量添加 key-value (重复的键会覆盖) * * @param keyAndValue */ public void batchSet(Map<String, String> keyAndValue) { redisTemplate.opsForValue().multiSet(keyAndValue); } /** * 批量添加 key-value 只有在键不存在时,才添加 * map 中只要有一个key存在,则全部不添加 * * @param keyAndValue */ public void batchSetIfAbsent(Map<String, String> keyAndValue) { redisTemplate.opsForValue().multiSetIfAbsent(keyAndValue); } /** * 对一个 key-value 的值进行加减操作, * 如果该 key 不存在 将创建一个key 并赋值该 number * 如果 key 存在,但 value 不是长整型 ,将报错 * * @param key * @param number */ public Long increment(String key, long number) { return redisTemplate.opsForValue().increment(key, number); } /** * 对一个 key-value 的值进行加减操作, * 如果该 key 不存在 将创建一个key 并赋值该 number * 如果 key 存在,但 value 不是 纯数字 ,将报错 * * @param key * @param number */ public Double increment(String key, double number) { return redisTemplate.opsForValue().increment(key, number); } /** * 给一个指定的 key 值附加过期时间 * * @param key * @param time * @param type * @return */ public boolean expire(String key, long time, TimeUnit type) { return redisTemplate.boundValueOps(key).expire(time, type); } /** * 移除指定key 的过期时间 * * @param key * @return */ public boolean persist(String key) { return redisTemplate.boundValueOps(key).persist(); } /** * 获取指定key 的过期时间 * * @param key * @return */ public Long getExpire(String key) { return redisTemplate.boundValueOps(key).getExpire(); } /** * 修改 key * * @param key * @return */ public void rename(String key, String newKey) { redisTemplate.boundValueOps(key).rename(newKey); } /** * 删除 key-value * * @param key * @return */ public boolean delete(String key) { return redisTemplate.delete(key); } //hash操作 /** * 添加 Hash 键值对 * * @param key * @param hashKey * @param value */ public void put(String key, String hashKey, String value) { redisTemplate.opsForHash().put(key, hashKey, value); } /** * 批量添加 hash 的 键值对 * 有则覆盖,没有则添加 * * @param key * @param map */ public void putAll(String key, Map<String, String> map) { redisTemplate.opsForHash().putAll(key, map); } /** * 添加 hash 键值对. 不存在的时候才添加 * * @param key * @param hashKey * @param value * @return */ public boolean putIfAbsent(String key, String hashKey, String value) { return redisTemplate.opsForHash().putIfAbsent(key, hashKey, value); } /** * 删除指定 hash 的 HashKey * * @param key * @param hashKeys * @return 删除成功的 数量 */ public Long delete(String key, String... hashKeys) { return redisTemplate.opsForHash().delete(key, hashKeys); } /** * 给指定 hash 的 hashkey 做增减操作 * * @param key * @param hashKey * @param number * @return */ public Long increment(String key, String hashKey, long number) { return redisTemplate.opsForHash().increment(key, hashKey, number); } /** * 给指定 hash 的 hashkey 做增减操作 * * @param key * @param hashKey * @param number * @return */ public Double increment(String key, String hashKey, Double number) { return redisTemplate.opsForHash().increment(key, hashKey, number); } /** * 获取指定 key 下的 hashkey * * @param key * @param hashKey * @return */ public Object getHashKey(String key, String hashKey) { return redisTemplate.opsForHash().get(key, hashKey); } /** * 获取 key 下的 所有 hashkey 和 value * * @param key * @return */ public Map<Object, Object> getHashEntries(String key) { return redisTemplate.opsForHash().entries(key); } /** * 验证指定 key 下 有没有指定的 hashkey * * @param key * @param hashKey * @return */ public boolean hashKey(String key, String hashKey) { return redisTemplate.opsForHash().hasKey(key, hashKey); } /** * 获取 key 下的 所有 hashkey 字段名 * * @param key * @return */ public Set<Object> hashKeys(String key) { return redisTemplate.opsForHash().keys(key); } /** * 获取指定 hash 下面的 键值对 数量 * * @param key * @return */ public Long hashSize(String key) { return redisTemplate.opsForHash().size(key); } //List 操作 /** * 指定 list 从左入栈 * * @param key * @return 当前队列的长度 */ public Long leftPush(String key, Object value) { return redisTemplate.opsForList().leftPush(key, value); } /** * 指定 list 从左出栈 * 如果列表没有元素,会堵塞到列表一直有元素或者超时为止 * * @param key * @return 出栈的值 */ public Object leftPop(String key) { return redisTemplate.opsForList().leftPop(key); } /** * 从左边依次入栈 * 导入顺序按照 Collection 顺序 * 如: a b c => c b a * * @param key * @param values * @return */ public Long leftPushAll(String key, Collection<Object> values) { return redisTemplate.opsForList().leftPushAll(key, values); } /** * 指定 list 从右入栈 * * @param key * @return 当前队列的长度 */ public Long rightPush(String key, Object value) { return redisTemplate.opsForList().rightPush(key, value); } /** * 指定 list 从右出栈 * 如果列表没有元素,会堵塞到列表一直有元素或者超时为止 * * @param key * @return 出栈的值 */ public Object rightPop(String key) { return redisTemplate.opsForList().rightPop(key); } /** * 从右边依次入栈 * 导入顺序按照 Collection 顺序 * 如: a b c => a b c * * @param key * @param values * @return */ public Long rightPushAll(String key, Collection<Object> values) { return redisTemplate.opsForList().rightPushAll(key, values); } /** * 根据下标获取值 * * @param key * @param index * @return */ public Object popIndex(String key, long index) { return redisTemplate.opsForList().index(key, index); } /** * 获取列表指定长度 * * @param key * @param index * @return */ public Long listSize(String key, long index) { return redisTemplate.opsForList().size(key); } /** * 获取列表 指定范围内的所有值 * * @param key * @param start * @param end * @return */ public List<Object> listRange(String key, long start, long end) { return redisTemplate.opsForList().range(key, start, end); } /** * 删除 key 中 值为 value 的 count 个数. * * @param key * @param count * @param value * @return 成功删除的个数 */ public Long listRemove(String key, long count, Object value) { return redisTemplate.opsForList().remove(key, count, value); } /** * 删除 列表 [start,end] 以外的所有元素 * * @param key * @param start * @param end */ public void listTrim(String key, long start, long end) { redisTemplate.opsForList().trim(key, start, end); } /** * 将 key 右出栈,并左入栈到 key2 * * @param key 右出栈的列表 * @param key2 左入栈的列表 * @return 操作的值 */ public Object rightPopAndLeftPush(String key, String key2) { return redisTemplate.opsForList().rightPopAndLeftPush(key, key2); } //set 操作 无序不重复集合 /** * 添加 set 元素 * * @param key * @param values * @return */ public Long add(String key, String... values) { return redisTemplate.opsForSet().add(key, values); } /** * 获取两个集合的差集 * * @param key * @param otherkey * @return */ public Set<Object> difference(String key, String otherkey) { return redisTemplate.opsForSet().difference(key, otherkey); } /** * 获取 key 和 集合 collections 中的 key 集合的差集 * * @param key * @param otherKeys * @return */ public Set<Object> difference(String key, Collection<Object> otherKeys) { return redisTemplate.opsForSet().difference(key, otherKeys); } /** * 将 key 与 otherkey 的差集 ,添加到新的 newKey 集合中 * * @param key * @param otherkey * @param newKey * @return 返回差集的数量 */ public Long differenceAndStore(String key, String otherkey, String newKey) { return redisTemplate.opsForSet().differenceAndStore(key, otherkey, newKey); } /** * 将 key 和 集合 collections 中的 key 集合的差集 添加到 newkey 集合中 * * @param key * @param otherKeys * @param newKey * @return 返回差集的数量 */ public Long differenceAndStore(String key, Collection<Object> otherKeys, String newKey) { return redisTemplate.opsForSet().differenceAndStore(newKey, otherKeys, newKey); } /** * 删除一个或多个集合中的指定值 * * @param key * @param values * @return 成功删除数量 */ public Long remove(String key, Object... values) { return redisTemplate.opsForSet().remove(key, values); } /** * 随机移除一个元素,并返回出来 * * @param key * @return */ public Object randomSetPop(String key) { return redisTemplate.opsForSet().pop(key); } /** * 随机获取一个元素 * * @param key * @return */ public Object randomSet(String key) { return redisTemplate.opsForSet().randomMember(key); } /** * 随机获取指定数量的元素,同一个元素可能会选中两次 * * @param key * @param count * @return */ public List<Object> randomSet(String key, long count) { return redisTemplate.opsForSet().randomMembers(key, count); } /** * 随机获取指定数量的元素,去重(同一个元素只能选择两一次) * * @param key * @param count * @return */ public Set<Object> randomSetDistinct(String key, long count) { return redisTemplate.opsForSet().distinctRandomMembers(key, count); } /** * 将 key 中的 value 转入到 destKey 中 * * @param key * @param value * @param destKey * @return 返回成功与否 */ public boolean moveSet(String key, Object value, String destKey) { return redisTemplate.opsForSet().move(key, value, destKey); } /** * 无序集合的大小 * * @param key * @return */ public Long setSize(String key) { return redisTemplate.opsForSet().size(key); } /** * 判断 set 集合中 是否有 value * * @param key * @param value * @return */ public boolean isMember(String key, Object value) { return redisTemplate.opsForSet().isMember(key, value); } /** * 返回 key 和 othere 的并集 * * @param key * @param otherKey * @return */ public Set<Object> unionSet(String key, String otherKey) { return redisTemplate.opsForSet().union(key, otherKey); } /** * 返回 key 和 otherKeys 的并集 * * @param key * @param otherKeys key 的集合 * @return */ public Set<Object> unionSet(String key, Collection<Object> otherKeys) { return redisTemplate.opsForSet().union(key, otherKeys); } /** * 将 key 与 otherKey 的并集,保存到 destKey 中 * * @param key * @param otherKey * @param destKey * @return destKey 数量 */ public Long unionAndStoreSet(String key, String otherKey, String destKey) { return redisTemplate.opsForSet().unionAndStore(key, otherKey, destKey); } /** * 将 key 与 otherKey 的并集,保存到 destKey 中 * * @param key * @param otherKeys * @param destKey * @return destKey 数量 */ public Long unionAndStoreSet(String key, Collection<Object> otherKeys, String destKey) { return redisTemplate.opsForSet().unionAndStore(key, otherKeys, destKey); } /** * 返回集合中所有元素 * * @param key * @return */ public Set<Object> members(String key) { return redisTemplate.opsForSet().members(key); } //Zset 根据 socre 排序 不重复 每个元素附加一个 socre double类型的属性(double 可以重复) /** * 添加 ZSet 元素 * * @param key * @param value * @param score */ public boolean add(String key, Object value, double score) { return redisTemplate.opsForZSet().add(key, value, score); } /** * 批量添加 Zset <br> * Set<TypedTuple<Object>> tuples = new HashSet<>();<br> * TypedTuple<Object> objectTypedTuple1 = new DefaultTypedTuple<Object>("zset-5",9.6);<br> * tuples.add(objectTypedTuple1); * * @param key * @param tuples * @return */ public Long batchAddZset(String key, Set<TypedTuple<Object>> tuples) { return redisTemplate.opsForZSet().add(key, tuples); } /** * Zset 删除一个或多个元素 * * @param key * @param values * @return */ public Long removeZset(String key, String... values) { return redisTemplate.opsForZSet().remove(key, values); } /** * 对指定的 zset 的 value 值 , socre 属性做增减操作 * * @param key * @param value * @param score * @return */ public Double incrementScore(String key, Object value, double score) { return redisTemplate.opsForZSet().incrementScore(key, value, score); } /** * 获取 key 中指定 value 的排名(从0开始,从小到大排序) * * @param key * @param value * @return */ public Long rank(String key, Object value) { return redisTemplate.opsForZSet().rank(key, value); } /** * 获取 key 中指定 value 的排名(从0开始,从大到小排序) * * @param key * @param value * @return */ public Long reverseRank(String key, Object value) { return redisTemplate.opsForZSet().reverseRank(key, value); } /** * 获取索引区间内的排序结果集合(从0开始,从小到大,带上分数) * * @param key * @param start * @param end * @return */ public Set<TypedTuple<Object>> rangeWithScores(String key, long start, long end) { return redisTemplate.opsForZSet().rangeWithScores(key, start, end); } /** * 获取索引区间内的排序结果集合(从0开始,从小到大,只有列名) * * @param key * @param start * @param end * @return */ public Set<Object> range(String key, long start, long end) { return redisTemplate.opsForZSet().range(key, start, end); } /** * 获取分数范围内的 [min,max] 的排序结果集合 (从小到大,只有列名) * * @param key * @param min * @param max * @return */ public Set<Object> rangeByScore(String key, double min, double max) { return redisTemplate.opsForZSet().rangeByScore(key, min, max); } /** * 获取分数范围内的 [min,max] 的排序结果集合 (从小到大,集合带分数) * * @param key * @param min * @param max * @return */ public Set<TypedTuple<Object>> rangeByScoreWithScores(String key, double min, double max) { return redisTemplate.opsForZSet().rangeByScoreWithScores(key, min, max); } /** * 返回 分数范围内 指定 count 数量的元素集合, 并且从 offset 下标开始(从小到大,不带分数的集合) * * @param key * @param min * @param max * @param offset 从指定下标开始 * @param count 输出指定元素数量 * @return */ public Set<Object> rangeByScore(String key, double min, double max, long offset, long count) { return redisTemplate.opsForZSet().rangeByScore(key, min, max, offset, count); } /** * 返回 分数范围内 指定 count 数量的元素集合, 并且从 offset 下标开始(从小到大,带分数的集合) * * @param key * @param min * @param max * @param offset 从指定下标开始 * @param count 输出指定元素数量 * @return */ public Set<TypedTuple<Object>> rangeByScoreWithScores(String key, double min, double max, long offset, long count) { return redisTemplate.opsForZSet().rangeByScoreWithScores(key, min, max, offset, count); } /** * 获取索引区间内的排序结果集合(从0开始,从大到小,只有列名) * * @param key * @param start * @param end * @return */ public Set<Object> reverseRange(String key, long start, long end) { return redisTemplate.opsForZSet().reverseRange(key, start, end); } /** * 获取索引区间内的排序结果集合(从0开始,从大到小,带上分数) * * @param key * @param start * @param end * @return */ public Set<TypedTuple<Object>> reverseRangeWithScores(String key, long start, long end) { return redisTemplate.opsForZSet().reverseRangeWithScores(key, start, end); } /** * 获取分数范围内的 [min,max] 的排序结果集合 (从大到小,集合不带分数) * * @param key * @param min * @param max * @return */ public Set<Object> reverseRangeByScore(String key, double min, double max) { return redisTemplate.opsForZSet().reverseRangeByScore(key, min, max); } /** * 获取分数范围内的 [min,max] 的排序结果集合 (从大到小,集合带分数) * * @param key * @param min * @param max * @return */ public Set<TypedTuple<Object>> reverseRangeByScoreWithScores(String key, double min, double max) { return redisTemplate.opsForZSet().reverseRangeByScoreWithScores(key, min, max); } /** * 返回 分数范围内 指定 count 数量的元素集合, 并且从 offset 下标开始(从大到小,不带分数的集合) * * @param key * @param min * @param max * @param offset 从指定下标开始 * @param count 输出指定元素数量 * @return */ public Set<Object> reverseRangeByScore(String key, double min, double max, long offset, long count) { return redisTemplate.opsForZSet().reverseRangeByScore(key, min, max, offset, count); } /** * 返回 分数范围内 指定 count 数量的元素集合, 并且从 offset 下标开始(从大到小,带分数的集合) * * @param key * @param min * @param max * @param offset 从指定下标开始 * @param count 输出指定元素数量 * @return */ public Set<TypedTuple<Object>> reverseRangeByScoreWithScores(String key, double min, double max, long offset, long count) { return redisTemplate.opsForZSet().reverseRangeByScoreWithScores(key, min, max, offset, count); } /** * 返回指定分数区间 [min,max] 的元素个数 * * @param key * @param min * @param max * @return */ public long countZSet(String key, double min, double max) { return redisTemplate.opsForZSet().count(key, min, max); } /** * 返回 zset 集合数量 * * @param key * @return */ public long sizeZset(String key) { return redisTemplate.opsForZSet().size(key); } /** * 获取指定成员的 score 值 * * @param key * @param value * @return */ public Double score(String key, Object value) { return redisTemplate.opsForZSet().score(key, value); } /** * 删除指定索引位置的成员,其中成员分数按( 从小到大 ) * * @param key * @param start * @param end * @return */ public Long removeRange(String key, long start, long end) { return redisTemplate.opsForZSet().removeRange(key, start, end); } /** * 删除指定 分数范围 内的成员 [main,max],其中成员分数按( 从小到大 ) * * @param key * @param min * @param max * @return */ public Long removeRangeByScore(String key, double min, double max) { return redisTemplate.opsForZSet().removeRangeByScore(key, min, max); } /** * key 和 other 两个集合的并集,保存在 destKey 集合中, 列名相同的 score 相加 * * @param key * @param otherKey * @param destKey * @return */ public Long unionAndStoreZset(String key, String otherKey, String destKey) { return redisTemplate.opsForZSet().unionAndStore(key, otherKey, destKey); } /** * key 和 otherKeys 多个集合的并集,保存在 destKey 集合中, 列名相同的 score 相加 * * @param key * @param otherKeys * @param destKey * @return */ public Long unionAndStoreZset(String key, Collection<String> otherKeys, String destKey) { return redisTemplate.opsForZSet().unionAndStore(key, otherKeys, destKey); } /** * key 和 otherKey 两个集合的交集,保存在 destKey 集合中 * * @param key * @param otherKey * @param destKey * @return */ public Long intersectAndStore(String key, String otherKey, String destKey) { return redisTemplate.opsForZSet().intersectAndStore(key, otherKey, destKey); } /** * key 和 otherKeys 多个集合的交集,保存在 destKey 集合中 * * @param key * @param otherKeys * @param destKey * @return */ public Long intersectAndStore(String key, Collection<String> otherKeys, String destKey) { return redisTemplate.opsForZSet().intersectAndStore(key, otherKeys, destKey); } }
5.使用spring的缓存注解
@Cacheable、@CacheEvict、@CachePut自动缓存数据
@Cacheable(value="pagecase",key="''+#start+''+#pageSize", condition =" #start!=null && #pageSize!=null" ,unless="#result == null")
unless :不缓存结果等于null的值
Spring为我们提供了几个注解来支持Spring Cache。其核心主要是@Cacheable和@CacheEvict。使用@Cacheable标记的方法在执行后Spring Cache将缓存其返回结果,而使用@CacheEvict标记的方法会在方法执行前或者执行后移除Spring Cache中的某些元素。下面我们将来详细介绍一下Spring基于注解对Cache的支持所提供的几个注解。
@Cacheable
@Cacheable可以标记在一个方法上,也可以标记在一个类上。当标记在一个方法上时表示该方法是支持缓存的,当标记在一个类上时则表示该类所有的方法都是支持缓存的。对于一个支持缓存的方法,Spring会在其被调用后将其返回值缓存起来,以保证下次利用同样的参数来执行该方法时可以直接从缓存中获取结果,而不需要再次执行该方法。Spring在缓存方法的返回值时是以键值对进行缓存的,值就是方法的返回结果,至于键的话,Spring又支持两种策略,默认策略和自定义策略,这个稍后会进行说明。需要注意的是当一个支持缓存的方法在对象内部被调用时是不会触发缓存功能的。@Cacheable可以指定三个属性,value、key和condition。
value属性指定Cache名称
value属性是必须指定的,其表示当前方法的返回值是会被缓存在哪个Cache上的,对应Cache的名称。其可以是一个Cache也可以是多个Cache,当需要指定多个Cache时其是一个数组。
@Cacheable("cache1")//Cache是发生在cache1上的 public User find(Integer id) { returnnull; } @Cacheable({"cache1", "cache2"})//Cache是发生在cache1和cache2上的 public User find(Integer id) { returnnull; }
使用key属性自定义key
key属性是用来指定Spring缓存方法的返回结果时对应的key的。该属性支持SpringEL表达式。当我们没有指定该属性时,Spring将使用默认策略生成key。我们这里先来看看自定义策略,至于默认策略会在后文单独介绍。
自定义策略是指我们可以通过Spring的EL表达式来指定我们的key。这里的EL表达式可以使用方法参数及它们对应的属性。使用方法参数时我们可以直接使用“#参数名”或者“#p参数index”。下面是几个使用参数作为key的示例。
@Cacheable(value="users", key="#id") public User find(Integer id) { returnnull; } @Cacheable(value="users", key="#p0") public User find(Integer id) { returnnull; } @Cacheable(value="users", key="#user.id") public User find(User user) { returnnull; } @Cacheable(value="users", key="#p0.id") public User find(User user) { returnnull; }
除了上述使用方法参数作为key之外,Spring还为我们提供了一个root对象可以用来生成key。通过该root对象我们可以获取到以下信息。
属性名称
描述
示例
methodName
当前方法名
#root.methodName
method
当前方法
#root.method.name
target
当前被调用的对象
#root.target
targetClass
当前被调用的对象的class
#root.targetClass
args
当前方法参数组成的数组
#root.args[0]
caches
当前被调用的方法使用的Cache
#root.caches[0].name
当我们要使用root对象的属性作为key时我们也可以将“#root”省略,因为Spring默认使用的就是root对象的属性。如:
@Cacheable(value={"users", "xxx"}, key="caches[1].name") public User find(User user) { returnnull; }
condition属性指定发生的条件
有的时候我们可能并不希望缓存一个方法所有的返回结果。通过condition属性可以实现这一功能。condition属性默认为空,表示将缓存所有的调用情形。其值是通过SpringEL表达式来指定的,当为true时表示进行缓存处理;当为false时表示不进行缓存处理,即每次调用该方法时该方法都会执行一次。如下示例表示只有当user的id为偶数时才会进行缓存。
@Cacheable(value={"users"}, key="#user.id", condition="#user.id%2==0") public User find(User user) { System.out.println("find user by user " + user); return user; }
@CachePut
在支持Spring Cache的环境下,对于使用@Cacheable标注的方法,Spring在每次执行前都会检查Cache中是否存在相同key的缓存元素,如果存在就不再执行该方法,而是直接从缓存中获取结果进行返回,否则才会执行并将返回结果存入指定的缓存中。@CachePut也可以声明一个方法支持缓存功能。与@Cacheable不同的是使用@CachePut标注的方法在执行前不会去检查缓存中是否存在之前执行过的结果,而是每次都会执行该方法,并将执行结果以键值对的形式存入指定的缓存中。
@CachePut也可以标注在类上和方法上。使用@CachePut时我们可以指定的属性跟@Cacheable是一样的。
@CachePut("users")//每次都会执行方法,并将结果存入指定的缓存中 public User find(Integer id) { return null; }
@CacheEvict
@CacheEvict是用来标注在需要清除缓存元素的方法或类上的。当标记在一个类上时表示其中所有的方法的执行都会触发缓存的清除操作。@CacheEvict可以指定的属性有value、key、condition、allEntries和beforeInvocation。其中value、key和condition的语义与@Cacheable对应的属性类似。即value表示清除操作是发生在哪些Cache上的(对应Cache的名称);key表示需要清除的是哪个key,如未指定则会使用默认策略生成的key;condition表示清除操作发生的条件。下面我们来介绍一下新出现的两个属性allEntries和beforeInvocation。
allEntries属性
allEntries是boolean类型,表示是否需要清除缓存中的所有元素。默认为false,表示不需要。当指定了allEntries为true时,Spring Cache将忽略指定的key。有的时候我们需要Cache一下清除所有的元素,这比一个一个清除元素更有效率。
@CacheEvict(value="users", allEntries=true) public void delete(Integer id) { System.out.println("delete user by id: " + id); }
beforeInvocation属性
清除操作默认是在对应方法成功执行之后触发的,即方法如果因为抛出异常而未能成功返回时也不会触发清除操作。使用beforeInvocation可以改变触发清除操作的时间,当我们指定该属性值为true时,Spring会在调用该方法之前清除缓存中的指定元素。
@CacheEvict(value="users", beforeInvocation=true) public void delete(Integer id) { System.out.println("delete user by id: " + id); }
其实除了使用@CacheEvict清除缓存元素外,当我们使用Ehcache作为实现时,我们也可以配置Ehcache自身的驱除策略,其是通过Ehcache的配置文件来指定的。由于Ehcache不是本文描述的重点,这里就不多赘述了,想了解更多关于Ehcache的信息,请查看我关于Ehcache的专栏。
@Caching
@Caching注解可以让我们在一个方法或者类上同时指定多个Spring Cache相关的注解。其拥有三个属性:cacheable、put和evict,分别用于指定@Cacheable、@CachePut和@CacheEvict。
@Caching(cacheable = @Cacheable("users"), evict = { @CacheEvict("cache2"), @CacheEvict(value = "cache3", allEntries = true) }) public User find(Integer id) { returnnull; }
使用自定义注解
Spring允许我们在配置可缓存的方法时使用自定义的注解,前提是自定义的注解上必须使用对应的注解进行标注。如我们有如下这么一个使用@Cacheable进行标注的自定义注解。
@Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Cacheable(value="users") public @interface MyCacheable { } 那么在我们需要缓存的方法上使用@MyCacheable进行标注也可以达到同样的效果。 @MyCacheable public User findById(Integer id) { System.out.println("find user by id: " + id); User user = new User(); user.setId(id); user.setName("Name" + id); return user; }
6.自定义KeyGenerator
http://blog.youkuaiyun.com/syani/article/details/52239967