Redis快取穿透/擊穿工具類的封裝

import lombok.Data;

import java.time.LocalDateTime;

@Data
public class RedisData {
    private LocalDateTime expireTime;
    private Object data;
}

import cn.hutool.core.util.BooleanUtil;
import cn.hutool.core.util.StrUtil;
import cn.hutool.json.JSONObject;
import cn.hutool.json.JSONUtil;
import com.hmdp.entity.Shop;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.time.LocalDateTime;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;

import static com.hmdp.utils.RedisConstants.*;

@Component
@Slf4j
public class CacheClient {

    @Resource
    private final StringRedisTemplate stringRedisTemplate;

    // 執行緒池物件
    private static final ExecutorService CACHE_REBUILD_EXECUTOR = Executors.newFixedThreadPool(10);

    /**
     * 注入StringRedisTemplate的構造方法
     * @param stringRedisTemplate
     */
    public CacheClient(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }

    /**
     * 在Redis中實現物理上新增資料和設定有效期
     * @param key : Redis 儲存的key的值
     * @param value : Redis 儲存的value的值
     * @param time : Redis 儲存的邏輯過期時間的值
     * @param unit :Redis 儲存的邏輯過期時間的單位
     */
    public void set(String key, Object value, Long time, TimeUnit unit) {
        stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(value), time, unit);
    }

    /**
     * 解決快取擊穿的Rides的邏輯儲存的方法
     * @param key : Redis 儲存的key的值
     * @param value : Redis 儲存的value的值
     * @param time : Redis 儲存的邏輯過期時間的值
     * @param unit :Redis 儲存的邏輯過期時間的單位
     */
    public void setWithLogicalExpire(String key, Object value, Long time, TimeUnit unit) {
        // 設定邏輯過期時間
        RedisData redisData = new RedisData();
        redisData.setData(value);
        redisData.setExpireTime(LocalDateTime.now().plusSeconds(unit.toSeconds(time)));
        // 寫入Redis
        stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(redisData));
    }

    /**
     *  解決快取穿透問題的Reids查詢方法
     * @param keyPrefix : key的字首
     * @param id : 查詢的id
     * @param type : 查詢資料的Class型別
     * @param dbFallback : 查詢資料庫的sql具體語句
     * @param time : 設定超時間
     * @param unit : 設定超時時間單位
     * @return : 返回一個 設定的 Class 型別物件
     * @param <R> 返回值型別引數泛型
     * @param <T> id型別引數泛型
     */
    public <R, T> R queryWithPassThrough(
            String keyPrefix, T id, Class<R> type, Function<T, R> dbFallback, Long time, TimeUnit unit) {
        String key = keyPrefix + id;
        // 1. 從 redis 查詢快取
        String json = stringRedisTemplate.opsForValue().get(key);
        // 2. 判斷是否存在
        if (StrUtil.isNotBlank(json)) {
            // 3. 存在，直接返回
            return JSONUtil.toBean(json, type);
        }
        // 判斷命中的是否是空值
        if (json != null) {
            // 返回錯誤資訊
            return null;
        }
        // 4. 不存在，根據id 查詢資料庫
        R r = dbFallback.apply(id);
        // 5. 不存在，返回錯誤
        if (r == null) {
            stringRedisTemplate.opsForValue().set(key, "", CACHE_NULL_TTL, TimeUnit.MINUTES);
            return null;
        }
        // 6. 寫入redis
        this.set(key, r, time, unit);
        // 7. 返回
        return r;
    }

    /**
     *  解決快取擊穿問題的Reids查詢方法
     * @param keyPrefix : key的字首
     * @param id : 查詢的id
     * @param type : 查詢資料的Class型別
     * @param dbFallback : 查詢資料庫的sql具體語句
     * @param time : 設定超時間
     * @param unit : 設定超時時間單位
     * @return : 返回一個 設定的 Class 型別物件
     * @param <R> 返回值型別引數泛型
     * @param <T> id型別引數泛型
     */
    public <R, T> R queryWithLogicalExpire(
            String keyPrefix, T id, Class<R> type, Function<T, R> dbFallback, Long time, TimeUnit unit) {

        String key = keyPrefix + id;
        // 1. 從 redis 查詢快取
        String json = stringRedisTemplate.opsForValue().get(key);
        // 2. 判斷是否存在
        if (StrUtil.isBlank(json)) {
            return null;
        }

        // 4. 命中需要判斷過期時間
        RedisData redisData = JSONUtil.toBean(json, RedisData.class);
        R r = JSONUtil.toBean((JSONObject) redisData.getData(), type);
        LocalDateTime expireTime = redisData.getExpireTime();
        // 5. 判斷是否過期
        if (expireTime.isAfter(LocalDateTime.now())) {
            // 5.1 未過期，直接返回店鋪資訊
            return r;
        }
        // 5.2 已過期，需要快取重建
        // 6. 緩衝重建
        // 6.1 獲取互斥鎖
        String lockKey = LOCK_SHOP_KEY + id;
        // 6.2 判斷是否獲取鎖成功
        boolean isLock = tryLock(lockKey);
        if (isLock) {
            // 6.3 成功 開啟獨立執行緒，實現快取重建
            CACHE_REBUILD_EXECUTOR.submit(() -> {
                try {
                    // 查詢資料庫
                    R r1 = dbFallback.apply(id);
                    // 寫入Redis
                    this.setWithLogicalExpire(key, r1, time, unit);
                } catch (Exception e) {
                    throw new RuntimeException(e);
                } finally {
                    // 釋放鎖
                    unlock(lockKey);
                }
            });
        }
        // 6.4 返回店鋪資訊
        return r;
    }

    /**
     *
     * @param key
     * @return
     */
    private boolean tryLock(String key) {
        Boolean flag = stringRedisTemplate.opsForValue().setIfAbsent(key, "1", 10, TimeUnit.SECONDS);
        return BooleanUtil.isTrue(flag);
    }

    /**
     * 釋放錯
     *
     * @param key
     */
    private void unlock(String key) {
        stringRedisTemplate.delete(key);
    }


}