SpringBoot之Redis访问(spring-boot-starter-data-redis)详解数据库

<!--dependency for redis--> 
<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-data-redis --> 
<dependency> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-data-redis</artifactId> 
    <version>2.1.5.RELEASE</version> 
</dependency>

#默认使用配置 
#项目启动的时候也可以设置 Java -jar xxxxxx.jar spring.profiles.actiove=prod 也可以这样启动设置配置文件，但是这只是用于开发和测试。 
spring: 
  profiles: 
    active: dev       #指定默认启动环境application-dev.yml 
    include: redis    #引入文件application-redis.yml

#redis 
redis: 
  #redis机器ip 
  hostname: 127.0.0.1 
  #redis端口 
  port: 6379 
  #redis密码 
  password: 
  #redis超时时间（毫秒），如果不设置，取默认值2000 
  timeout: 10000 
  #最大空闲数 
  maxIdle: 300 
  #连接池的最大数据库连接数。设为0表示无限制,如果是jedis 2.4以后用redis.maxTotal 
  #maxActive=600 
  #控制一个pool可分配多少个jedis实例,用来替换上面的redis.maxActive,如果是jedis 2.4以后用该属性 
  maxTotal: 1000 
  #最大建立连接等待时间。如果超过此时间将接到异常。设为-1表示无限制。 
  maxWaitMillis: 1000 
  #连接的最小空闲时间 默认1800000毫秒(30分钟) 
  minEvictableIdleTimeMillis: 300000 
  #每次释放连接的最大数目,默认3 
  numTestsPerEvictionRun: 1024 
  #逐出扫描的时间间隔(毫秒) 如果为负数,则不运行逐出线程, 默认-1 
  timeBetweenEvictionRunsMillis: 30000 
  #是否在从池中取出连接前进行检验,如果检验失败,则从池中去除连接并尝试取出另一个 
  testOnBorrow: true 
  #在空闲时检查有效性, 默认false 
  testWhileIdle: true 
 
  #redis集群配置 
  #spring.cluster.nodes=192.168.1.1:7001,192.168.1.1:7002,192.168.1.1:7003,192.168.1.1:7004,192.168.1.1:7005,192.168.1.1:7006 
  #spring.cluster.max-redirects=3 
 
  #哨兵模式 
  #sentinel.host1=192.168.1.1 
  #sentinel.port1=26379 
 
  #sentinel.host2=192.168.1.2 
  #sentinel.port2=26379

@Configuration 
public class RedisConfig { 
 
    /* 
     * 定义缓存数据 key 生成策略的bean 包名+类名+方法名+所有参数 
     */ 
//    @Bean 
//    public KeyGenerator wiselyKeyGenerator(){ 
//        return new KeyGenerator() { 
//            @Override 
//            public Object generate(Object target, Method method, Object... params) { 
//                StringBuilder sb = new StringBuilder(); 
//                sb.append(target.getClass().getName()); 
//                sb.append(method.getName()); 
//                for (Object obj : params) { 
//                    sb.append(obj.toString()); 
//                } 
//                return sb.toString(); 
//            } 
//        }; 
// 
//    } 
 
    /* 
     * 要启用spring缓存支持,需创建一个 CacheManager的 bean，CacheManager 接口有很多实现，这里Redis 的集成，用 
     * RedisCacheManager这个实现类 Redis 不是应用的共享内存，它只是一个内存服务器，就像 MySql 似的， 
     * 我们需要将应用连接到它并使用某种“语言”进行交互，因此我们还需要一个连接工厂以及一个 Spring 和 Redis 对话要用的 
     * RedisTemplate， 这些都是 Redis 缓存所必需的配置，把它们都放在自定义的 CachingConfigurerSupport 中 
     */ 
//    @Bean 
//    public CacheManager cacheManager( RedisTemplate redisTemplate) { 
//        RedisCacheManager cacheManager = new RedisCacheManager(redisTemplate); 
//        // cacheManager.setDefaultExpiration(60);//设置缓存保留时间（seconds） 
//        return cacheManager; 
//    } 
 
    // 1.项目启动时此方法先被注册成bean被spring管理,如果没有这个bean，则redis可视化工具中的中文内容（key或者value）都会以二进制存储，不易检查。 
    @Bean 
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) { 
        RedisTemplate<String, Object> template = new RedisTemplate<String, Object>(); 
        template.setConnectionFactory(factory); 
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class); 
        ObjectMapper objectMapper = new ObjectMapper(); 
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); 
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL); 
        jackson2JsonRedisSerializer.setObjectMapper(objectMapper); 
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer(); 
        // key采用String的序列化方式 
        template.setKeySerializer(stringRedisSerializer); 
        // hash的key也采用String的序列化方式 
        template.setHashKeySerializer(stringRedisSerializer); 
        // value序列化方式采用jackson 
        template.setValueSerializer(jackson2JsonRedisSerializer); 
        // hash的value序列化方式采用jackson 
        template.setHashValueSerializer(jackson2JsonRedisSerializer); 
        template.afterPropertiesSet(); 
        return template; 
    } 
}

@SpringBootApplication 
public class Application { 
    public static void main(String[] args) { 
        SpringApplication.run(Application.class, args); 
    } 
}

