跳转至

Redis的Java客户端

在Redis官网中提供了各种语言的客户端，地址：Get started using Redis clients | Redis

Redis的Java客户端：

image-20230416200843365

1.Jedis

Jedis 的官方地址：redis/jedis: Redis Java client designed for performance and ease of use. (github.com)

Jedis使用的基本步骤：

  1. 引入依赖
  2. 创建Jedis对象，建立连接
  3. 使用Jedis，方法名和Redis命令一致
  4. 释放资源

1.1快速入门

（1）创建maven项目

（2）引入依赖

<dependencies>
    <!--jedis-->
    <dependency>
        <groupId>redis.clients</groupId>
        <artifactId>jedis</artifactId>
        <version>4.3.0</version>
    </dependency>
    <!--单元测试-->
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter</artifactId>
        <version>5.9.2</version>
        <scope>test</scope>
    </dependency>
</dependencies>

（3）测试

package com.li.test;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import redis.clients.jedis.Jedis;

import java.util.Map;

/**
 * @author 李
 * @version 1.0
 */
public class JedisTest {
    private Jedis jedis;

    @BeforeEach
    public void setUp() {
        //建立连接
        jedis = new Jedis("192.168.1.2", 6379);
        //设置密码
        jedis.auth("123456");
        //选择库
        jedis.select(0);
    }

    @Test
    public void testString() {
        //存入数据
        String result = jedis.set("name", "大明");
        //获取数据
        System.out.println("result=" + result);
        String name = jedis.get("name");
        System.out.println("name=" + name);
    }

    @Test
    public void testHash() {
        //设置值
        jedis.hset("usr:1", "name", "jack");
        jedis.hset("usr:1", "age", "18");
        //获取值
        Map<String, String> map = jedis.hgetAll("usr:1");
        System.out.println(map);
    }

    @AfterEach
    public void tearDown() {
        if (jedis != null) {
            jedis.close();
        }
    }
}

testString()测试结果：

image-20230416211144329

testHash()测试结果：

image-20230416211124095

1.2Jedis连接池

Jedis本身是线程不安全的，并且频繁地创建和销毁连接会有性能损耗，因此推荐使用Jedis连接池代替Jedis直连。

工具类：JedisConnectFactory.java

package com.li.jedis.utils;

import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;

import java.time.Duration;

/**
 * @author 李
 * @version 1.0
 */
public class JedisConnectFactory {
    private static final JedisPool jedisPool;

    static {
        //配置连接池
        JedisPoolConfig jedisPoolConfig = new JedisPoolConfig();
        //最大连接
        jedisPoolConfig.setMaxTotal(8);
        //最大空闲连接
        jedisPoolConfig.setMaxIdle(8);
        //最小空闲连接
        jedisPoolConfig.setMinIdle(0);
        //最长等待时间
        jedisPoolConfig.setMaxWaitMillis(1000);
        //创建连接池对象
        jedisPool = new JedisPool(jedisPoolConfig,
                "192.168.1.3", 6379, 1000, "123456");

    }

    public static Jedis getJedis() {
        return jedisPool.getResource();
    }

}

创建了该工具类后，每次要获取Jedis对象，只需要调用该类的getJedis()方法即可。

2.SpringDataRedis

SpringData是Spring中数据操作的模块，包含对各种数据库的集成，其中对Redis的集成模块就叫做SpringDataRedis，官网地址：Spring Data Redis

  • 提供了对不同Redis客户端的整合（Lettuce和Jedis）
  • 提供了RedisTemplate统一API来操作Redis
  • 支持Redis的发布订阅模型
  • 支持Redis哨兵和Redis集群
  • 支持基于Lettuce的响应式编程
  • 支持基于JDK，JSON，字符串，Spring对象的数据序列化及反序列化
  • 支持基于Redis的JDKCollection实现

SpringDataRedis快速入门

SpringD ataRedis中提供了RedisTemplate工具类，其中封装了各种对Redis的操作，并且将不同数据类型的操作API封装到了不同的类型中：

