SpringBoot怎么使用RedisTemplate操作Redis数据类型

Spring 封装了 RedisTemplate 来操作 Redis，它支持所有的 Redis 原生的 API。在 RedisTemplate 中定义了对5种数据结构的操作方法。

• opsForValue()：操作字符串。

• opsForList()：操作列表。

• opsForHash()：操作哈希。

• opsForSet()：操作集合。

• opsForZSet()：操作有序集合。

下面通过实例来理解和应用这些方法。这里需要特别注意的是，运行上述方法后要对数据进行清空操作，否则多次运行会导致数据重复操作。

（1）使用Maven添加依赖文件

在pom.xml配置信息文件中，添加Redis依赖：

我的SpringBoot版本：

    org.springframework.boot
    spring-boot-starter-parent
    2.3.4.RELEASE
     

添加Redis依赖：

    org.springframework.boot
    spring-boot-starter-data-redis
    2.3.3.RELEASE

（2）Redis的配置

在 application.yml 配置文件中配置Redis信息：

#Spring配置
spring:
  #缓存管理器
  cache:
    type: redis
  #Redis配置
  redis:
    database: 0 #Redis数据库索引（默认为0）
    host: 127.0.0.1 #Redis服务器地址
    port: 6379 #Redis服务器连接端口
    password:  #Redis服务器连接密码（默认为空）
    jedis:
      pool:
        max-active: 8 #连接池最大连接数（使用负值表示没有限制）
        max-wait: -1s #连接池最大阻塞等待时间（使用负值表示没有限制）
        max-idle: 8  #连接池中的最大空闲连接
        min-idle: 0 #连接池中的最小空闲连接
    lettuce:
      shutdown-timeout: 100ms #关闭超时时间，默认值100ms

（3）Redis配置类（config层）

创建com.pjb.config包中，并创建RedisConfig类（Redis配置类），并继承CachingConfigurerSupport类。

package com.pjb.config;
 
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.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.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
 
import java.lang.reflect.Method;
 
/**
 * Redis配置类
 * @author pan_junbiao
 **/
@Configuration
public class RedisConfig extends CachingConfigurerSupport
{
    /**
     * 缓存对象集合中，缓存是以key-value形式保存的,
     * 当不指定缓存的key时，SpringBoot会使用keyGenerator生成Key。
     */
    @Bean
    public KeyGenerator keyGenerator()
    {
        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();
            }
        };
    }
 
    /**
     * 缓存管理器
     */
    @SuppressWarnings("rawtypes")
    @Bean
    public CacheManager cacheManager(RedisConnectionFactory connectionFactory)
    {
        RedisCacheManager cacheManager = RedisCacheManager.create(connectionFactory);
        //设置缓存过期时间
 
        return cacheManager;
    }
 
    /**
     * 实例化RedisTemplate对象
     */
    @Bean
    public RedisTemplate redisTemplate(RedisConnectionFactory factory)
    {
        StringRedisTemplate template = new StringRedisTemplate(factory);
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);
        template.setValueSerializer(jackson2JsonRedisSerializer);
        template.afterPropertiesSet();
        return template;
    }
}

1、字符串（String）

字符串（String）是 Redis 最基本的数据类型。String 的一个“Key”对应一个“Value”，即 Key-Value 键值对。String 是二进制安全的，可以存储任何数据（比如图片或序列化的对象）。值最大能存储512MB的数据。一般用于一些复杂的计数功能的缓存。RedisTemplate 提供以下操作 String 的方法。

1.1 void set(K key, V value)；V get(Object key)

具体用法见以下代码：

/**
 * Redis操作字符串（String）
 * @author pan_junbiao
 **/
@SpringBootTest
public class StringTest
{
    @Autowired
    private RedisTemplate redisTemplate;
    
