Spring Boot2篇 - 十五、Spring Boot 整合Redis

十五、Spring Boot 整合Redis

• springboot 2.x后 ，原来默认使用的 Jedis 被 lettuce 替换，配置文件中的配置注意使用lettuce。
• jedis：采用的直连，多个线程操作的话，是不安全的。如果要避免不安全，使用jedis pool连接池！更像BIO模式
• lettuce：采用netty，实例可以在多个线程中共享，不存在线程不安全的情况！可以减少线程数据了，更像NIO模式

15.1 测试整合

• 创建springboot项目， 勾选上以下选项（导入依赖）
  

• 源码分析，有之前的自动装配原理可知Redis也存在一个配置类并且绑定了一个配置文件类

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(RedisOperations.class)
//对应的配置类
@EnableConfigurationProperties(RedisProperties.class)
//导入了两个类点击进去看看，可知JedisConnectionConfiguration不生效
@Import({ LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class })
public class RedisAutoConfiguration {

    @Bean
    //说明我们可以自己定义一个redi sTemp late来替换这个默认的
    @ConditionalOnMissingBean(name = "redisTemplate")
    @ConditionalOnSingleCandidate(RedisConnectionFactory.class)
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        //默认的RedisTemplate 没有过多的设置，redis 对象都是需要序列化! 
		//两个泛型都是object，object 的类型，我们后使用需要强制转换<string， object>
        RedisTemplate<Object, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }

    @Bean
    @ConditionalOnMissingBean
    @ConditionalOnSingleCandidate(RedisConnectionFactory.class)
    public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) {//由于string 是redis中最常使用的类型，所以说单独提出来了一个bean !
        StringRedisTemplate template = new StringRedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }

}

• 编写配置文件，连接Redis

spring:
  redis:
    host: 192.168.242.110
    port: 6379

• 测试方法

// 这就是之前 RedisAutoConfiguration 源码中的 Bean
@Autowired
private RedisTemplate redisTemplate;
@Test
void contextLoads() {
    /** redisTemplate 操作不同的数据类型，API 和 Redis 中的是一样的
         * opsForValue 类似于 Redis 中的 String
         * opsForList 类似于 Redis 中的 List
         * opsForSet 类似于 Redis 中的 Set
         * opsForHash 类似于 Redis 中的 Hash
         * opsForZSet 类似于 Redis 中的 ZSet
         * opsForGeo 类似于 Redis 中的 Geospatial
         * opsForHyperLogLog 类似于 Redis 中的 HyperLogLog
         */

    // 除了基本的操作，常用的命令都可以直接通过redisTemplate.xxxx操作，比如事务、基本的CRUD……

    // 和数据库相关的操作都需要通过连接操作
    //获取Redis的连接对象
    //RedisConnection connection = redisTemplate.getConnectionFactory().getConnection();
    //connection.flushDb();

    redisTemplate.opsForValue().set("key", "呵呵");
    System.out.println(redisTemplate.opsForValue().get("key"));
}

• 测试结果

15.2 序列化(自定义RedisTemplate模板)

为什么要序列化？

• 新建User类，先不要序列化

/**
 * @author cVzhanshi
 * @create 2021-07-28 22:06
 */
@Component
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private String name;
    private int age;
}

• 网Redis中存入user对象

@Test
public void test() throws JsonProcessingException {
    User user = new User("cv战士", 12);
    String string = new ObjectMapper().writeValueAsString(user);
    redisTemplate.opsForValue().set("user",string);
    System.out.println(redisTemplate.opsForValue().get("user"));
}

• 结果

控制台输出

Linux中redis控制台

• 测试二，redis直接存储对象

@Test
public void test() {
    User user = new User("cv战士", 12);

    redisTemplate.opsForValue().set("user",user);
    System.out.println(redisTemplate.opsForValue().get("user"));
}

• 测试结果报错
  

综上所述，需要序列化

如何序列化呢？

• 首先对象要求序列化

@Component
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {
    private String name;
    private int age;
}

• 进一步查看RedisTemplate类的源码
  

---

• 自定义RedisTemplate，在定义一的redisTemplate设置序列化

@Configuration
public class RedisConfig {
    /**
     *  编写自定义的 redisTemplate
     *  这是一个比较固定的模板
     */
    @Bean
    @SuppressWarnings("all")
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
        // 为了开发方便，直接使用<String, Object>
        RedisTemplate<String, Object> template = new RedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);

        // Json 配置序列化
        // 使用 jackson 解析任意的对象
        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
        // 使用 objectMapper 进行转义
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        // String 的序列化
        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);
        // 把所有的配置 set 进 template
        template.afterPropertiesSet();

        return template;
    }
}

• 继续测试

@Test
public void test() throws JsonProcessingException {
    User user = new User("cv战士", 12);
    //String string = new ObjectMapper().writeValueAsString(user);
    redisTemplate.opsForValue().set("user",user);
    System.out.println(redisTemplate.opsForValue().get("user"));
}

• 测试结果
  

15.3 Redis工具类

@Component
public final class RedisUtil {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    // =============================common============================
    /**
* 指定缓存失效时间
* @param key  键
* @param time 时间(秒)
*/
    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)
*/
    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)
*/
    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
*/
    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 对应多个键值
*/
    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)
*/
    public double hincr(String key, String item, double by) {
        return redisTemplate.opsForHash().increment(key, item, by);
    }


    /**
* hash递减
*
* @param key  键
* @param item 项
* @param by   要减少记(小于0)
*/
    public double hdecr(String key, String item, double by) {
        return redisTemplate.opsForHash().increment(key, item, -by);
    }


    // ============================set=============================

    /**
* 根据key获取Set中的所有值
* @param key 键
*/
    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 键
*/
    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代表所有值
*/
    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 键
*/
    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倒数第二个元素，依次类推
*/
    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 值
*/
    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 值
* @param time  时间(秒)
*/
    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;
        }

    }

}

• 测试

@Autowired
private RedisUtil redisUtil;
@Test
public void test1()  {
    redisUtil.set("name","cv战士");
    System.out.println(redisUtil.get("name"));
}