SpringBoot整合Redis

最新推荐文章于 2024-04-09 21:36:28 发布

馒头_0301

最新推荐文章于 2024-04-09 21:36:28 发布

阅读量283

点赞数

文章标签： spring boot redis java

本文链接：https://blog.csdn.net/m0_67924868/article/details/132390026

版权

文章目录

SpringBoot整合Redis及常用命令介绍

SpringBoot整合Redis及常用命令介绍

SpringBoot整合Redis

1，创建SpringBoot项目

首先创建一个SpringBoot项目，这里相信大家已经不是小白了就不演示创建SpringBoot项目的过程了

2，添加相关依赖

主要依赖

<!-- 集成redis依赖  -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

整体依赖为：

 <dependencies>
        <!--Redis依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <!--生成配置的元数据信息-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 开发热启动 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

3，添加配置信息yml

spring:
  redis:
    host: 127.0.0.1
    port: 6379

然而我们一般使用都会重写其配置类，默认的redisTemplate没有过多的配置，因为我们常常使用的redis通常都是要序列化的，所以我们常常编写自己的RedisTemplate 而大多固定因此可直接复制粘贴

package com.xxxx.config;


import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

@Configuration
public class RedisConfig {

    /*
     *默认的redisTemplate没有过多的配置，因为我们常常使用的redis通常都是要序列化的
     * 默认的两个泛型<Object，Object>，我们常常使用的是<string，object>需要强制类型转换
     * 由于String是我们常常使用的类型，所以有一个单独的bean
     * 因此我们可以编写自己的RedisTemplate
     * */


    //这里一个固定模板

    @Bean
    //抑制警告 虽然没有写错但看着书写下红色警告线很不舒服
    @SuppressWarnings("all")
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        //我们在开发中为了方便使用<String, Object>
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        // 连接工厂
        redisTemplate.setConnectionFactory(redisConnectionFactory);

        // Json序列化配置
        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);

        // String序列化配置
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();

        // key采用String的序列化方式
        redisTemplate.setKeySerializer(stringRedisSerializer);
        // hash的key也采用String的序列化方式
        redisTemplate.setHashKeySerializer(stringRedisSerializer);
        // value序列化方式采用jackson
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
        // hash的value序列化方式采用jackson
        redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer);
        redisTemplate.afterPropertiesSet();

        return redisTemplate;
    }
}

测试连接

@SpringBootTest
class Springboot04RedisApplicationTests {

    @Resource
    private RedisTemplate redisTemplate;

    @Test
    void contextLoads() {
        //RedisTemplate    操作不同的类型api 和我们的指令是一样的
        //opsForValue    操作字符串  类似于string
        //opsForList     操作List  类似于List
        // ........
//        redisTemplate.opsForList()
//        除了基本的操作,我们常用的方法都可以直接通过RedisTemplate来操作,比如事务,和基本的CRUD
        //获取redis连接对象
        //真实开发中一般使用Json字符串来传递对象或数据
       /* RedisConnection connection = redisTemplate.getConnectionFactory().getConnection();
        connection.flushDb();
        connection.flushAll();*/
       redisTemplate.opsForValue().set("hua","阿华");
        System.out.println(redisTemplate.opsForValue().get("hua"));

    }

}

注意：在使用redis之前一定要将redis服务器打开否则测试不成功

封装工具类

这些功能都在这个redisTemplate类中，使用起来其实并不是很方便，所有一般情况下，我们都是单独封装一个工具类，来把常用的一些方法进行抽象。操作的时候，直接通过工具类来操作。

package com.xxxx.utils;

import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;

import javax.annotation.Resource;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;

@Component
public final class RedisUtil {

    @Resource
    private RedisTemplate<String, Object> redisTemplate;

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