    @Test
    public void string1()
    {
        redisTemplate.opsForValue().set("userName","pan_junbiao的博客");
        redisTemplate.opsForValue().set("blogUrl","https://blog.csdn.net/pan_junbiao");
        redisTemplate.opsForValue().set("blogRemark","您好，欢迎访问 pan_junbiao的博客");
        System.out.println("用户名称：" + redisTemplate.opsForValue().get("userName"));
        System.out.println("博客地址：" + redisTemplate.opsForValue().get("blogUrl"));
        System.out.println("博客信息：" + redisTemplate.opsForValue().get("blogRemark"));
    }
}

执行结果：

1.2 void set(K key, V value, long timeout, TimeUnit unit)

以下代码设置3s失效。3s之内查询有结果，3s之后查询返回为null。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void string2()
{
    //设置的是3s失效，3s之内查询有结果，3s之后返回null
    redisTemplate.opsForValue().set("blogRemark","您好，欢迎访问 pan_junbiao的博客",3, TimeUnit.SECONDS);
    try
    {
        Object s1 = redisTemplate.opsForValue().get("blogRemark");
        System.out.println("博客信息：" + s1);
        Thread.currentThread().sleep(2000);
 
        Object s2 = redisTemplate.opsForValue().get("blogRemark");
        System.out.println("博客信息：" + s2);
        Thread.currentThread().sleep(5000);
 
        Object s3 = redisTemplate.opsForValue().get("blogRemark");
        System.out.println("博客信息：" + s3);
    }
    catch (InterruptedException ie)
    {
        ie.printStackTrace();
    }
}

执行结果：

1.3 V getAndSet(K key, V value)

设置键的字符串，并返回其旧值。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void string3()
{
    //设置键的字符串并返回其旧值
    redisTemplate.opsForValue().set("blogRemark","pan_junbiao的博客");
    Object oldVaule = redisTemplate.opsForValue().getAndSet("blogRemark","您好，欢迎访问 pan_junbiao的博客");
    Object newVaule = redisTemplate.opsForValue().get("blogRemark");
    System.out.println("旧值：" + oldVaule);
    System.out.println("新值：" + newVaule);
}

执行结果：

1.4 Integer append(K key, V value)

如果key已经存在，并且是一个字符串，则该命令将该值追加到字符串的末尾。如果key不存在，则它将被创建并设置为空字符串，因此 append 在这种特殊情况下类似于 set。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void string4()
{
    //设置value的序列化规则，否则会报错
    redisTemplate.setValueSerializer(new StringRedisSerializer());
 
    redisTemplate.opsForValue().append("blogRemark","您好，欢迎访问 ");
    System.out.println(redisTemplate.opsForValue().get("blogRemark"));
    redisTemplate.opsForValue().append("blogRemark","pan_junbiao的博客");
    System.out.println(redisTemplate.opsForValue().get("blogRemark"));
}

执行结果：

注意：这里一定要注意反序列化配置，否则会报错。

1.5 Long size(K key)

返回key所对应的value值的长度，见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void string5()
{
    redisTemplate.opsForValue().set("userName","pan_junbiao的博客");
    System.out.println("Value值：" + redisTemplate.opsForValue().get("userName"));
    System.out.println("Value值的长度：" + redisTemplate.opsForValue().size("userName"));
}

执行结果：

2、列表（List）

Redis列表是简单的字符串列表，按照插入顺序排序。可以添加一个元素到列表的头部（左边）或尾部（右边）。

使用list数据结果，可以做简单的消息队列的功能。还可以利用 Irange 命令，做基于Reids的分页功能，性能极佳。

2.1 Long leftPushAll(K key, V... values)；Long rightPushAll(K key, V... values)

leftPushAll方法：表示把一个数组插入列表中。

rightPushAll方法：表示向列表的最右边批量添加元素。具体用法见以下代码：

/**
 * Redis操作列表（List）
 * @author pan_junbiao
 **/
@SpringBootTest
public class ListTest
{
    @Autowired
    private RedisTemplate redisTemplate;
 
