SpringBoot3中引入Redis並封裝常用的 RedisUtils 工具類-程式設計技術-CodeUp Hub

最近在做 Spring Boot 專案，藉此機會，我使用了 Spring Boot 3 和 JDK 17 的組合，整理了一下 Redis 的配置方式，並透過實踐實現了常用的 Redis 工具類。我這裏主要是整理一下如何在 Spring Boot 3 中使用 Redis，以及如何自定義工具類實現常見的 Redis 操作。

Spring Boot 3.x 和 JDK 17 相容，特別是在 Spring Boot 3 中引入了 Jakarta EE 9 的名稱空間（如包名從 javax 改為 jakarta），因此在使用一些依賴時需要注意相容性問題。

1、引入依賴

首先，我們要確保專案中已經引入了 Redis 相關的依賴。spring-boot-starter-data-redis 是使用 Redis 的核心依賴，它包含了 RedisTemplate 等必要的類。

在 pom.xml 檔案中（如果使用 Maven），確保包含以下依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

如果使用 Gradle，確保 build.gradle 中有以下依賴：

implementation 'org.springframework.boot:spring-boot-starter-data-redis'

2、application的配置

在 application.yml 檔案中新增 Redis 相關的配置，這裏有一點需要注意。Springboot2 中的配置是spring.redis，Springboot3 中的配置是spring.data.redis。

參考配置如下所示：

spring:
  data:
    redis:
      host: 127.0.0.1
      port: 6379
      database: 0
      timeout: 1800s # 使用時間格式化
      password:
      lettuce:
        pool:
          max-active: 20  # 最大連線數
          max-wait: -1    # 最大阻塞等待時間(負數表示沒限制)
          max-idle: 5     # 最大空閒
          min-idle: 0     # 最小空閒

關鍵引數說明：

host：Redis 伺服器的主機地址。
port：Redis 伺服器的埠。
database：使用的資料庫索引。
timeout：連線超時時間。
lettuce.pool：Lettuce 連線池配置，控制 Redis 連線的併發數、空閒連線數等。

3、自定義某些配置

爲了定製化 Redis 的使用方式，我們可以建立一個 RedisConfig 配置類，自定義 RedisTemplate 和 RedisCacheManager，以便對 Redis 的鍵值進行序列化和快取管理。這裏定義物件序列化的方式，可以直接往Reids中存放物件，它實現自動轉換。

@Configuration
@EnableCaching
public class RedisConfig {

    // 配置 RedisTemplate，用於操作 Redis 資料庫
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        // 建立 RedisTemplate 物件，用於執行 Redis 操作
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        // 設定連線工廠，用於與 Redis 建立連線
        redisTemplate.setConnectionFactory(factory);
        
        // 設定 key 的序列化器，使用 StringRedisSerializer 將 key 序列化為字串
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        // 設定 value 的序列化器，使用 GenericJackson2JsonRedisSerializer 將物件序列化為 JSON
        redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        
        // 設定 hash key 的序列化器，使用 StringRedisSerializer 序列化 hash 的 key
        redisTemplate.setHashKeySerializer(new StringRedisSerializer());
        // 設定 hash value 的序列化器，使用 Jackson2JsonRedisSerializer 將 hash 值序列化為 JSON
        redisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<Object>(Object.class));

        // 返回配置好的 RedisTemplate
        return redisTemplate;
    }

    // 配置 RedisCacheManager，用於管理 Redis 快取
    @Bean
    public RedisCacheManager redisCacheManager(RedisTemplate redisTemplate) {
        // 建立 RedisCacheWriter，nonLockingRedisCacheWriter 表示不使用鎖機制進行快取操作
        RedisCacheWriter redisCacheWriter = RedisCacheWriter.nonLockingRedisCacheWriter(redisTemplate.getConnectionFactory());
        
        // 配置 RedisCacheConfiguration，指定快取值的序列化方式，使用 RedisTemplate 中配置的 ValueSerializer 進行序列化
        RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(redisTemplate.getValueSerializer()));
        
        // 返回配置好的 RedisCacheManager
        return new RedisCacheManager(redisCacheWriter, redisCacheConfiguration);
    }
}

