SpringBoot整合Redis及Redis的工具类

说起SpringBoot整合什么什么，那就太简单了

但是要注意的是，SpringBoot在 2.x后 ，原来底层使用的 Jedis 被 lettuce 替换。

• jedis：采用的直连，多个线程操作的话，是不安全的。如果要避免不安全，使用jedis pool连接池！更像BIO模式

• lettuce：采用netty，实例可以在多个线程中共享，不存在线程不安全的情况！可以减少线程数据了，更像NIO模式

一些什么原理我就不说了，直接入主题吧

简单的了解

1、当然要新建一个SpringBoot的项目，并导入依赖（也可以在新建项目的时候勾选）

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

2、SpringBoot的配置文件编写，它里面有许多默认值，我就不一一举例了，建议还是在yml配置文件中写出来

#配置redis
spring:
  redis:
    host: 127.0.0.1
    port: 6379
    database: 0

3、配置文件配置好了，那怎么使用呢？SpringBoot这么强大当然有模板啦RedisTemplate

@Autowired
private RedisTemplate redisTemplate;

@Test
void contextLoads() {
    redisTemplate.opsForValue().set("name", "wulei");
    System.out.println(redisTemplate.opsForValue().get("name"));
}

4、运行结果

5、但是！！！你在XShell客户端去keys *的时候，发现乱码了，没关系，下面会说到序列化的问题的

6、SpringBoot默认的序列化器是采用JDK序列化器，但是我们想自己写一个序列化器怎么办呢？源码底层我也不说了，说了也是白说，直接建一个config包，建一个RedisConfig

@Configuration
public class RedisConfig {
    //这个是一个固定的模板,写好了后可以直接拿过去用的
    //编写我们自己的redisTemplate
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory)
            throws UnknownHostException {
        // 将template 泛型设置为 <String, Object>
        RedisTemplate<String, Object> template = new RedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);

        //序列化设置

        // key、hash的key 采用 String序列化方式
        template.setKeySerializer(RedisSerializer.string());
        template.setHashKeySerializer(RedisSerializer.string());
        // value、hash的value 采用 Jackson 序列化方式
        template.setValueSerializer(RedisSerializer.json());
        template.setHashValueSerializer(RedisSerializer.json());
        template.afterPropertiesSet();

        return template;
    }

}

然后再次执行上面的那个Test后，在xshell里面发现没有乱码了，而是正常的显示

java方法与Redis命令

1、当你用模板点出来的时候发现会有很多方法，但是都不熟悉

2、其实英语成绩好的应该可以看出来什么

• opsForValue 对应的String
• opsForSet 对应的Set
• opsForList 对应的List
• opsForHash对应的Hash
• opsForZSet 对应的ZSet
• …

3、你点出上面对应的然后再点的时候会发现，语法基本和Redis命令一样

4、但是，如果代码量很大的时候，有好多重复的语句，那就是重复造轮子了，没有必要，所以我们要把这些方法直接提取成一个工具类，在企业中有自己的工具类，他们也不会让你直接用原生的方法

Redis工具类

这个下面的工具类也是可以直接拿过去用的，但是不是很完善，只有一些基本的方法，可以自己根据需求加一些封装的方法

package com.wu.utils;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ZSetOperations;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;

import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;

/**
 * Redis的工具类
 */
@Component
public final class RedisUtil {
    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    //==================================common==================================


    /**
     * 清空所有的数据库
     */
    public void flushAll() {
        redisTemplate.getConnectionFactory().getConnection().flushAll();
    }

    /**
     * 清空当前的数据库
     */
    public void flushDb() {
        redisTemplate.getConnectionFactory().getConnection().flushDb();
    }

    /**
     * 指定缓存的有效时间
     * 时间秒
     */
    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获取过期时间
     * 返回0代表永久有效
     */
    public long getExpire(String key) {
        return redisTemplate.getExpire(key, TimeUnit.SECONDS);
    }

