Redis操作--RedisTemplate（一）介绍

news2024/11/24 6:57:27

一、介绍

1、简介

RedisTemplate 是 Spring Data Redis 提供的一个高级抽象，由 Spring 官方提供的方便操作 Redis 数据库的一个工具类，支持模板设计模式，使得操作 Redis 更加符合 Spring 的编程模型。还支持序列化机制，可以处理 Java 对象的存取。其本质属于 Spring-Data 模块下的 Spring-Data-Redis 部分，它提供了从 Spring 应用程序轻松配置和访问 Redis的功能。

2、原理

Spring-Data-Redis 是通过整合Lettuce和Jedis这俩种Redis客户端产生的，对外则提供了RedisTemplate这样统一的API来供调用者访问。它既支持Luttuce的响应式编程也支持JDK中集合的实现。

3、和Jedis的区别

Jedis 是一个用于直接与 Redis 服务器通信的 Java 客户端库，它提供了 Redis 所有基本功能的直接 API，需要手动管理连接（如创建 Jedis 实例和处理连接关闭等），并且需要在项目中引入 Jedis 的相关 Maven 依赖，Jedis 适合需要精细控制 Redis 操作的场景，直接提供 Redis 命令的操作方式；

RedisTemplate 更加适合与 Spring 框架集成的应用，提供了更高层次的抽象和便利的方法来简化 Redis 操作。

具体选用客户端还是模板，根据项目实际需要即可。

二、使用

1、引入依赖

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

        <!--连接池依赖-->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
            <version>2.11.1</version>
        </dependency>

2、配置连接

由于 RedisTemplate 是整合的Lettuce和Jedis，因此在配置连接池的时候需要进行选择是使用Lettuce还是Jedis（默认是Lettuce）

#Redis cache setting
spring.data.redis.host=127.0.0.1
spring.data.redis.port=6379
spring.data.redis.password=
#最大连接数
spring.data.redis.lettuce.pool.max-active=8
#等待时长
spring.data.redis.lettuce.pool.max-wait=-1
#最大空闲连接
spring.data.redis.lettuce.pool.max-idle=8
#最小空闲连接
spring.data.redis.lettuce.pool.min-idle=0
spring.data.redis.lettuce.pool.enabled=true
spring.data.redis.lettuce.pool.time-between-eviction-runs=30s

3、使用

通过依赖注入就可以直接使用

    @Autowired
    private RedisTemplate redisTemplate;
    
    @Test
    public void  testString(){
        String key = "name";
        //存
        String value = "这是value123";
        redisTemplate.opsForValue().set(key,value);
        //取
        Object valueObj = redisTemplate.opsForValue().get(key);
        System.out.println("value为：" + valueObj);
    }

执行打印：value为：这是value123

4、序列化

注意点：上面存入的数据打开Redis图形化工具查看发现是一堆乱码

这是因为Redis的序列化并没有按照我们预期的进行转化，我们需要自己去重写一个序列化，如下将key设置为String类型、value设置为json类型，最后将这个对象交给Spring管理，之后在调用该对象的时候就会自动选择我们配置的这个：

@Configuration
public class RedisConfig {
    
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
        //创建RedisTemplate对象
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        //设置连接工厂
        template.setConnectionFactory(connectionFactory);
        //创建JSON序列化工具
        GenericJackson2JsonRedisSerializer jsonSerializer = new GenericJackson2JsonRedisSerializer();
        //设置key的序列化
        template.setKeySerializer(RedisSerializer.string());
        template.setHashValueSerializer(RedisSerializer.string());
        //设置value的序列化
        template.setValueSerializer(jsonSerializer);
        template.setHashValueSerializer(jsonSerializer);
        return template;
    }
}

对于JSON序列化工具也需要引入依赖：

        <!--jackson依赖-->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.17.1</version>
        </dependency>

此时存储正常：

redis的序列化方式有：

@Configuration
@EnableConfigurationProperties(RedisProperties.class)
public class RedisConfig {

    @Resource private LettuceConnectionFactory factory;

    @Bean(name = "redisTemplateForRateLimit")
    public RedisTemplate<String, Object> redisTemplate() {
        Assert.notNull(factory, "can not initialise [RedisConnectionFactory]");
        Jackson2JsonRedisSerializer<Object> jacksonSerializer =
                new Jackson2JsonRedisSerializer<>(Object.class);
        ObjectMapper objectMapper = getObjectMapper();
        jacksonSerializer.setObjectMapper(objectMapper);

        RedisTemplate<String, Object> template = new RedisTemplate<>();
        StringRedisSerializer serializer = new StringRedisSerializer();
        template.setKeySerializer(serializer);
        template.setHashKeySerializer(serializer);

        template.setValueSerializer(jacksonSerializer);
        template.setHashValueSerializer(jacksonSerializer);
        template.setDefaultSerializer(jacksonSerializer);

        template.setConnectionFactory(factory);
        template.afterPropertiesSet();
        return template;
    }
}

三、API

RedisTemplate 提供了丰富的方法来实现对 Redis 的各种操作，包括但不限于字符串、哈希、列表、集合和有序集合等数据结构的操作。以下是一些常用的 RedisTemplate API：

1、字符串操作

opsForValue().set(key, value): 设置字符串值。
opsForValue().get(key): 获取字符串值。
opsForValue().incr(key): 字符串值自增。
opsForValue().decr(key): 字符串值自减。

2、哈希操作

opsForHash().getOperations().put(key, hashKey, value): 向哈希中添加键值对。
opsForHash().getOperations().get(key, hashKey): 获取哈希中的值。
opsForHash().getOperations().entries(key): 获取哈希中的所有键值对。

3、列表操作

opsForList().leftPush(key, value): 从列表左侧添加元素。
opsForList().rightPush(key, value): 从列表右侧添加元素。
opsForList().leftPop(key): 从列表左侧弹出元素。
opsForList().rightPop(key): 从列表右侧弹出元素。

4、集合操作

opsForSet().add(key, value): 向集合中添加元素。
opsForSet().members(key): 获取集合中的所有元素。
opsForSet().remove(key, value): 从集合中移除元素。

5、有序集合操作

opsForZSet().add(key, value, score): 向有序集合中添加元素，并指定分数。
opsForZSet().range(key, start, end): 获取有序集合中指定分数范围内的元素。
opsForZSet().removeRangeByScore(key, minScore, maxScore): 按分数范围移除有序集合中的元素。