    @Test
    public void list1()
    {
        String[] user1 = new String[]{"1","pan_junbiao的博客","您好，欢迎访问 pan_junbiao的博客"};
        String[] user2 = new String[]{"2","pan_junbiao的博客","https://blog.csdn.net/pan_junbiao"};
        String[] user3 = new String[]{"3","pan_junbiao的博客","您好，欢迎访问 pan_junbiao的博客"};
 
        redisTemplate.opsForList().rightPushAll("user1",user1);
        redisTemplate.opsForList().rightPushAll("user2",user2);
        redisTemplate.opsForList().rightPushAll("user3",user3);
 
        System.out.println(redisTemplate.opsForList().range("user1",0,-1));
        System.out.println(redisTemplate.opsForList().range("user2",0,-1));
        System.out.println(redisTemplate.opsForList().range("user3",0,-1));
    }
}

执行结果：

2.2 Long leftPush(K key, V value)；Long rightPush(K key, V value)

leftPush方法：将所有指定的值插入在键的列表的头部。如果键不存在，则在执行推送操作之前将其创建为空列表（从左边插入）。

rightPush方法：将所有指定的值插入在键的列表的尾部。如果键不存在，则在执行推送操作之前将其创建为空列表（从右边插入）。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void list2()
{
    redisTemplate.opsForList().rightPush("userInfo",1);
    redisTemplate.opsForList().rightPush("userInfo","pan_junbiao的博客");
    redisTemplate.opsForList().rightPush("userInfo","https://blog.csdn.net/pan_junbiao");
    redisTemplate.opsForList().rightPush("userInfo","您好，欢迎访问 pan_junbiao的博客");
 
    System.out.println("用户编号：" + redisTemplate.opsForList().index("userInfo",0));
    System.out.println("用户名称：" + redisTemplate.opsForList().index("userInfo",1));
    System.out.println("博客地址：" + redisTemplate.opsForList().index("userInfo",2));
    System.out.println("博客信息：" + redisTemplate.opsForList().index("userInfo",3));
}

执行结果：

2.3 Long size(K key)

返回存储在键中的列表的长度。如果键不存在，则将其解释为空列表，并返回0。如果key存在的值不是列表，则返回错误。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void list3()
{
    String[] user = new String[]{"1","pan_junbiao的博客","您好，欢迎访问 pan_junbiao的博客"};
    redisTemplate.opsForList().leftPushAll("user",user);
    System.out.println("列表的长度：" + redisTemplate.opsForList().size("user"));
}

执行结果：

2.4 void set(K key, long index, V value)

在列表中 index 的位置设置 value。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void list4()
{
    String[] user = new String[]{"1","pan_junbiao的博客","https://blog.csdn.net/pan_junbiao"};
    redisTemplate.opsForList().rightPushAll("user",user);
    System.out.println(redisTemplate.opsForList().range("user",0,-1));
 
    redisTemplate.opsForList().set("user",2,"您好，欢迎访问 pan_junbiao的博客");
    System.out.println(redisTemplate.opsForList().range("user",0,-1));
}

执行结果：

2.5 V index(K key, long index)

根据下标获取列表中的值（下标从0开始）。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void list2()
{
    redisTemplate.opsForList().rightPush("userInfo",1);
    redisTemplate.opsForList().rightPush("userInfo","pan_junbiao的博客");
    redisTemplate.opsForList().rightPush("userInfo","https://blog.csdn.net/pan_junbiao");
    redisTemplate.opsForList().rightPush("userInfo","您好，欢迎访问 pan_junbiao的博客");
 
    System.out.println("用户编号：" + redisTemplate.opsForList().index("userInfo",0));
    System.out.println("用户名称：" + redisTemplate.opsForList().index("userInfo",1));
    System.out.println("博客地址：" + redisTemplate.opsForList().index("userInfo",2));
    System.out.println("博客信息：" + redisTemplate.opsForList().index("userInfo",3));
}

执行结果：

2.6 Long remove(K key, long count, Object value)

从存储在键中的列表，删除给定“count”值的元素的第1个计数事件。其中，参数count的含义如下：

• count=0：删除等于value的所有元素。

• count>0：删除等于从头到尾移动的值的元素。

• count<0：删除等于从尾到头移动的值的元素。