    /**
     * 判断key是否存在
     */
    public boolean hasKey(String key) {
        try {
            return redisTemplate.hasKey(key);
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 删除key及value
     */

    public void del(String... key) {
        if (key != null && key.length > 0) {
            if (key.length == 1) {
                redisTemplate.delete(key[0]);
            } else {
                redisTemplate.delete(CollectionUtils.arrayToList(key));
            }
        }
    }

    //=============================String=============================

    /**
     * set key-value
     * return true 成功
     * return false 失败
     */

    public boolean set(String key, Object value) {
        try {
            redisTemplate.opsForValue().set(key, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 根据key获取value
     */

    public Object get(String key) {
        return key == null ? null : redisTemplate.opsForValue().get(key);
    }

    /**
     * 普通key放入并设置时间
     * key 键
     * value 值
     * 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);
            } else {
                set(key, value);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 递增
     */

    public long incr(String key, long delta) {
        if (delta < 0) {
            throw new RuntimeException("递增因子要大于0");
        }
        return redisTemplate.opsForValue().increment(key, delta);
    }

    /**
     * 递减
     */

    public long decr(String key, long delta) {
        if (delta < 0) {
            throw new RuntimeException("递减因子要大于0");
        }
        return redisTemplate.opsForValue().decrement(key, delta);
    }

    //=========================Hash=========================


    /**
     * HashGet
     * key键不能为空
     * item不能为空
     */

    public Object hget(String key, String item) {
        return redisTemplate.opsForHash().get(key, item);
    }

    /**
     * 获取HashKey所对应的所有键值对
     */
    public Map<Object, Object> hmget(String key) {
        return redisTemplate.opsForHash().entries(key);
    }

    /**
     * HashSet
     * key 键
     * 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一个键值对
     */
    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;
        }
    }

    /**
     * HashSet并设置时间
     */
    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表中放入数据,如果不存在将创建
     */
    public boolean hset(String key, String item, Object value, long time) {
        try {
            hset(key, item, value);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 删除Hash表的值
     */
    public void hdel(String key, Object... item) {
        redisTemplate.opsForHash().delete(key, item);
    }

    /**
     * 判断Hash表中是否有该值
     */

    public boolean hHashKey(String key, String item) {
        return redisTemplate.opsForHash().hasKey(key, item);
    }

    /**
     * hash递增 如果不存在,就会创建一个 并把新增后的值返回
     */

    public double hincr(String key, String item, long delta) {
        return redisTemplate.opsForHash().increment(key, item, delta);
    }

    /**
     * Hash递减
     */

    public double hdecr(String key, String item, long delta) {
        return redisTemplate.opsForHash().increment(key, item, -delta);
    }

    //================================Set===========================

    /**
     * 根据key获取Set中的所有值
     */
    public Set<Object> sGet(String key) {
        try {
            return redisTemplate.opsForSet().members(key);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }


    /**
     * 查询Set  key的value是否存在
     */

    public boolean sHasKey(String key, Object value) {
        try {
            return redisTemplate.opsForSet().isMember(key, value);
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将数据放入Set中
     * 一个key
     * 可以有多个value
     */

    public long sSet(String key, Object... values) {
        try {
            return redisTemplate.opsForSet().add(key, values);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 将数据放入Set中
     * 一个key
     * 可以有多个value
     * 设置时间
     */
    public long sSet(String key, long time, Object... values) {
        try {
            long l = sSet(key, values);
            if (time > 0) {
                expire(key, time);
            }
            return l;
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 获取set的长度
     */
    public long sGetSetLength(String key) {
        try {
            return redisTemplate.opsForSet().size(key);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 根据key移除key中指定的value
     */

    public long sRemove(String key, Object... values) {
        try {
            return redisTemplate.opsForSet().remove(key, values);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }


    //==========================List=======================

    /**
     * 获取list中的内容
     * 根据下标索引获取
     */
    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的长度
     */

    public long lGetLength(String key) {
        try {
            return redisTemplate.opsForList().size(key);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 通过下标索引获取list的某一个值
     */
    public Object lGetByIndex(String key, long index) {
        try {
            return redisTemplate.opsForList().index(key, index);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }


    /**
     * 将list从左边放入缓存
     */
    public boolean lSet(String key, Object value) {
        try {
            redisTemplate.opsForList().leftPush(key, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list从右边放入缓存
     */
    public boolean rSet(String key, Object value) {
        try {
            redisTemplate.opsForList().rightPush(key, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list从左边放入缓存并设置时间
     */
    public boolean lSet(String key, Object value, long time) {
        try {
            redisTemplate.opsForList().leftPush(key, value);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list从右边放入缓存并设置时间
     */
    public boolean rSet(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集合从左边放入缓存
     */
    public boolean lSet(String key, List<Object> list) {
        try {
            redisTemplate.opsForList().leftPushAll(key, list);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list集合从右边放入缓存
     */
    public boolean rSet(String key, List<Object> list) {
        try {
            redisTemplate.opsForList().rightPushAll(key, list);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list集合从左边放入缓并设置时间
     */
    public boolean lSet(String key, List<Object> list, long time) {
        try {
            redisTemplate.opsForList().leftPushAll(key, list);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list集合从右边放入缓存
     */
    public boolean rSet(String key, List<Object> list, long time) {
        try {
            redisTemplate.opsForList().rightPushAll(key, list);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }


    /**
     * 根据索引修改list中的某一条数据
     */
    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的值
     * count=0  移除全部
     * count>0 从左边开始数
     * count<0 从右边开始数
     */

    public long lRemove(String key, long count, Object value) {
        try {
            return redisTemplate.opsForList().remove(key, count, value);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }


    //===============================ZSet=============================

    /**
     * 添加元素，有序集合是按照元素的scores的值由小到大排序的
     */

    public boolean zAdd(String key, String value, double scores) {
        try {
            redisTemplate.opsForZSet().add(key, value, scores);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 把整个set集合添加到set中去
     */
    public boolean zAdd(String key, Set<ZSetOperations.TypedTuple<Object>> values, double scores) {
        try {
            redisTemplate.opsForZSet().add(key, values);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 根据给定的一个或多个value移除他们
     */
    public long zRemove(String key, Object... values) {
        try {
            return redisTemplate.opsForZSet().remove(key, values);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 增加scores的值，并返回增加后的值
     */
    public double zincr(String key, String value, double delta) {
        return redisTemplate.opsForZSet().incrementScore(key, value, delta);
    }

    /**
     * 返回某个元素在集合中的索引，从小到大
     * 0表示第一位
     */
    public long zRank(String key, Object value) {
        return redisTemplate.opsForZSet().rank(key, value);
    }

    /**
     * 根据下标区间获取集合的所有元素，从小到大
     */
    public Set<Object> zRange(String key, long start, long end) {
        return redisTemplate.opsForZSet().range(key, start, end);
    }

    /**
     * 根据下标区间获取集合的所有元素，从大到小
     */
    public Set<Object> zReRange(String key, long start, long end) {
        return redisTemplate.opsForZSet().reverseRange(key, start, end);
    }

    /**
     * 获取集合的全部元素并带上scores
     */
    public Set<ZSetOperations.TypedTuple<Object>> zRangeWithScores(String key, long start, long end) {
        return redisTemplate.opsForZSet().rangeWithScores(key, start, end);
    }

    /**
     * 根据scores查询元素
     */
    public Object zScores(String key, double scores) {
        return redisTemplate.opsForZSet().score(key, scores);
    }

    //...等等，自己可以慢慢的完善，因为实在是太多了，我到现在我也不知道写了多少，只知道基本的差不多都写完了，最好还是捕获下异常
}