SpringBoot整合Redis

59 阅读6分钟

一、添加maven依赖

 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-data-redis</artifactId>
 </dependency>

二、application.yml中加入redis相关配置

 spring:
   redis:
     ## Redis数据库索引(默认为0)
     database: 0
     ## Redis服务器地址
     host: *******
     ## Redis服务器连接端口
     port: 9807
     ## Redis服务器连接密码(默认为空)
     password: ******
     jedis:
       pool:
         ## 连接池最大连接数(使用负值表示没有限制)
         #spring.redis.pool.max-active=8
         max-active: 8
         ## 连接池最大阻塞等待时间(使用负值表示没有限制)
         #spring.redis.pool.max-wait=-1
         max-wait: -1
         ## 连接池中的最大空闲连接
         #spring.redis.pool.max-idle=8
         max-idle: 8
         ## 连接池中的最小空闲连接
         #spring.redis.pool.min-idle=0
         min-idle: 0
     ## 连接超时时间(毫秒)
     timeout: 1200
 

三、Redis配置类

 import com.fasterxml.jackson.annotation.JsonAutoDetect;
 import com.fasterxml.jackson.annotation.PropertyAccessor;
 import com.fasterxml.jackson.databind.ObjectMapper;
 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.RedisCacheConfiguration;
 import org.springframework.data.redis.cache.RedisCacheManager;
 import org.springframework.data.redis.cache.RedisCacheWriter;
 import org.springframework.data.redis.connection.RedisConnectionFactory;
 import org.springframework.data.redis.core.*;
 import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
 import org.springframework.data.redis.serializer.StringRedisSerializer;
 import java.time.Duration;
 ​
 @Configuration
 @EnableCaching
 public class RedisConfig extends CachingConfigurerSupport {
 ​
     /**
      * 选择redis作为默认缓存工具
      * @param redisConnectionFactory
      * @return
      */
     /*@Bean
     //springboot 1.xx
     public CacheManager cacheManager(RedisTemplate redisTemplate) {
         RedisCacheManager rcm = new RedisCacheManager(redisTemplate);
         return rcm;
     }*/
     @Bean
     public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
         RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
                 .entryTtl(Duration.ofHours(1)); // 设置缓存有效期一小时
         return RedisCacheManager
                 .builder(RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory))
                 .cacheDefaults(redisCacheConfiguration).build();
     }
 ​
     /**
      * retemplate相关配置
      * @param factory
      * @return
      */
     @Bean
     public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
 ​
         RedisTemplate<String, Object> template = new RedisTemplate<>();
         // 配置连接工厂
         template.setConnectionFactory(factory);
 ​
         //使用Jackson2JsonRedisSerializer来序列化和反序列化redis的value值(默认使用JDK的序列化方式)
         Jackson2JsonRedisSerializer jacksonSeial = new Jackson2JsonRedisSerializer(Object.class);
 ​
         ObjectMapper om = new ObjectMapper();
         // 指定要序列化的域,field,get和set,以及修饰符范围,ANY是都有包括private和public
         om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
         // 指定序列化输入的类型,类必须是非final修饰的,final修饰的类,比如String,Integer等会跑出异常
         om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
         jacksonSeial.setObjectMapper(om);
 ​
         // 值采用json序列化
         template.setValueSerializer(jacksonSeial);
         //使用StringRedisSerializer来序列化和反序列化redis的key值
         template.setKeySerializer(new StringRedisSerializer());
 ​
         // 设置hash key 和value序列化模式
         template.setHashKeySerializer(new StringRedisSerializer());
         template.setHashValueSerializer(jacksonSeial);
         template.afterPropertiesSet();
 ​
         return template;
     }
 }
 ​

