# Redis 的 Java 客户端

Redis 的客户端可以在 Redis 官网找到,推荐的客户端包括:

  • Jedis:以 Redis 命令作为方法名称,学习成本低,简单实用。但是 Jedis 实例是线程不安全的,多线程环境下需要基于连接池来使用
  • Lettuce:Lettuce 是基于 Netty 实现的,支持同步、异步和响应式编程方式,并且是线程安全的。支持 Redis 的哨兵模式、集群模式和管道模式
  • Redisson:是在 Redis 基础上实现了分布式的可伸缩的 java 数据结构,例如 Map、Queue 等,而且支持跨进程的同步机制:Lock、Semaphore 等待,比较适合用来实现特殊的功能需求

# Jedis

Jedis 官网

# Jedis 快速入门

# 导入依赖

<!--jedis-->
<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>4.3.1</version>
</dependency>
<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter</artifactId>
    <version>5.9.2</version>
    <scope>test</scope>
</dependency>

# 建立连接

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

# 测试

@Test
void testString() {
    // 存入
    String result = jedis.set("name", "Snow San");
    System.out.println("result = " + result);
    // 获取
    String name = jedis.get("name");
    System.out.println("name = " + name);
}
@Test
void testHash() {
    // 插入
    jedis.hset("user:1", "name", "Snow San");
    jedis.hset("user:1", "age", "18");
    // 获取
    Map<String, String> map = jedis.hgetAll("user:1");
    System.out.println(map);
}

# 释放资源

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

# Jedis 连接池

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

import redis.clients.jedis.*;
public class JedisConnectionFactory {
    private static JedisPool jedisPool;
    static {
        // 配置连接池
        JedisPoolConfig poolConfig = new JedisPoolConfig();
        poolConfig.setMaxTotal(8);
        poolConfig.setMaxIdle(8);
        poolConfig.setMinIdle(0);
        poolConfig.setMaxWaitMillis(1000);
        // 创建连接池对象,参数:连接池配置、服务端 ip、服务端端口、超时时间、密码
        jedisPool = new JedisPool(poolConfig, 
                                  "127.0.0.1", 
                                  6379, 
                                  1000, 
                                  "");// 密码在此(
    }
    public static Jedis getJedis(){
        return jedisPool.getResource();
    }
}

# SpringDataRedis 客户端

接下来就是本次的主角啦!

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

ta 的特点如下:

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

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

# SpringDataRedis 快速入门

# 新建一个 boot 项目

别说你连 boot 项目都不会建

# 引入依赖

要引入 spring-boot-starter-data-redis , commons-pool2jackson-databind ,不过貌似 MVC 已经整合了 jackson

懒的话整个 lombok

<!--redis 依赖 -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!--common-pool-->
<dependency>
	<groupId>org.apache.commons</groupId>
	<artifactId>commons-pool2</artifactId>
</dependency>
<!--Jackson 依赖 -->
<dependency>
	<groupId>com.fasterxml.jackson.core</groupId>
	<artifactId>jackson-databind</artifactId>
</dependency>

# 配置 Redis

说到 boot 果然就是 yaml 呢~~(笑)~~

spring:
  data:
    redis:
      host: 0.0.0.0
      port: 6379
      lettuce:
        pool:
          max-active: 8
          max-idle: 8
          min-idle: 0
          max-wait: 1000ms

# 注入 RedisTemplate

@Autowired
private RedisTemplate redisTemplate;

# 测试!

@Test
void testString() {
    // 写入
    redisTemplate.opsForValue().set("name", "Snow San");
    // 获取
    Object name = stringRedisTemplate.opsForValue().get("name");
    System.out.println("name = " + name);
}

# 自定义序列化~~(白雪)~~

RedisTemplate 可以接收任意 Object 作为值写入 Redis, 但在写入前会把 Object 序列化为字节形式,默认是采用 JDK 序列化,缺点是:

  • 可读性差
  • 内存占用较大

因此可以自定义 RedisTemplate 的序列化方式,采用 JSON 序列化来代替默认的 JDK 序列化方式

@Configuration
public class RedisConfig {
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory){
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(connectionFactory);
        // 创建 JSON 序列化工具
        GenericJackson2JsonRedisSerializer jsonRedisSerializer = 
            new GenericJackson2JsonRedisSerializer();
        // 设置 Key 的序列化
        template.setKeySerializer(RedisSerializer.string());
        template.setHashKeySerializer(RedisSerializer.string());
        // 设置 Value 的序列化
        template.setValueSerializer(jsonRedisSerializer);
        template.setHashValueSerializer(jsonRedisSerializer);
        // 返回
        return template;
    }
}

JSON 序列化在查询时还能自动把 JSON 反序列化为 Java 对象,注意 @class 字段,ta 会带来额外的内存开销

# StringRedisTemplate

为了节省内存空间,我们可以不使用 JSON 序列化器来处理 value,而是统一使用 String 序列化器,要求只能存储 String 类型的 key 和 value。

不过当需要存储 Java 对象时,必须手动完成对象的序列化和反序列化

@Autowired
    private StringRedisTemplate stringRedisTemplate;
    @Test
    void testString() {
        // 写入
        stringRedisTemplate.opsForValue().set("verify:phone:11111111", "123456");
        // 获取
        Object name = stringRedisTemplate.opsForValue().get("name");
        System.out.println("name = " + name);
    }
    private static final ObjectMapper mapper = new ObjectMapper();
    @Test
    void testSaveUser() throws JsonProcessingException {
        // 创建对象
        User user = new User("Snow", 18);
        // 手动序列化
        String json = mapper.writeValueAsString(user);
        // 写入
        stringRedisTemplate.opsForValue().set("user:1", json);
        // 获取
        String jsonUser = stringRedisTemplate.opsForValue().get("user:1");
        // 手动反序列化
        User user1 = mapper.readValue(jsonUser, User.class);
        System.out.println("user1 = " + user1);
    }