以下代码用于删除列表中第一次出现的值：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void list5()
{
    String[] user = new String[]{"1","pan_junbiao的博客","您好，欢迎访问 pan_junbiao的博客"};
    redisTemplate.opsForList().rightPushAll("user",user);
    System.out.println(redisTemplate.opsForList().range("user",0,-1));
 
    //将删除列表中第一次出现的pan_junbiao的博客
    redisTemplate.opsForList().remove("user",1,"pan_junbiao的博客");
    System.out.println(redisTemplate.opsForList().range("user",0,-1));
}

执行结果：

2.7 V leftPop(K key)；V rightPop(K key)

leftPop方法：弹出最左边的元素，弹出之后该值在列表中将不复存在。

rightPop方法：弹出最右边的元素，弹出之后该值在列表中将不复存在。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void list6()
{
    String[] user = new String[]{"1","pan_junbiao的博客","您好，欢迎访问 pan_junbiao的博客"};
    redisTemplate.opsForList().rightPushAll("user",user);
    System.out.println(redisTemplate.opsForList().range("user",0,-1));
    //弹出最右边的元素，弹出之后该值在列表中将不复存在
    System.out.println(redisTemplate.opsForList().rightPop("user"));
    System.out.println(redisTemplate.opsForList().range("user",0,-1));
}

执行结果：

3、哈希（Hash）

Redis 中的 hash（哈希）是一个 string 类型的 field 和 value 的映射表，hash 特别适合用于存储对象。value 中存放的是结构化的对象。利用这样数据结果，可以方便地操作其中的某个字段。比如在“单点登录”时，可以用这种数据结构存储用户信息。以 CookieId 作为 key，设置30分钟为缓存过期时间，能很好地模拟出类似 Session 的效果。

3.1 void putAll(H key, Map m)；Map entries(H key)

putAll方法：用 m 中提供的多个散列字段设置到 key 对应的散列表中。

entries方法：根据密钥获取整个散列存储。具体用法见以下代码：

/**
 * Redis操作哈希（Hash）
 * @author pan_junbiao
 **/
@SpringBootTest
public class HashTest
{
    @Autowired
    private RedisTemplate redisTemplate;
 
    @Test
    public void hash2()
    {
        Map userMap = new HashMap<>();
        userMap.put("userName","pan_junbiao的博客");
        userMap.put("blogRemark","您好，欢迎访问 pan_junbiao的博客");
        redisTemplate.opsForHash().putAll("userHash",userMap);
        System.out.println(redisTemplate.opsForHash().entries("userHash"));
    }
}

执行结果：

3.2 void put(H key, HK hashKey, HV value)；HV get(H key, Object hashKey)

put方法：设置 hashKey 的值。

get方法：从键中的散列获取给定 hashKey 的值。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void hash3()
{
    redisTemplate.opsForHash().put("userHash","userName","pan_junbiao的博客");
    redisTemplate.opsForHash().put("userHash","blogUrl","https://blog.csdn.net/pan_junbiao");
    redisTemplate.opsForHash().put("userHash","blogRemark","您好，欢迎访问 pan_junbiao的博客");
    System.out.println("用户名称：" + redisTemplate.opsForHash().get("userHash","userName"));
    System.out.println("博客地址：" + redisTemplate.opsForHash().get("userHash","blogUrl"));
    System.out.println("博客信息：" + redisTemplate.opsForHash().get("userHash","blogRemark"));
}

执行结果：

3.3 List values(H key)；Set keys(H key)

values方法：根据密钥获取整个散列存储的值。

keys方法：根据密钥获取整个散列存储的键。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void hash4()
{
    redisTemplate.opsForHash().put("userHash","userName","pan_junbiao的博客");
    redisTemplate.opsForHash().put("userHash","blogRemark","您好，欢迎访问 pan_junbiao的博客");
    System.out.println("散列存储的值：" + redisTemplate.opsForHash().values("userHash"));
    System.out.println("散列存储的键：" + redisTemplate.opsForHash().keys("userHash"));
}

执行结果：