@RestController 
@RequestMapping("/v1/test") 
public class RedisController { 
 
//    @Autowired
//　　 系统默认的StringRedisTemplete 
//    private StringRedisTemplate stringRedisTemplate; 
 
    @Resource 
    private RedisUtil redisUtil; 
 
    //添加 
    @PostMapping(value = "/add") 
    public void saveRedis() { 
        redisUtil.set("test-key2","test-value"); 
//        stringRedisTemplate.opsForValue().set("test-key", "test-value"); 
    } 
 
    //获取 
    @GetMapping(value = "/get") 
    public String getRedis() { 
        return redisUtil.get("test-key2").toString(); 
//        return stringRedisTemplate.opsForValue().get("test-key"); 
    } 
}

@Componentpublic class RedisUtil { 
@Resource 
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 delete(String... key) { 
if ( key != null && key.length >0 ){ 
if (key.length == 1) { 
redisTemplate.delete(key[0]); 
} else { 
redisTemplate.delete(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 long 
*/ 
public long increment(String key, long delta) { 
if ( delta < 0){ 
throw new RuntimeException("递增因子必须大于0"); 
} 
return redisTemplate.opsForValue().increment(key, delta); 
} 
/** 
* 递减 
* 
* @param key   键 
* @param delta 要减少几(小于0) 
* @return long 
*/ 
public long decrement(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 hashGet(String key, String item) { 
return redisTemplate.opsForHash().get(key, item); 
} 
/** 
* 获取hashKey对应的所有键值 
* @param key 键 
* @return 对应的多个键值 
*/ 
public Map<Object,Object> hashGetAll(String key) { 
return redisTemplate.opsForHash().entries(key); 
} 
/** 
* HashSet 
* 
* @param key 键 
* @param map 对应多个键值 
* @return true 成功 false 失败 
*/ 
public boolean hashSetAll(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 hashSetAll(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 hashSet(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 hashGet(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 hashDelete(String key, Object... item) { 
redisTemplate.opsForHash().delete(key, item); 
} 
/** 
* 判断hash表中是否有该项的值 
* 
* @param key  键 不能为null 
* @param item 项 不能为null 
* @return true 存在 false不存在 
*/ 
public boolean hasHashKey(String key, String item) { 
return redisTemplate.opsForHash().hasKey(key, item); 
} 
/** 
* hash递增 如果不存在,就会创建一个 并把新增后的值返回 
* 
* @param key  键 
* @param item 项 
* @param by   要增加几(大于0) 
* @return double 
*/ 
public double hashIncrement(String key, String item, double by) { 
return redisTemplate.opsForHash().increment(key, item, by); 
} 
/** 
* hash递减 
* 
* @param key  键 
* @param item 项 
* @param by   要减少记(小于0) 
* @return double 
*/ 
public double hashDecrement(String key, String item, double by) { 
return redisTemplate.opsForHash().increment(key, item, -by); 
} 
// ============================set============================= 
/** 
* 根据key获取Set中的所有值 
* @param key 键 
* @return Set<Object> 
*/ 
public Set<Object> setMembers(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 setIsMember(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 setAdd(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 setAdd(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 long 
*/ 
public long setSize(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 { 
return redisTemplate.opsForSet().remove(key, values); 
} catch (Exception e) { 
e.printStackTrace(); 
return 0; 
} 
} 
// ===============================list================================= 
/** 
* 获取list缓存的内容 
* @param key 键 
* @param start 开始 
* @param end 结束 0 到 -1代表所有值 
* @return List<Object> 
*/ 
public List<Object> listGet(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 long 
*/ 
public long listGetSize(String key) { 
try { 
return redisTemplate.opsForList().size(key); 
} catch (Exception e) { 
e.printStackTrace(); 
return 0; 
} 
} 
/** 
* 通过索引 获取list中的值 
* 
* @param key   键 
* @param index 索引 index&gt;=0时， 0 表头，1 第二个元素，依次类推；index&lt;0时，-1，表尾，-2倒数第二个元素，依次类推 
* @return Object 
*/ 
public Object listGetIndex(String key, long index) { 
try { 
return redisTemplate.opsForList().index(key, index); 
} catch (Exception e) { 
e.printStackTrace(); 
return null; 
} 
} 
/** 
* 将list放入缓存 
* 
* @param key   键 
* @param value 值 
* @return true 成功 false 不成功 
*/ 
public boolean listSet(String key, Object value) { 
try { 
redisTemplate.opsForList().rightPush(key, value); 
return true; 
} catch (Exception e) { 
e.printStackTrace(); 
return false; 
} 
} 
/** 
* 将list放入缓存 
* 
* @param key   键 
* @param value 值 
* @param time  时间(秒) 
* @return true 成功 false 不成功 
*/ 
public boolean listSet(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 true 成功 false 不成功 
*/ 
public boolean listSet(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 true 成功 false 不成功 
*/ 
public boolean listSet(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 true 成功 false 不成功 
*/ 
public boolean listUpdateByIndex(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 listRemove(String key, long count, Object value) { 
try { 
return redisTemplate.opsForList().remove(key, count, value); 
} catch (Exception e) { 
e.printStackTrace(); 
return 0; 
} 
} 
}