image-20230417162646159

2.1快速入门

SpringDataRedis的使用步骤：

  1. 引入spring-boot-starter-data-redis依赖
  2. 在application.yml配置Redis信息
  3. 注入RedisTemplate，使用该对象的API

代码实现

SpringBoot默认整合了SpringDataRedis，并且做了自动装配，使用非常简单。

（1）创建springboot项目（2.5.3版本），引入依赖

<dependencies>
    <!--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>
    </dependency>
</dependencies>

（2）配置文件application.yml

spring:
  redis:
    host: 192.168.1.3
    port: 6379
    password: 123456
    database: 0
    lettuce: #spring 默认使用的是 lettuce，如果要使用jedis需要额外引入jedis的依赖
      pool:
        max-active: 8 #连接池最大连接数（使用负值表示没有限制）
        max-idle: 8 #连接池中的最大空闲连接
        min-idle: 0 #连接池中的最小空闲连接
        max-wait: 1000ms #连接池最大阻塞等待时间（使用负值表示没有限制）

（3）创建测试类，测试使用RedisTemplate的API

package com.li.spring_data_redis_demo;

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ValueOperations;

import javax.annotation.Resource;

@SpringBootTest
class SpringDataRedisDemoApplicationTests {
    @Resource
    private RedisTemplate redisTemplate;

    @Test
    void testString() {
        //操作字符串，使用opsForValue
        ValueOperations valueOperations = redisTemplate.opsForValue();

        //1.插入String数据
        //注意这里的set方法可以放入一个Object对象，这是因为底层会自动序列化
        valueOperations.set("name", "故宫博物院");

        //2.获取String数据
        Object name = valueOperations.get("name");
        System.out.println("name=" + name);
    }
}

测试结果：

image-20230417165902824

3.RedisTemplate序列化&反序列化

Redis之RedisTemplate配置方式(序列和反序列化)

3.1序列化

我们上面说过，RedisTemplate.opsForValue().set()方法可以接收一个Object对象，底层会自动将其转成一个redis可以处理的字节数组。

其实RedisTemplate底层的处理方式，是利用jdk的序列化工具—JdkSerializationRedisSerializer，对其进行序列化。但是由 JdkSerializationRedisSerializer 序列化后的字符串如下所示：

image-20230417171751460

这种序列化的缺点是：

  1. 可读性差
  2. 内存占用较大

要解决这些问题，就要去改变RedisTemplate的序列化方式：Redis针对数据的“序列化和反序列化”，提供了多种策略(RedisSerializer)：

  1. （默认）JdkSerializationRedisSerializer
  2. StringRedisSerializer
  3. JacksonJsonRedisSerializer
  4. OxmSerializer
  5. GenericFastJsonRedisSerializer

image-20230417173430350

代码实现

（1）在配置类中，自定义RedisTemplate的序列化方式：

package com.li.spring_data_redis_demo.config;

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.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializer;

/**
 * @author 李
 * @version 1.0
 */
@Configuration
public class RedisConfig {
    @Bean
    public RedisTemplate<String, Object> redisTemplate
            (RedisConnectionFactory redisConnectionFactory) {
        //创建RedisTemplate对象
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();

        //设置连接工厂
        redisTemplate.setConnectionFactory(redisConnectionFactory);

        //创建json序列换工具
        GenericJackson2JsonRedisSerializer jsonRedisSerializer =
                new GenericJackson2JsonRedisSerializer();

        //设置Redis-String、Hash类型的key序列化
        redisTemplate.setKeySerializer(RedisSerializer.string());

        //设置Redis-String类型的value序列化
        redisTemplate.setValueSerializer(jsonRedisSerializer);
        //设置Redis-Hash类型的value序列化
        redisTemplate.setHashValueSerializer(jsonRedisSerializer);

        //初始化RedisTemplate的一些参数设置
        //redisTemplate.afterPropertiesSet();

        //返回
        return redisTemplate;
    }
}