3.4 Boolean hasKey(H key, Object hashKey)；Long size(H key)

hasKey方法：确定 hashKey 是否存在。

size方法：获取 key 所对应的散列表的大小个数。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void hash5()
{
    redisTemplate.opsForHash().put("userHash","userName","pan_junbiao的博客");
    redisTemplate.opsForHash().put("userHash","blogUrl","https://blog.csdn.net/pan_junbiao");
    redisTemplate.opsForHash().put("userHash","blogRemark","您好，欢迎访问 pan_junbiao的博客");
    System.out.println(redisTemplate.opsForHash().hasKey("userHash","userName"));
    System.out.println(redisTemplate.opsForHash().hasKey("userHash","age"));
    System.out.println(redisTemplate.opsForHash().size("userHash"));
}

执行结果：

3.5 Long delete(H key, Object... hashKeys)

删除给定的 hashKeys。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void hash6()
{
    redisTemplate.opsForHash().put("userHash","userName","pan_junbiao的博客");
    redisTemplate.opsForHash().put("userHash","blogRemark","您好，欢迎访问 pan_junbiao的博客");
    System.out.println(redisTemplate.opsForHash().delete("userHash","blogRemark"));
    System.out.println(redisTemplate.opsForHash().entries("userHash"));
}

执行结果：

4、集合（Set）

set 是存放不重复值的集合。利用 set 可以做全局去重复的功能。还可以进行交集、并集、差集等操作，也可用来实现计算共同喜好、全部的喜好、自己独有的喜好等功能。

Redis 的 set 是 string 类型的无序集合，通过散列表实现。

4.1 Long add(K key, V... values)；Set members(K key)

add方法：在无序集合中添加元素，返回添加个数；如果存在重复的则不进行添加。

members方法：返回集合中的所有成员。具体用法见以下代码：

/**
 * Redis操作集合（Set）
 * @author pan_junbiao
 **/
@SpringBootTest
public class SetTest
{
    @Autowired
    private RedisTemplate redisTemplate;
 
    @Test
    public void set1()
    {
        String[] citys = new String[]{"北京","上海","广州","深圳"};
        System.out.println(redisTemplate.opsForSet().add("citySet",citys));
        System.out.println(redisTemplate.opsForSet().add("citySet","香港","澳门","台湾"));
        //返回集合中的所有元素
        System.out.println(redisTemplate.opsForSet().members("citySet"));
    }
}

执行结果：

4.2 Long remove(K key, Object... values)

移除集合中一个或多个成员。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void set2()
{
    String[] citys = new String[]{"北京","上海","广州","深圳"};
    System.out.println(redisTemplate.opsForSet().add("citySet",citys));
    System.out.println(redisTemplate.opsForSet().remove("citySet",citys));
}

执行结果：

4.3 V pop(K key)

移除并返回集合中的一个随机元素。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void set3()
{
    String[] citys = new String[]{"北京","上海","广州","深圳"};
    System.out.println(redisTemplate.opsForSet().add("citySet",citys));
    System.out.println(redisTemplate.opsForSet().pop("citySet"));
    System.out.println(redisTemplate.opsForSet().members("citySet"));
}

执行结果：

4.4 Boolean move(K key, V value, K destKey)

将 member 元素移动。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void set4()
{
    String[] citys = new String[]{"北京","上海","广州","深圳"};
    System.out.println(redisTemplate.opsForSet().add("citySet",citys));
    System.out.println(redisTemplate.opsForSet().move("citySet","深圳","citySet2"));
    System.out.println(redisTemplate.opsForSet().members("citySet"));
    System.out.println(redisTemplate.opsForSet().members("citySet2"));
}

执行结果：

4.5 Cursor scan(K key, ScanOptions options)

用于遍历 Set。具体用法见以下代码：

@Autowired
private RedisTemplate redisTemplate;
 
@Test
public void set5()
{
    String[] citys = new String[]{"北京","上海","广州","深圳"};
    System.out.println(redisTemplate.opsForSet().add("citySet",citys));
    Cursor