    /**
     * 指定缓存失效时间
     *
     * @param key  键
     * @param time 时间(秒)
     */
    public boolean expire(String key, long time, TimeUnit timeUnit) {
        try {
            if (time > 0) {
                redisTemplate.expire(key, time, timeUnit);
            }
            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, TimeUnit timeUnit) {
        try {
            redisTemplate.opsForHash().putAll(key, map);
            if (time > 0) {
                expire(key, time, timeUnit);
            }
            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, TimeUnit timeUnit) {
        try {
            redisTemplate.opsForHash().put(key, item, value);
            if (time > 0) {
                expire(key, time, timeUnit);
            }
            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, TimeUnit timeUnit, Object... values) {
        try {
            Long count = redisTemplate.opsForSet().add(key, values);
            if (time > 0) {
                expire(key, time, timeUnit);
            }
            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,TimeUnit timeUnit) {
        try {
            redisTemplate.opsForList().rightPush(key, value);
            if (time > 0) {
                expire(key, time,timeUnit);
            }
            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,TimeUnit timeUnit) {
        try {
            redisTemplate.opsForList().rightPushAll(key, value);
            if (time > 0) {
                expire(key, time,timeUnit);
            }
            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;
        }

    }

    // ===============================HyperLogLog=================================

    public long pfadd(String key, String value) {
        return redisTemplate.opsForHyperLogLog().add(key, value);
    }

    public long pfcount(String key) {
        return redisTemplate.opsForHyperLogLog().size(key);
    }

    public void pfremove(String key) {
        redisTemplate.opsForHyperLogLog().delete(key);
    }

    public void pfmerge(String key1, String key2) {
        redisTemplate.opsForHyperLogLog().union(key1, key2);
    }


}

Redis集成后RedisTemplate类中常用命令

redis的常用四大数据结构

数据类型	说明
String	字符串
List	列表类型，可以从左或右往里设置值
Hash	键值对类型
Set	无序不可重集合类型，类似List，但是拥有交集、并集、差集运算

String类型

//生成一个String类型的操作对象，这个对象拥有可以操作String类型的方法
redisTemplate.opsForValue();

例如：

//生成一个String类型的操作对象，同时绑定一个key值  这个对象是专门操作指定key值的对象。
BoundValueOperations boundValueOperations = redisTemplate.boundValueOps("key");
//获取指定key的值
redisTemplate.opsForValue().get(key);
//向指定key值中的value拼接字符串，如果key不存在则创建这个key，并将value设置进去
redisTemplate.opsForValue().append(key,value);
//向指定key中设置value
redisTemplate.opsForValue().set(key,value);

List类型

//生成一个List类型的操作对象，这个对象拥有可以操作List类型的方法
redisTemplate.opsForList();

例如：

//生成一个List类型的操作对象，同时绑定一个key值。这个对象是专门操作指定key值的对象
BoundListOperations boundListOperations = redisTemplate.boundListOps(key);
//从左往指定key集合中设置value
redisTemplate.opsForList().leftPush(key,value);
//从右往指定key集合中设置value
redisTemplate.opsForList().rightPush(key,value);
//弹出指定key值集合左侧的一个元素
redisTemplate.opsForList().leftPop(key);
//更新指定key值集合中指定下标的value
redisTemplate.opsForList().set(key,index,value);
//获取指定key值集合中指定下标的value
redisTemplate.opsForList().index(key,index);
//获取指定key值集合中从指定下标开始到指定下标结束的所有元素的集合，
redisTemplate.opsForList().range(key,begin,end);
//将List列表进行剪裁
redisTemplate.opsForList().trim(key, start, end);

Hash类型

redisTemplate.opsForHash()

例如：

//定key值Hash中设置一个键值对，键为hashKey，值为value
redisTemplate.opsForHash().put(key,hashKey,value);
//指定key值Hash中指定hashKey对应的值
redisTemplate.opsForHash().get(key,hashKey);
//指定key值hash所有键值对的hashKey集合
redisTemplate.opsForHash().keys(key);
//指定key值Hash中指定HashKey的键值对
redisTemplate.opsForHash().delete(key,hashKey1,hashKey2···)
//指定key值Hash中指定HashKey的键值对是否存在
redisTemplate.opsForHash().hasKey(key,hashKey);
//指定key值Hash中所有的键值对
redisTemplate.opsForHash().entries(key);
//指定key值Hash中所有的键值对中的所有值
redisTemplate.opsForHash().values(key);
//将map中的键值对放入指定key值Hash中
redisTemplate.opsForHash().putAll(key,map);

Set类型

redisTemplate.opsForSet()

例如：

//向指定key值的集合中放入value
redisTemplate.opsForSet().add(key,value);
//删除指定key值集合中的value
redisTemplate.opsForSet().remove(key,value,value1···);
//获取指定key值集合中的所有value
redisTemplate.opsForSet().members(key);
//获取指定key值集合的元素个数
redisTemplate.opsForSet().size(key); 
//获取指定key值集合的一个随机元素
redisTemplate.opsForSet().randomMember(key);  
//获取指定key值集合的count个随机元素
redisTemplate.opsForSet().randomMembers(key,count);  
//判断指定key值集合中指定元素是否存在
redisTemplate.opsForSet().isMember(key,value);  
//弹出指定key集合中的栈顶元素
redisTemplate.opsForSet().pop(key);
//计算指定两个key值集合的差值
redisTemplate.opsForSet().difference(key,otherKey);  
//计算指定key值与集合的插值
redisTemplate.opsForSet().difference(key,list);  
//计算指定key值集合和otherKey值集合的差集，并将求出的元素放入destKey键值集合中
redisTemplate.opsForSet().differenceAndStore(key,otherKey,destKey);  
//计算指定key值集合和指定集合的差集，并将求出的元素放入destKey键值集合中
redisTemplate.opsForSet().differenceAndStore(key,list,destKey);  
//计算指定key值集合和指定otherKey值集合的交集
redisTemplate.opsForSet().intersect(key,otherKey);
//计算指定key值集合和指定集合的交集
redisTemplate.opsForSet().intersect(key,list);
//计算指定key值集合和指定otherKey值集合的交集，并将结果存放在destKey值集合中
redisTemplate.opsForSet().intersectAndStore(key,otherKey,destKey);
//计算指定key值集合和指定集合的交集，并将结果存放在destKey值集合中
redisTemplate.opsForSet().intersectAndStore(key,list,destKey);
//计算指定key值集合和指定atherKey值集合的合集
redisTemplate.opsForSet().union(key,atherKey);
//计算指定key值集合和指定list集合的合集
redisTemplate.opsForSet().union(key,list);
//计算指定key值集合和指定otherKey值集合的合集，并将结果放入destKey值集合中
redisTemplate.opsForSet().unionAndStore(key,otherKey,destKey);
//计算指定key值集合和指定list集合的合集，并将结果放入destKey值集合中
redisTemplate.opsForSet().unionAndStore(key,list,destKey);
//计算指定key值集合和指定集合的差集，并将求出的元素放入destKey键值集合中
redisTemplate.opsForSet().differenceAndStore(key,list,destKey);  
//计算指定key值集合和指定集合的差集，并将求出的元素放入destKey键值集合中
redisTemplate.opsForSet().differenceAndStore(key,list,destKey);