day03-Redis的客戶端

Redis的Java客戶端

在Redis官網中提供了各種語言的客戶端，地址：Get started using Redis clients | Redis

Redis的Java客戶端：

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()測試結果：

testHash()測試結果：

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封裝到了不同的型別中：

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);
    }
}

測試結果：

3.RedisTemplate序列化&反序列化

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

3.1序列化

我們上面說過，RedisTemplate.opsForValue().set()方法可以接收一個Object物件，底層會自動將其轉成一個redis可以處理的位元組陣列。

其實RedisTemplate底層的處理方式，是利用jdk的序列化工具—JdkSerializationRedisSerializer，對其進行序列化。但是由 JdkSerializationRedisSerializer 序列化後的字串如下所示：

這種序列化的缺點是：

1. 可讀性差
2. 記憶體佔用較大

要解決這些問題，就要去改變RedisTemplate的序列化方式：Redis針對資料的“序列化和反序列化”，提供了多種策略(RedisSerializer)：

1. （預設）JdkSerializationRedisSerializer
2. StringRedisSerializer
3. JacksonJsonRedisSerializer
4. OxmSerializer
5. GenericFastJsonRedisSerializer

程式碼實現

（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);
    }
}

執行程式碼，顯示成功插入：

在視覺化軟體中也可以顯示了：

3.2反序列化

可以看到在寫入資料的時候，同時也寫入了User類的位元組碼名稱，正是因為這個名稱，才能夠讀取到類的位元組碼進行反序列化（其實就是反射物件）。

但是，並不是所有的資料都需要反序列化，為了節省空間，我們並不會使用JSON序列化器來處理value，而是統一使用String序列化器，要求只能儲存String型別的key和value（不儲存位元組碼名稱）。當需要儲存Java物件的時候，手動完成物件的序列化和反序列化。

這意味著我們要重新修改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()測試結果：

testSaveUser()測試結果：

testHash()測試結果：

對比之前需要儲存位元組碼資料的方式，這種手動序列化的方式節省了很多空間，推薦使用。

3.3RedisTemplate的兩種序列化方案

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

方案二：使用StringRedisTemplate，寫入Redis時，手動把物件序列化為JSON；讀取Redis時，手動把讀取到的JSON反序列化為Java物件