1.方法名不可以随便改，就叫redisTemplate，要不然配置不生效

2.RedisConnectionFactory 在spring 容器里已经创建好了，不需要手动创建

（2）引入jackson依赖

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

（3）创建User作为测试对象

package com.li.spring_data_redis_demo.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author 李
 * @version 1.0
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private String name;
    private Integer age;
}

（4）测试代码：

package com.li.spring_data_redis_demo;

import com.li.spring_data_redis_demo.entity.User;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.redis.core.RedisTemplate;

import javax.annotation.Resource;

@SpringBootTest
class SpringDataRedisDemoApplicationTests {
    @Resource
    private RedisTemplate redisTemplate;

    @Test
    void testSaveUser() {
        //插入数据
        redisTemplate.opsForValue().set("user:100", new User("孙悟空", 999));
        //获取数据
        Object user = redisTemplate.opsForValue().get("user:100");
        System.out.println("user=" + user);
    }
}

运行代码，显示成功插入：

image-20230417183446161

在可视化软件中也可以显示了：

image-20230417183813538

3.2反序列化

可以看到在写入数据的时候，同时也写入了User类的字节码名称，正是因为这个名称，才能够读取到类的字节码进行反序列化（其实就是反射对象）。

但是，并不是所有的数据都需要反序列化，为了节省空间，我们并不会使用JSON序列化器来处理value，而是统一使用String序列化器，要求只能存储String类型的key和value（不存储字节码名称）。当需要存储Java对象的时候，手动完成对象的序列化和反序列化。

image-20230417184956621

这意味着我们要重新修改RedisTemplate的配置，修改序列化方式。

但幸运的是，Spring默认提供了一个StringRedisTemplate类，它的key和value的序列化方式默认就是String方式，节省了我们自定义RedisTemplate的过程。

代码实现

package com.li.spring_data_redis_demo;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.li.spring_data_redis_demo.entity.User;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.redis.core.StringRedisTemplate;

import javax.annotation.Resource;
import java.util.Map;

/**
 * @author 李
 * @version 1.0
 */
@SpringBootTest
public class RedisStringTests {
    @Resource
    private StringRedisTemplate stringRedisTemplate;

    @Test
    public void testString() {
        stringRedisTemplate.opsForValue().set("address", "纽约第一人民医院");
        String address = stringRedisTemplate.opsForValue().get("address");
        System.out.println("address=" + address);
    }

    private static final ObjectMapper mapper = new ObjectMapper();

    @Test
    public void testSaveUser() throws JsonProcessingException {
        //创建对象
        User user = new User("jack", 25);

        //手动序列化
        String json = mapper.writeValueAsString(user);
        //写入数据
        stringRedisTemplate.opsForValue().set("user:200", json);

        //获取数据
        String jsonUser = stringRedisTemplate.opsForValue().get("user:200");
        //手动反序列化
        User user1 = mapper.readValue(jsonUser, User.class);
        System.out.println("user=" + user1);
    }

    @Test
    public void testHash() {
        //三个参数分别对应 key field value
        stringRedisTemplate.opsForHash().put("user:400", "name", "杰克");
        stringRedisTemplate.opsForHash().put("user:400", "age", "46");

        Map<Object, Object> entries =
                stringRedisTemplate.opsForHash().entries("user:400");
        System.out.println("entries=" + entries);
    }
}

testString()测试结果：

image-20230417190044734

image-20230417191722927

testSaveUser()测试结果：

image-20230417191634317

image-20230417191150493

testHash()测试结果：

image-20230417195517005

image-20230417195548758

对比之前需要存储字节码数据的方式，这种手动序列化的方式节省了很多空间，推荐使用。

3.3RedisTemplate的两种序列化方案

方案一：自定义RedisTemplate，修改RedisTemplate的序列化器为GenericJackson2JsonRedisSerializer

方案二：使用StringRedisTemplate，写入Redis时，手动把对象序列化为JSON；读取Redis时，手动把读取到的JSON反序列化为Java对象