四、Redis工具类

 import java.util.Collection;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.TimeUnit;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.data.redis.core.RedisTemplate;
 import org.springframework.stereotype.Component;
 import org.springframework.util.CollectionUtils;
 ​
 @Component
 public final class RedisUtil {
 ​
     @Autowired
     private RedisTemplate<String, Object> redisTemplate;
 ​
     // =============================common============================
     /**
      * 指定缓存失效时间
      * @param key 键
      * @param time 时间(秒)
      * @return
      */
     public boolean expire(String key, long time) {
         try {
             if (time > 0) {
                 redisTemplate.expire(key, time, TimeUnit.SECONDS);
             }
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 根据key 获取过期时间
      * @param key 键 不能为null
      * @return 时间(秒) 返回0代表为永久有效
      */
     public long getExpire(String key) {
         return redisTemplate.getExpire(key, TimeUnit.SECONDS);
     }
 ​
     /**
      * 判断key是否存在
      * @param key 键
      * @return true 存在 false不存在
      */
     public boolean hasKey(String key) {
         try {
             return redisTemplate.hasKey(key);
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 删除缓存
      * @param key 可以传一个值 或多个
      */
     @SuppressWarnings("unchecked")
     public void del(String... key) {
         if (key != null && key.length > 0) {
             if (key.length == 1) {
                 redisTemplate.delete(key[0]);
             } else {
                 redisTemplate.delete((Collection<String>) CollectionUtils.arrayToList(key));
             }
         }
     }
 ​
     // ============================String=============================
     /**
      * 普通缓存获取
      * @param key 键
      * @return 值
      */
     public Object get(String key) {
         return key == null ? null : redisTemplate.opsForValue().get(key);
     }
 ​
     /**
      * 普通缓存放入
      * @param key 键
      * @param value 值
      * @return true成功 false失败
      */
     public boolean set(String key, Object value) {
         try {
             redisTemplate.opsForValue().set(key, value);
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
 ​
     }
 ​
     /**
      * 普通缓存放入并设置时间
      * @param key 键
      * @param value 值
      * @param time 时间(秒) time要大于0 如果time小于等于0 将设置无限期
      * @return true成功 false 失败
      */
     public boolean set(String key, Object value, long time) {
         try {
             if (time > 0) {
                 redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
             } else {
                 set(key, value);
             }
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 递增
      * @param key 键
      * @param delta 要增加几(大于0)
      * @return
      */
     public long incr(String key, long delta) {
         if (delta < 0) {
             throw new RuntimeException("递增因子必须大于0");
         }
         return redisTemplate.opsForValue().increment(key, delta);
     }
 ​
     /**
      * 递减
      * @param key 键
      * @param delta 要减少几(小于0)
      * @return
      */
     public long decr(String key, long delta) {
         if (delta < 0) {
             throw new RuntimeException("递减因子必须大于0");
         }
         return redisTemplate.opsForValue().increment(key, -delta);
     }
 ​
     // ================================Map=================================
     /**
      * HashGet
      * @param key 键 不能为null
      * @param item 项 不能为null
      * @return 值
      */
     public Object hget(String key, String item) {
         return redisTemplate.opsForHash().get(key, item);
     }
 ​
     /**
      * 获取hashKey对应的所有键值
      * @param key 键
      * @return 对应的多个键值
      */
     public Map<Object, Object> hmget(String key) {
         return redisTemplate.opsForHash().entries(key);
     }
 ​
     /**
      * HashSet
      * @param key 键
      * @param map 对应多个键值
      * @return true 成功 false 失败
      */
     public boolean hmset(String key, Map<String, Object> map) {
         try {
             redisTemplate.opsForHash().putAll(key, map);
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * HashSet 并设置时间
      * @param key 键
      * @param map 对应多个键值
      * @param time 时间(秒)
      * @return true成功 false失败
      */
     public boolean hmset(String key, Map<String, Object> map, long time) {
         try {
             redisTemplate.opsForHash().putAll(key, map);
             if (time > 0) {
                 expire(key, time);
             }
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 向一张hash表中放入数据,如果不存在将创建
      * @param key 键
      * @param item 项
      * @param value 值
      * @return true 成功 false失败
      */
     public boolean hset(String key, String item, Object value) {
         try {
             redisTemplate.opsForHash().put(key, item, value);
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 向一张hash表中放入数据,如果不存在将创建
      * @param key 键
      * @param item 项
      * @param value 值
      * @param time 时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
      * @return true 成功 false失败
      */
     public boolean hset(String key, String item, Object value, long time) {
         try {
             redisTemplate.opsForHash().put(key, item, value);
             if (time > 0) {
                 expire(key, time);
             }
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 删除hash表中的值
      * @param key 键 不能为null
      * @param item 项 可以使多个 不能为null
      */
     public void hdel(String key, Object... item) {
         redisTemplate.opsForHash().delete(key, item);
     }
 ​
     /**
      * 判断hash表中是否有该项的值
      * @param key 键 不能为null
      * @param item 项 不能为null
      * @return true 存在 false不存在
      */
     public boolean hHasKey(String key, String item) {
         return redisTemplate.opsForHash().hasKey(key, item);
     }
 ​
     /**
      * hash递增 如果不存在,就会创建一个 并把新增后的值返回
      * @param key 键
      * @param item 项
      * @param by 要增加几(大于0)
      * @return
      */
     public double hincr(String key, String item, double by) {
         return redisTemplate.opsForHash().increment(key, item, by);
     }
 ​
     /**
      * hash递减
      * @param key 键
      * @param item 项
      * @param by 要减少记(小于0)
      * @return
      */
     public double hdecr(String key, String item, double by) {
         return redisTemplate.opsForHash().increment(key, item, -by);
     }
 ​
     // ============================set=============================
     /**
      * 根据key获取Set中的所有值
      * @param key 键
      * @return
      */
     public Set<Object> sGet(String key) {
         try {
             return redisTemplate.opsForSet().members(key);
         } catch (Exception e) {
             e.printStackTrace();
             return null;
         }
     }
 ​
     /**
      * 根据value从一个set中查询,是否存在
      * @param key 键
      * @param value 值
      * @return true 存在 false不存在
      */
     public boolean sHasKey(String key, Object value) {
         try {
             return redisTemplate.opsForSet().isMember(key, value);
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 将数据放入set缓存
      * @param key 键
      * @param values 值 可以是多个
      * @return 成功个数
      */
     public long sSet(String key, Object... values) {
         try {
             return redisTemplate.opsForSet().add(key, values);
         } catch (Exception e) {
             e.printStackTrace();
             return 0;
         }
     }
 ​
     /**
      * 将set数据放入缓存
      * @param key 键
      * @param time 时间(秒)
      * @param values 值 可以是多个
      * @return 成功个数
      */
     public long sSetAndTime(String key, long time, Object... values) {
         try {
             Long count = redisTemplate.opsForSet().add(key, values);
             if (time > 0)
                 expire(key, time);
             return count;
         } catch (Exception e) {
             e.printStackTrace();
             return 0;
         }
     }
 ​
     /**
      * 获取set缓存的长度
      * @param key 键
      * @return
      */
     public long sGetSetSize(String key) {
         try {
             return redisTemplate.opsForSet().size(key);
         } catch (Exception e) {
             e.printStackTrace();
             return 0;
         }
     }
 ​
     /**
      * 移除值为value的
      * @param key 键
      * @param values 值 可以是多个
      * @return 移除的个数
      */
     public long setRemove(String key, Object... values) {
         try {
             Long count = redisTemplate.opsForSet().remove(key, values);
             return count;
         } catch (Exception e) {
             e.printStackTrace();
             return 0;
         }
     }
     // ===============================list=================================
 ​
     /**
      * 获取list缓存的内容
      * @param key 键
      * @param start 开始
      * @param end 结束 0 到 -1代表所有值
      * @return
      */
     public List<Object> lGet(String key, long start, long end) {
         try {
             return redisTemplate.opsForList().range(key, start, end);
         } catch (Exception e) {
             e.printStackTrace();
             return null;
         }
     }
 ​
     /**
      * 获取list缓存的长度
      * @param key 键
      * @return
      */
     public long lGetListSize(String key) {
         try {
             return redisTemplate.opsForList().size(key);
         } catch (Exception e) {
             e.printStackTrace();
             return 0;
         }
     }
 ​
     /**
      * 通过索引 获取list中的值
      * @param key 键
      * @param index 索引 index>=0时, 0 表头,1 第二个元素,依次类推;index<0时,-1,表尾,-2倒数第二个元素,依次类推
      * @return
      */
     public Object lGetIndex(String key, long index) {
         try {
             return redisTemplate.opsForList().index(key, index);
         } catch (Exception e) {
             e.printStackTrace();
             return null;
         }
     }
 ​
     /**
      * 将list放入缓存
      * @param key 键
      * @param value 值
      * @return
      */
     public boolean lSet(String key, Object value) {
         try {
             redisTemplate.opsForList().rightPush(key, value);
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 将list放入缓存
      * @param key 键
      * @param value 值
      * @return
      */
     public boolean lSet(String key, Object value, long time) {
         try {
             redisTemplate.opsForList().rightPush(key, value);
             if (time > 0)
                 expire(key, time);
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 将list放入缓存
      * @param key 键
      * @param value 值
      * @return
      */
     public boolean lSet(String key, List<Object> value) {
         try {
             redisTemplate.opsForList().rightPushAll(key, value);
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 将list放入缓存
      *
      * @param key 键
      * @param value 值
      * @param time 时间(秒)
      * @return
      */
     public boolean lSet(String key, List<Object> value, long time) {
         try {
             redisTemplate.opsForList().rightPushAll(key, value);
             if (time > 0)
                 expire(key, time);
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 根据索引修改list中的某条数据
      * @param key 键
      * @param index 索引
      * @param value 值
      * @return
      */
     public boolean lUpdateIndex(String key, long index, Object value) {
         try {
             redisTemplate.opsForList().set(key, index, value);
             return true;
         } catch (Exception e) {
             e.printStackTrace();
             return false;
         }
     }
 ​
     /**
      * 移除N个值为value
      * @param key 键
      * @param count 移除多少个
      * @param value 值
      * @return 移除的个数
      */
     public long lRemove(String key, long count, Object value) {
         try {
             Long remove = redisTemplate.opsForList().remove(key, count, value);
             return remove;
         } catch (Exception e) {
             e.printStackTrace();
             return 0;
         }
     }
 }
 ​

五、测试Redis

 @SpringBootTest
 class ResultApplicationTests {
 ​
     @Autowired
     RedisUtil redisUtil;
 ​
     @Test
     void contextLoads() throws Exception {
         redisUtil.hasKey("name");
         boolean b = redisUtil.set("name", "wangjun");
         System.out.println(b);
         Object name = redisUtil.get("name");
         System.out.println(name);
         redisUtil.del("name");
         boolean hasKey = redisUtil.hasKey("name");
         System.out.println(hasKey);
 ​
     }
 ​
 }