@Configuration 註解：用於標記這是一個配置類，Spring 會在應用啟動時載入該類中的配置，生成相關的 Bean 並將其管理。用於自定義 Redis 相關的 Bean。
@EnableCaching 註解：啟用 Spring 的快取支援。透過這個註解，Spring 將使用快取機制，並根據配置的快取管理器管理快取。
RedisTemplate：用於執行 Redis 操作。自定義了鍵（key）使用字串序列化，值（value）使用 JSON 序列化。
RedisCacheManager：管理快取配置。快取的值也透過 JSON 序列化儲存，便於處理複雜資料。

4、自定義工具類

爲了簡化 Redis 的常用操作（如增刪改查），我們可以建立一個 RedisUtil 工具類，便於在專案中使用。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;

import java.util.Arrays;
import java.util.concurrent.TimeUnit;

/**
 * Redis工具類
 *
 * @author luoxiaodou
 */
@Component
public class RedisUtil {

    private static final Logger logger = LoggerFactory.getLogger(RedisUtil.class);

    private final RedisTemplate<String, Object> redisTemplate;

    /**
     * 在 Spring Boot 中，RedisTemplate 是由 Spring 自動配置的。
     * Spring Boot 的 spring-boot-starter-data-redis 會自動根據 application.yml
     * 或 application.properties 中的 Redis 配置生成
     * RedisTemplate 例項，並將其作為一個 Bean 注入到 Spring 容器中。
     *
     * 從 Spring Framework 4.3 開始，如果類只有一個建構函式，Spring 會自動推斷並使用這個建構函式進行依賴注入，無需顯式地使用 @Autowired 註解。
     * 由於 RedisUtil 類中只有一個建構函式，因此 Spring 自動會將 RedisTemplate<String, Object> 注入到 RedisUtil 中。
     *
     * @param redisTemplate
     */
    @Autowired
    public RedisUtil(RedisTemplate<String, Object> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    /**
     * 設定快取失效時間
     *
     * @param key 鍵
     * @param time 時間(秒)
     */
    public boolean expire(String key, long time) {
        if (time > 0) {
            return Boolean.TRUE.equals(redisTemplate.expire(key, time, TimeUnit.SECONDS));
        }
        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) {
        return Boolean.TRUE.equals(redisTemplate.hasKey(key));
    }

    /**
     * 刪除快取
     *
     * @param key 可以傳一個值 或多個
     */
    public void delete(String... key) {
        if (key != null && key.length > 0) {
            if (key.length == 1) {
                redisTemplate.delete(key[0]);
            } else {
                redisTemplate.delete(Arrays.asList(key));
            }
        }
    }

    /**
     * 獲取普通快取
     *
     * @param key 鍵
     * @return 值
     */
    public Object get(String key) {
        return key == null ? null : redisTemplate.opsForValue()
            .get(key);
    }

    /**
     * 泛型方法 get：<T> 使得 get 方法可以返回不同型別的物件，clazz 引數是物件的型別資訊，傳入後可以將儲存的值反序列化為相應型別。
     * Redis 中的資料必須是透過 GenericJackson2JsonRedisSerializer 或類似的 JSON 序列化器儲存的，確保可以成功反序列化。
     *
     * @param key
     * @param clazz
     * @param <T>
     * @return
     */
    public <T> T get(String key, Class<T> clazz) {
        try {
            Object value = redisTemplate.opsForValue()
                .get(key);
            if (value != null) {
                // 自動轉換成指定型別
                return clazz.cast(value);
            }
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return null;
    }

    /**
     * 普通快取放入
     *
     * @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) {
            logger.error(e.getMessage(), e);
            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) {
            logger.error(e.getMessage(), e);
            return false;
        }
    }
}

關鍵方法說明：

expire：設定快取的過期時間。
getExpire：獲取快取項的過期時間。
hasKey：判斷快取是否存在。
delete：刪除快取。
get：獲取快取中的值。
set：設定快取值，可選指定過期時間。

SpringBoot3中引入Redis並封裝常用的 RedisUtils 工具類

1、引入依賴

2、application的配置

關鍵引數說明：

3、自定義某些配置

4、自定義工具類

相關推薦

詳細介紹 WebSock...

Redis 事務：支援回...

RabbitMQ之經典佇...

全面透視HTTPS：深入...

區塊鏈中的時間鎖（Tim...

Swift 實現查詢連結...

0則評論